Monorepo for Sketch document JSON Schemas and TypeScript types
.sketch
documentSketch stores documents in .sketch
format, a zipped
archive of JSON formatted data and binary data such as images.
This project contains the file format specification and APIs to work with Sketch
documents and document elements in TypeScript.
@sketch-hq/sketch-file-format
: JSON Schema describing the .sketch
document@sketch-hq/sketch-file-format-ts
: TypeScript types to strongly type objects@sketch-hq/sketch-file
: TypeScript APIs to read and write .sketch
files.ℹ️ This section is work in progress until we release our first pre-release.
Pre-releases will be used as a staging area to publish changes to the
specification required by an as-yet unreleased version of the Sketch Mac app.
v5
yarn changeset pre enter {tag}
main
for all work related to the pre-releaseyarn changeset
as peryarn changeset version
and then yarn release
yarn changeset
on the feature branch to document@sketch-hq/sketch-file-format
make sure to@sketch-hq/sketch-file-format-ts
in the changeset.