grunt-sketch

A grunt plugin for exporting images from Sketch documents via SketchTool.

Installation

Install SketchTool.

This plugin requires Grunt >=0.4.4

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins.

Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-sketch --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-sketch');

Example

grunt.initConfig({
	// ...

	sketch_export: {
		grunt_logo: {
			options: {
				type: 'slices',
				items: [
					'Grunt Logo',
					'Symbol',
					'Text'
				],
				scales: [
					1.0,
					2.0
				],
				formats: [
					'png',
					'jpg'
				]
			},
			src: 'src/sketch/Grunt Logo.sketch',
			dest: 'build/assets'
		}
	},

	// ...
});

Tasks

Task: sketch_export

Exports elements from a Sketch document.

options.type (required)

Type: String Valid values: artboards, layers, pages, preview or slices.

The type of document element(s) to export.

options.items

Type: Array Example values: Page 1, 2F21380F-F294-4B5A-AB5C-2ECC21F745BA

The names or identifiers of the document elements to export.

options.formats

Type: Array Valid values: png, jpg, pdf, eps, svg

The file formats to export.

options.scales

Type: Array Example values: 1.0, 2.0

The scales to export.

options.background

Type: String Example values: #000000, #ffffff, red

The background color.

options.bounds

Type: String Example value: -631.000000,-336.000000,380.000000,444.000000

The boundary rectangle to export.

options.trimmed

Type: Boolean Default: false

Indicates whether exported images should be trimmed.

options.overwrite

Type: Boolean Default: false

Indicates whether to overwrite existing files when exporting.

options.compact

Type: Boolean Default: false

Indicates whether to export compact SVG files.

options.compression

Type: Number

The compression level to use when exporting, if applicable for the specified format(s).

options.progressive

Type: Boolean

Indicates whether to export in progressive format, if applicable for the specified format(s).

options.saveForWeb

Type: Boolean Default: false

Indicates whether to "save for the web" - stripping unnecessary metadata.

options.groupContentsOnly

Type: Boolean Default: false

Indicates whether to export only layers that are contained with the group (i.e. forces "Export Group Contents Only" option for slices).

options.useIdForName

Type: Boolean Default: false

Indicates whether to name exported images using their id rather than their name.

options.includeSymbols

Type: Boolean Default: false

Indicates whether to include the ones that represent symbols when exporting artboards.

Task: sketch_list

Lists document element information in JSON format.

options.type (required)

Type: String Valid values: artboards, formats, pages, or slices.

The type of document element(s) to list.

Task: sketch_dump

Dumps document structure information in JSON format.

Acknowledgements

• Bohemian Coding, for creating Sketch and SketchTool.
• Kevin Kazmierczak, whose Grunt plugin for Sencha Cmd served as a very useful reference.
• Sindre Sorhus, whose Grunt plugin for SASS served as a very useful reference.

License

Copyright (c) 2014-2017 CodeCatalyst, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.