node-swatch-names

Swatch Names

A node tool to save the hassle of naming each color in your project manually.

Swatch-names automatically and consistently names Photoshop color swatches to be shared among frontend developers and designers. Exports colors to SASS and JS variables for use in code. The tool reads standard Photoshop .aco swatch files finds a unique color name for every swatch entry and saves the resulting color palette as an .aco file. This file can be loaded into Photoshop's Swatches so developers and designers use the same color names.

Install

$ npm install node-swatch-names --save-dev

Usage

Start the CLI and progress step-by-step with swatch conversion or setup:

$ ./node_modules/.bin/swatch-names

Specify a swatch file and an output for the result:

$ ./node_modules/.bin/swatch-names --swatch path/to/source-swatch.aco --output path/to/result-swatch.aco

Specify a swatch file, an output and SCSS/JS file to be generated:

$ ./node_modules/.bin/swatch-names --swatch path/to/source-swatch.aco --output path/to/result-swatch.aco --scss path/to/colors.scss --js path/to/colors.js

Run file watcher initialization using npm-watch:

$ ./node_modules/.bin/swatch-names --init

Acknowledgements

This tool was inspired by the following great projects:

• The ACO file format description: http://www.nomodes.com/aco.html
• David LeMieux's excellent aco writer tool: node-aco
• Alvaro Pinot's aco reader tool: aco-reader
• David Aerne's huge collection of color names: color-names

Contributing

PRs are much appreciated!

Use npm run develop while coding and npm run test to run unit tests.

License

MIT © Marton Czebe