Convert a bunch of PNGs to a Sass spritemap.

Tomek Wójcik 0457144c94 Bunch of tweaks and fixes. 10 months ago
example 0457144c94 Bunch of tweaks and fixes. 10 months ago
lib 0457144c94 Bunch of tweaks and fixes. 10 months ago
test 0457144c94 Bunch of tweaks and fixes. 10 months ago
.eslintrc.json fc60ab110d Hello, sass-spritemaker! 10 months ago
.gitignore fc60ab110d Hello, sass-spritemaker! 10 months ago
.npmignore fc60ab110d Hello, sass-spritemaker! 10 months ago
LICENSE fc60ab110d Hello, sass-spritemaker! 10 months ago
NOTICE.txt fc60ab110d Hello, sass-spritemaker! 10 months ago
README.md fc60ab110d Hello, sass-spritemaker! 10 months ago
package-lock.json fc60ab110d Hello, sass-spritemaker! 10 months ago
package.json 0457144c94 Bunch of tweaks and fixes. 10 months ago
yarn.lock fc60ab110d Hello, sass-spritemaker! 10 months ago

README.md

sass-spritemaker

Convert a bunch of PNGs to a Sass spritemap.

Installation

sass-spritemaker requires Node 6.9.0 or later.

npm install --save-dev @bthlabs/sass-spritemaker

This assumes that you’re using npm package manager. sass-spritemaker supports yarn, too.

Usage example

The following JavaScript code demonstrates the most common usage of the library:

const {spritemaker} = require('../lib/spritemaker.js');

spritemaker({
  files: ['./icons/*.png'],
  output: './output/'
});

API

spritemaker(options)

This is the main entrypoint of the library. The options argument is an object that specifies the function's behaviour.

Options object fields:

  • fields - array of globs that will be resolved to construct input files list. Defaults to [].
  • output - path to output directory. Defaults to sprite/.
  • urlPrefix - URL prefix for background image URLs. Defaults to /.

Development

To bootstrap the development environment, clone the repo and run npm install from the root directory.

The package.json file provides the following scripts:

  • lint - performs an eslint run over the source code,
  • test - performs a single test run.

Contributing

If you think you found a bug or want to send a patch, feel free to contact me through e-mail.

If you're sending a patch, make sure it passes eslint checks and is tested.

Author

sass-spritemaker is developed by Tomek Wójcik.

License

sass-spritemaker is licensed under the MIT License.