Sketch.metadata¶

Provides support for extracting metadata from sketch-documents. More…

Properties¶

sketchtoolPath: path
workingDir: string

Detailed Description¶

Every Sketch document is a zip-file that contains graphical assets, data, settings, and metadata in JSON format. The metadata can be extracted using this module.

A bit ~~dumb~~ useless example below:

SketchExport {
    name: 'sketch-meta'

    Group {
        fileTagsFilter: ['sketch.metadata']
        qbs.install: true
    }
}

It's suggest to export the metadata at least from one of your documents, look in the file and decide what you can do with it.

File Tags¶

Input¶

Tag	Auto-tagged patterns	Description
`sketch`	*.sketch	Sketch documents used as a source for extracting metadata.

Output¶

Tag	Description
`sketch.metadata`	Metadata files (*.meta.json) extracted from documents are marked with this tag.

Property Documentation¶

`sketchtoolPath`¶

The path to the sketchtool that will be used for exporting. Usually, there is no need to change this value.

Default: the binary from the first found Sketch.app installed in your system.

`workingDir`¶

Contains the path to the export working directory. Useful when you want to install generated files preserving the folder structure.