Skip to content

readme_dev.md

Latest commit

 

History

History
52 lines (28 loc) · 2.16 KB

readme_dev.md

File metadata and controls

52 lines (28 loc) · 2.16 KB

Core Bolt UXP Dev Guide

Monorepo Overview

Purpose of bolt-uxp

The bolt-uxp package is both the root folder of the monorepo and an npm package in itself to be used by the create-bolt-uxp package.

Purpose of create-bolt-uxp

The create-bolt-uxp package is a CLI tool that is used to create a new project from the bolt-uxp template.

Purpose of vite-uxp-plugin

The vite-uxp-plugin package is a Vite plugin that brings all the features needed for building UXP Plugins with Bolt UXP.

Dev Quickstart

If you'd like to develop the core templates of Bolt UXP in order to contribute by submitting a PR, you can do so by following these steps:

  • Clone the repo
  • Run yarn to install dependencies
  • Run yarn dev to start the dev server

To test the different frameworks (React, Vue, Svelte), enable the corresponding <script /> tag in index.html and disable the others.

How Templating Works

Root directory is in the main bolt-uxp folder.

package.framework.jsonc for the framework is copied and renamed to package.json in the root directory (e.g. package.react.json)

File includes and excludes for each template can be found in create-bolt-uxp/src/index.ts

All code sections:

  • between: // BOLT_VARIABLE_START and // BOLT_VARIABLE_END or <!-- BOLT_VARIABLE_START --> and <!-- BOLT_VARIABLE_END --> or {/* BOLT_VARIABLE_START */} and {/* BOLT_VARIABLE_END */}
  • before: // BOLT_VARIABLE_ONLY

Are removed if the variable doesn't match the framework (e.g. React, Vue, Svelte), app (e.g. PhotoShop, InDesign, etc.), or feature (e.g. Hybrid) selected.

Note: Swap VARIABLE with the variable name (e.g. // BOLT_REACT_ONLY, // BOLT_PHXS_ONLY, etc.)

For more info on how templating works, refer to the Meta Bolt respository: meta-bolt

How to publish changes:

  1. If vite-uxp-plugin has any changes, update and publish in npm

  2. If bolt-uxp has any changes, update and publish in npm (include latest vite-uxp-plugin version in the package.json file)

  3. If create-bolt-uxp has any changes, update and publish in npm (include latest bolt-uxp version in the package.json file)