npm install -g skpmThe npm command-line tool is bundled with Node.js. If you have it installed, then you already have npm too. If not, go download Node.js.
I'm a sketch user
I'm a plugin developer
- Scaffold the architecture of a new plugin
- Build the plugin
- Symlinking the local plugin to the sketch plugins folder
- Publish the plugin on the registry
To install a sketch plugin:
skpm install name-of-the-pluginTo uninstall a sketch plugin:
skpm uninstall name-of-the-pluginTo search for a sketch plugin:
skpm search queryTo interactively create the architecture to start developing a new plugin (see the sketch documentation for more information):
skpm initThis will create:
- a
package.jsonfile - a
srcfolder with:- a
manifest.jsonfile - a
command.jsfile for an example of command
- a
- a
.gitignorefile if non-existent
The package.json must contain 3 specific fields:
main: pointing to your.sketchpluginmanifest: pointing to yourmanifest.json(src/manifest.jsonby default)repository: pointing to your github repository
To transpile the JavaScript to CocoaScript and copy the manifest.json to the .sketchplugin:
skpm buildTo watch for changes:
skpm build --watchAdditionally, some fields from the package.json will be set in the manifest.json (if not present):
- version
- name
- description
- homepage
skpm link path-to-local-pluginIt will also ask you if you want to disable the caching mechanism and force Sketch to always reload a Plugin’s code from disk (recommended when developing).
To publish a new version of the plugin to the registry:
skpm publish <newversion> | major | minor | patch | premajor | preminor | prepatch | prereleaseThe exact order of execution is as follows:
- Run the
preversionscript - Bump
versionin package.json as requested (patch,minor,major, etc). - Run the
versionscript - Commit and tag
- Run the
postversionscript. - Run the
buildscript - Zip the folder specified in the
mainfield - Create a draft release on GitHub
- Upload the zip to GitHub
- Publish the release
- Remove the zip
- Notify the registry