Sketch Plugin Boilerplate

An ultra-minimal skpm template

Contents

• Rationale
• Features
• Requirements
• Installation
• Usage
• License
• Contacts

Rationale

I simply needed a skpm template to scaffold, and spin up a Sketch plugin on the fly.

• This is not a Sketch plugin. It's a boilerplate to quickly build one
• The template includes my personal name, and contacts. If you're not me... Make sure to edit them! 🙃
• This project could not necessarily address, nor fit all your needs
• This uses yarn only, no npm

Features

• Temporary shortcut set to ctrl+cmd+z
• Customizable linting via ESLint, and Prettier
• Sketch Runner integration-ready

Requirements

yarn global add skpm
yarn add eslint
yarn add babel-eslint
yarn add prettier

Install the proper plugins (ESLint, Prettier, EditorConfig) to lint and format the code directly in your text-editor (optional).

Installation

skpm create <project-name> --name "<Project Name>" --template=lucaorio/sketch-plugin-boilerplate --install false
cd <project-name>
yarn install

Usage

# build with hot reload
yarn watch

# lint
yarn lint

# lint and build
yarn build

# lint, build, and symlink the plugin
yarn symlink

License

---

Contacts

• 🐦 Twitter @lucaorio_
• 🕸 Website lucaorio.com
• 📬 Email luca.o@me.com