figplug
v0.1.20
Published
Figma plugin builder
Downloads
27
Maintainers
Readme
figplug
Figma plugin helper.
- Simplify creation of plugins
- Simplify compiling of plugins
- Yields plugins with efficient code that loads fast
- TypeScript
- Supports React out of the box
Install: npm install -g figplug
Examples:
# create a plugin
figplug init -ui my-plugin
# build a plugin
figplug build -w my-plugin
# Your plugin is now available in "my-plugin/build".
# -w makes figbuild watch your source files for changes
# and rebuild your plugin automatically.
init
Initialize Figma plugins in directories provided as <dir>
, or the current directory.
Usage: figplug init [<dir> ...]
Initialize Figma plugins in directories provided as <dir>, or the current directory.
options:
-ui Generate UI written in TypeScript & HTML
-html Generate UI written purely in HTML
-react Generate UI written in React
-f, -force Overwrite or replace existing files
-api=<version> Specify Figma Plugin API version. Defaults to "1.0.0".
-name=<name> Name of plugin. Defaults to directory name.
-srcdir=<dirname> Where to put source files, relative to <dir>. Defaults to ".".
-v, -verbose Print additional information to stdout
-debug Print a lot of information to stdout. Implies -v
-version Print figplug version information
build
Builds Figma plugins.
Usage: figplug build [options] [<path> ...]
Builds Figma plugins.
<path> Path to a plugin directory or a manifest file. Defaults to ".".
You can optionally specify an output directory for every path through
<path>:<outdir>. Example: src:build.
This is useful when building multiple plugins at the same time.
options:
-w Watch sources for changes and rebuild incrementally
-g Generate debug code (assertions and DEBUG branches).
-O Generate optimized code.
-lib=<file> Include a global library in plugin code. Can be set multiple times.
-clean Force rebuilding of everything, ignoring cache. Implied with -O.
-nomin Do not minify or mangle optimized code when -O is enabled.
-o=<dir>,
-output=<dir> Write output to directory. Defaults to ./build
-v, -verbose Print additional information to stdout
-debug Print a lot of information to stdout. Implies -v
-version Print figplug version information