Skip to content
A store of automatically generated Sketch file JSON organised by document version and Sketch feature
JavaScript TypeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ci: fix circleci config file naming Nov 8, 2019
.vscode
.yarn
features
files
scripts
.gitignore
.nvmrc
.prettierignore
.prettierrc
.yarnrc
CHANGELOG.md chore(release): 2.0.0 Oct 29, 2019
LICENSE.md feat: rework to organise by document version rather than sketch version Oct 29, 2019
README.md
commitlint.config.js
index.ts
package.json
tsconfig.json
webpack.config.js
yarn.lock

README.md

sketch-reference-files

A store of automatically generated Sketch file JSON organised by document version and Sketch feature.

Overview

Sketch documents are stored as ZIP archives containing JSON encoded data. The file format was originally introduced in Sketch 43 and allows for better third-party integration. For example generating, reading and modifying documents without opening them in Sketch.

In order to provide concrete examples of how different Sketch features are serialised into JSON this repo maintains an archive of reference files.

It's published as an npm module to aid use cases that may involve importing these reference files as test fixtures.

Related projects

Usage

JavaScript

Add the npm module using npm or yarn

npm install @sketch-hq/sketch-reference-files
import files from '@sketch-hq/sketch-reference-files'

The module exports reference file metadata and json contents for each supported document version.

[
  {
    document: 118,
    sketchVersions: ['55', '55.1'],
    files: [
      { id, name, description, data },
      ...
    ],
  },
  ...
]

HTTP

The raw reference file JSON can be accessed over HTTP via predicable urls:

Scripts

Script Description
yarn download-apps Download and locally cache all Sketch app binaries needed to generate the files
yarn generate-files Generate reference files into the files/ folder. Existing reference files are skipped, so delete the files/ folder if you need to generate everything from scratch
yarn build Builds the module entrypoint into the the dist/ folder
yarn update-readme Updates the tables in the "Browse" section of the readme automatically
yarn release Tags the repo and updates the changelog and semver automatically based on commit history. You'll still need to push the changes and publish manually afterwards

Browse

Document 121

Sketch versions: 59, 60

Feature Document Pages Meta User
Empty 🔗 🔗 🔗 🔗
Groups 🔗 🔗 🔗 🔗
Images 🔗 🔗 🔗 🔗
Library styles 🔗 🔗 🔗 🔗
Library symbols 🔗 🔗 🔗 🔗
Prototypes 🔗 🔗 🔗 🔗
Shape paths 🔗 🔗 🔗 🔗
Shapes 🔗 🔗 🔗 🔗
Symbol overrides 🔗 🔗 🔗 🔗
Symbols 🔗 🔗 🔗 🔗
Text 🔗 🔗 🔗 🔗
Smart layout 🔗 🔗 🔗 🔗
Blur 🔗 🔗 🔗 🔗
Slice 🔗 🔗 🔗 🔗
Export formats 🔗 🔗 🔗 🔗
Variable font 🔗 🔗 🔗 🔗

Document 120

Sketch versions: 58

Feature Document Pages Meta User
Empty 🔗 🔗 🔗 🔗
Groups 🔗 🔗 🔗 🔗
Images 🔗 🔗 🔗 🔗
Library styles 🔗 🔗 🔗 🔗
Library symbols 🔗 🔗 🔗 🔗
Prototypes 🔗 🔗 🔗 🔗
Shape paths - - - -
Shapes 🔗 🔗 🔗 🔗
Symbol overrides 🔗 🔗 🔗 🔗
Symbols 🔗 🔗 🔗 🔗
Text 🔗 🔗 🔗 🔗
Smart layout 🔗 🔗 🔗 🔗
Blur 🔗 🔗 🔗 🔗
Slice 🔗 🔗 🔗 🔗
Export formats 🔗 🔗 🔗 🔗
Variable font - - - -

Document 119

Sketch versions: 55.2, 56, 56.1, 56.2, 56.3, 57, 57.1

Feature Document Pages Meta User
Empty 🔗 🔗 🔗 🔗
Groups 🔗 🔗 🔗 🔗
Images 🔗 🔗 🔗 🔗
Library styles 🔗 🔗 🔗 🔗
Library symbols 🔗 🔗 🔗 🔗
Prototypes 🔗 🔗 🔗 🔗
Shape paths 🔗 🔗 🔗 🔗
Shapes 🔗 🔗 🔗 🔗
Symbol overrides 🔗 🔗 🔗 🔗
Symbols 🔗 🔗 🔗 🔗
Text 🔗 🔗 🔗 🔗
Smart layout - - - -
Blur 🔗 🔗 🔗 🔗
Slice 🔗 🔗 🔗 🔗
Export formats 🔗 🔗 🔗 🔗
Variable font - - - -

Document 118

Sketch versions: 55, 55.1

Feature Document Pages Meta User
Empty 🔗 🔗 🔗 🔗
Groups 🔗 🔗 🔗 🔗
Images 🔗 🔗 🔗 🔗
Library styles 🔗 🔗 🔗 🔗
Library symbols 🔗 🔗 🔗 🔗
Prototypes 🔗 🔗 🔗 🔗
Shape paths 🔗 🔗 🔗 🔗
Shapes 🔗 🔗 🔗 🔗
Symbol overrides 🔗 🔗 🔗 🔗
Symbols 🔗 🔗 🔗 🔗
Text 🔗 🔗 🔗 🔗
Smart layout - - - -
Blur 🔗 🔗 🔗 🔗
Slice 🔗 🔗 🔗 🔗
Export formats 🔗 🔗 🔗 🔗
Variable font - - - -
You can’t perform that action at this time.