{"id":19570987,"url":"https://github.com/sketch-hq/sketch-document","last_synced_at":"2025-04-04T11:13:50.030Z","repository":{"id":36956943,"uuid":"191380631","full_name":"sketch-hq/sketch-document","owner":"sketch-hq","description":"Monorepo for Sketch document JSON Schemas and TypeScript types","archived":false,"fork":false,"pushed_at":"2023-04-03T14:23:23.000Z","size":128936,"stargazers_count":190,"open_issues_count":8,"forks_count":18,"subscribers_count":21,"default_branch":"main","last_synced_at":"2025-03-28T10:07:32.329Z","etag":null,"topics":["file-format","sketch"],"latest_commit_sha":null,"homepage":"https://developer.sketch.com/file-format/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sketch-hq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-11T13:46:21.000Z","updated_at":"2025-02-11T12:20:36.000Z","dependencies_parsed_at":"2024-06-18T14:01:19.907Z","dependency_job_id":"01ee5ccc-034a-46bd-a020-528a1dd6221f","html_url":"https://github.com/sketch-hq/sketch-document","commit_stats":null,"previous_names":[],"tags_count":100,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sketch-hq%2Fsketch-document","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sketch-hq%2Fsketch-document/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sketch-hq%2Fsketch-document/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sketch-hq%2Fsketch-document/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sketch-hq","download_url":"https://codeload.github.com/sketch-hq/sketch-document/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247166168,"owners_count":20894654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["file-format","sketch"],"created_at":"2024-11-11T06:17:09.676Z","updated_at":"2025-04-04T11:13:50.002Z","avatar_url":"https://github.com/sketch-hq.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `.sketch` document\n\n[Sketch](https://sketch.com) stores documents in `.sketch` format, a zipped\narchive of JSON formatted data and binary data such as images.\n\n## Sketch file format schemas and APIs.\n\nThis project contains the file format specification and APIs to work with Sketch\ndocuments and document elements in TypeScript.\n\n- `@sketch-hq/sketch-file-format`: JSON Schema describing the `.sketch` document\n  format.\n- `@sketch-hq/sketch-file-format-ts`: TypeScript types to strongly type objects\n  representing Sketch documents, or fragments of Sketch documents in TypeScript\n  projects.\n- `@sketch-hq/sketch-file`: TypeScript APIs to read and write `.sketch` files.\n\n## Development\n\n### Pre-release\n\n\u003e ℹ️ This section is work in progress until we release our first pre-release.\n\u003e Pre-releases will be used as a staging area to publish changes to the\n\u003e specification required by an as-yet unreleased version of the Sketch Mac app.\n\n1. Create a new branch to track the pre-release, e.g. `v5`\n1. Read the changesets pre-release\n   [docs](https://github.com/atlassian/changesets/blob/main/docs/prereleases.md)\n1. Enter pre-release mode on the branch `yarn changeset pre enter {tag}`\n1. Commit the changes and push the branch. This branch will act as a stand-in\n   for `main` for all work related to the pre-release\n1. PR into the new branch with feature branches, calling `yarn changeset` as per\n   normal to signal intents to publish. Since this is a pre-release it's likely\n   that we'll be marshalling a major version bump\n1. Publishing pre-releases is not automated, so when you're ready to publish the\n   pre-release call `yarn changeset version` and then `yarn release`\n\n### Release\n\n1. Following changes, run `yarn changeset` on the feature branch to document\n   changes.\n1. If changes have been made to the `@sketch-hq/sketch-file-format` make sure to\n   include `@sketch-hq/sketch-file-format-ts` in the changeset.\n1. On merge, changesets will produce a release pull-request named _Version\n   Packages_ with all changes since the last release.\n1. Merge the release pull-request maintained by the changesets\n   [GitHub Action](https://github.com/changesets/action) to publish new releases\n   to NPM.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsketch-hq%2Fsketch-document","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsketch-hq%2Fsketch-document","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsketch-hq%2Fsketch-document/lists"}