Skip to content

Latest commit

 

History

History
102 lines (68 loc) · 3.63 KB

README.md

File metadata and controls

102 lines (68 loc) · 3.63 KB
Raw

symbol-overlay-toggle

Toggle Symbol Overlays

This Sketch plug-in seeks symbols sourced from an external Sketch library, and creates an overlay layer and the name of the symbol. Think of it as custom redlines, which use the symbol name as a shortcut to the code instructions referring to an established library component. Instead of specifying each atomic formatting value, we give the style a name and make that name the name of the symbol.

Usage

Install it and run it. If there are any layers named "o.overlay", it will find them and delete them. If no "o.overlay" layers are found, it will find all library-sourced symbols on the page. "o.overlay", as well as the colors of the overlay, are configurable by changing the constants in the source code.

The script only operates on the current page of your Sketch file.

If you're curious about how it works, download the source file and edit the script to "debug=true", then watch your console for what the script is doing. If you need to change the names of the layer styles, text styles, or affected layers, they're all stored in constants at the top of the script.

Installation

  • Download the latest release of the plugin
  • Un-zip
  • Double-click on symbol-overlay-toggle.sketchplugin

Development Guide

This plugin was created using skpm. For a detailed explanation on how things work, checkout the skpm Readme.

Usage

Install the dependencies

npm install

Once the installation is done, you can run some commands inside the project folder:

npm run build

To watch for changes:

npm run watch

Additionally, if you wish to run the plugin every time it is built:

npm run start

Custom Configuration

Babel

To customize Babel, you have two options:

  • You may create a .babelrc file in your project's root directory. Any settings you define here will overwrite matching config-keys within skpm preset. For example, if you pass a "presets" object, it will replace & reset all Babel presets that skpm defaults to.

  • If you'd like to modify or add to the existing Babel config, you must use a webpack.skpm.config.js file. Visit the Webpack section for more info.

Webpack

To customize webpack create webpack.skpm.config.js file which exports function that will change webpack's config.

/**
 * Function that mutates original webpack config.
 * Supports asynchronous changes when promise is returned.
 *
 * @param {object} config - original webpack config.
 * @param {boolean} isPluginCommand - whether the config is for a plugin command or a resource
 **/
module.exports = function(config, isPluginCommand) {
  /** you can change config here **/
}

Debugging

To view the output of your console.log, you have a few different options:

  • Use the sketch-dev-tools
  • Run skpm log in your Terminal, with the optional -f argument (skpm log -f) which causes skpm log to not stop when the end of logs is reached, but rather to wait for additional data to be appended to the input

Publishing your plugin

skpm publish <bump>

(where bump can be patch, minor or major)

skpm publish will create a new release on your GitHub repository and create an appcast file in order for Sketch users to be notified of the update.

You will need to specify a repository in the package.json:

...
+ "repository" : {
+   "type": "git",
+   "url": "git+https://github.com/ORG/NAME.git"
+  }
...