sketch-assistants
sketch-assistants copied to clipboard
Published
20 hours ago •
sketch-hq
sketch-hq
Monorepo containing the official Sketch Assistants, along with utility functions and types for Sketch Assistant development.
Sketch Assistants
A TypeScript monorepo for Sketch Assistants and related packages.
Contents
Assistants
- Tidy
- Naming Conventions
- Reuse Suggestions
Packages
- Types
- Utils
Development
This section of the readme deals with development only. If you're just here to install Assistants in Sketch you can safely ignore this section.
Tools
- Node (12.X.X or later)
- Yarn (1.X.X)
- Visual Studio Code (Recommended editor, not required to build the source)
Getting started
- Clone the repository.
- Run
yarnin the root folder. - Head to the package folder you wish to work with for additional documentation (linked above).
Monorepo scripts
These scripts operate globally across every package in the monorepo.
| Script | Description |
|---|---|
yarn build |
Builds all packages |
yarn test |
Test all packages |
yarn format-check |
Check the format for all code in the monorepo |
yarn release |
Build and release all packages to npm |
Release process
This repository uses Atlassian Changesets to manage the npm release process. Read the docs for more information, but the top-level summary is:
- If you want the work you're doing on a package, or set of packages, to be released then run
yarn changeset. An interactive CLI will ask you which packages should be released, and what sort of semver bump type they should receive. - The CLI will generate a changeset for you in the repository, which you should include in your Pull Request.
- To release the packages to npm, based on the changesets that accumulate in the repository, merge the automatically generated Pull Request called Version Packages.
sketch-hq