@sketch-hq/sketch-assistant-core-rules
Advanced tools
Official core rules Sketch Assistant.
💁♀️ This is a "rules only" Assistant, meaning it contains only rule implementations and no configuration. Adding this Assistant to Sketch won't do anything because rules need to be activated in configuration before they will report anything.
Use this Assistant by extending from it in your own Assistant, and adding configuration and/or additional rule implementations.
TODO: Link to documentation about creating Assistants, and extending from Assistants here.
TODO: Link to other official Assistants that extend this one.
This Assistant exports the following rules. Click the links to view their documentation, configuration options and implementation.
artboards-gridartboards-layoutartboards-max-ungroupedborders-no-disableddebug-all-optionsdebug-i18ndebug-throws-errorexported-layers-normal-blend-modefills-no-disabledgroups-max-layersgroups-no-emptygroups-no-redundantimages-no-outsizedimages-no-undersizedinner-shadows-no-disabledlayer-styles-no-dirtylayer-styles-prefer-sharedlayers-no-hiddenlayers-no-looselayers-subpixel-positioningname-pattern-artboardsname-pattern-groupsname-pattern-imagesname-pattern-pagesname-pattern-shapesname-pattern-symbolsname-pattern-textresult-messages-includeshadows-no-disabledshared-styles-no-unusedsymbols-no-unusedtext-styles-no-dirtytext-styles-prefer-sharedThe following section of the readme only relates to developing the Assistant, not using it in your own projects.
Interact with the tooling in this repository via the following scripts.
| Script | Description |
|---|---|
| yarn build | Builds the Assistant to the dist folder |
| yarn format-check | Checks the formatting with prettier |
| yarn i18n:extract | Extracts strings from the JS source to PO files |
| yarn test | Runs the Jest tests |
| yarn type-check | Typecheck the TypeScript |
Try and use the conventional commits convention when writing commit messages.
Use a TDD approach, and the existing rules as a guide.
Rule functions can run in Node against plain Sketch file JSON, so the Mac Sketch app isn't required while actively developing rule logic.
When creating a new rule in this repository:
src/ as a starting point.src/index.ts..sketch files to use as test fixtures. At a minimum these
should demonstrate two scenarios - one where you'd expect your rule to report violations, and one
where it shouldn't report anyyarn test --watch.This repository uses Atlassian Changesets to automate the npm release process. Read the docs for more information, but the top-level summary is:
yarn changeset. You'll be asked to provide a change type (major, minor or patch) and a message.This Assistant requires internationalization since it's an official Sketch Assistant.
Translating your own Assistants is completely optional however.
Internationalization is handled by LinguiJS, and follows their guides for handling plain JavaScript projects.
The following locales are currently supported in the Sketch Mac app and this project:
en (American English)zh-Hans (Chinese Simplified)When ready to perform a round of translation, for example when there are new untranslated strings in the repository, perform the following workflow:
yarn i18n:extract which will update the .po files in src/locale/ with the new strings
used throughout the source code.master.3.0.1
layers-subpixel-positioningFAQs
Official core rules Sketch Assistant.
The npm package @sketch-hq/sketch-assistant-core-rules receives a total of 2 weekly downloads. As such, @sketch-hq/sketch-assistant-core-rules popularity was classified as not popular.
We found that @sketch-hq/sketch-assistant-core-rules demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.