https://github.com/rsms/figplug

Figma plugin builder
https://github.com/rsms/figplug

Last synced: 3 days ago
JSON representation

Figma plugin builder

• Host: GitHub
• URL: https://github.com/rsms/figplug
• Owner: rsms
• License: mit
• Created: 2019-06-27T01:26:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-06T03:57:33.000Z (over 1 year ago)
• Last Synced: 2025-01-10T23:47:41.060Z (4 days ago)
• Language: TypeScript
• Homepage: https://rsms.me/figplug/
• Size: 6.18 MB
• Stars: 361
• Watchers: 4
• Forks: 16
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-figma - figplug - Figma plugin builder. (Plugins development)

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:

```sh

# 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 ``, or the current directory.

```

Usage: figplug init [ ...]

Initialize Figma plugins in directories provided as , 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=     Specify Figma Plugin API version. Defaults to "1.0.0".

  -name=       Name of plugin. Defaults to directory name.

  -srcdir=  Where to put source files, relative to . 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] [ ...]

Builds Figma plugins.

  Path to a plugin directory or a manifest file. Defaults to ".".

        You can optionally specify an output directory for every path through

        :. 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=      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=,

    -output=  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

```