https://github.com/sketch-hq/sketch-document

Monorepo for Sketch document JSON Schemas and TypeScript types
https://github.com/sketch-hq/sketch-document

file-format sketch

Last synced: 3 days ago
JSON representation

Monorepo for Sketch document JSON Schemas and TypeScript types

• Host: GitHub
• URL: https://github.com/sketch-hq/sketch-document
• Owner: sketch-hq
• License: mit
• Created: 2019-06-11T13:46:21.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-04-03T14:23:23.000Z (almost 2 years ago)
• Last Synced: 2025-01-11T23:09:49.454Z (10 days ago)
• Topics: file-format, sketch
• Language: TypeScript
• Homepage: https://developer.sketch.com/file-format/
• Size: 123 MB
• Stars: 188
• Watchers: 22
• Forks: 18
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# `.sketch` document

[Sketch](https://sketch.com) stores documents in `.sketch` format, a zipped

archive of JSON formatted data and binary data such as images.

## Sketch file format schemas and APIs.

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

  format.

- `@sketch-hq/sketch-file-format-ts`: TypeScript types to strongly type objects

  representing Sketch documents, or fragments of Sketch documents in TypeScript

  projects.

- `@sketch-hq/sketch-file`: TypeScript APIs to read and write `.sketch` files.

## Development

### Pre-release

> ℹ️ 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.

1. Create a new branch to track the pre-release, e.g. `v5`

1. Read the changesets pre-release

   [docs](https://github.com/atlassian/changesets/blob/main/docs/prereleases.md)

1. Enter pre-release mode on the branch `yarn changeset pre enter {tag}`

1. Commit the changes and push the branch. This branch will act as a stand-in

   for `main` for all work related to the pre-release

1. PR into the new branch with feature branches, calling `yarn changeset` as per

   normal to signal intents to publish. Since this is a pre-release it's likely

   that we'll be marshalling a major version bump

1. Publishing pre-releases is not automated, so when you're ready to publish the

   pre-release call `yarn changeset version` and then `yarn release`

### Release

1. Following changes, run `yarn changeset` on the feature branch to document

   changes.

1. If changes have been made to the `@sketch-hq/sketch-file-format` make sure to

   include `@sketch-hq/sketch-file-format-ts` in the changeset.

1. On merge, changesets will produce a release pull-request named _Version

   Packages_ with all changes since the last release.

1. Merge the release pull-request maintained by the changesets

   [GitHub Action](https://github.com/changesets/action) to publish new releases

   to NPM.