Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fireinureeyes/netural-guidelines-assistant
Sketch assistant checking naming conventions and other guidelines defined in external JSON file by UX team @Netural
https://github.com/fireinureeyes/netural-guidelines-assistant
assistant sketch
Last synced: 6 days ago
JSON representation
Sketch assistant checking naming conventions and other guidelines defined in external JSON file by UX team @Netural
- Host: GitHub
- URL: https://github.com/fireinureeyes/netural-guidelines-assistant
- Owner: fireinureeyes
- License: mit
- Created: 2020-09-21T11:14:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T16:29:29.000Z (about 2 years ago)
- Last Synced: 2025-01-14T04:56:45.726Z (30 days ago)
- Topics: assistant, sketch
- Language: TypeScript
- Homepage: https://www.netural.com
- Size: 1.92 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Netural Guidelines Assistant for Sketch
> This Sketch assistant validates document opacities, radiuses, shadows, border styles, border
> colors, fill colors, text colors, text sizes, text line-heights and font families against generic
> design tokens defined in a JSON file.
## About Sketch Assistants
First time using a Sketch Assistant?
[🤔 How can I add assistant to my sketch file?](https://www.sketch.com/docs/assistants/#adding-an-assistant-from-a-url-or-file)
## Links
[👉 Netural.com](https://www.netural.com)
[👉 Download this Assistant](https://registry.npmjs.org/netural-guidelines-assistant/-/netural-guidelines-assistant-1.0.3.tgz)
## Linting rules
Opacity
Opacities should match the defined token values.
- Reports a violation if a font is different than defined in JSON file.
---
Radius
Radiuses should match the defined token values.
- Reports a violation if a radius is different than defined in JSON file.
---
Shadow
Shadows should match the defined token values.
- Reports a violation if a shadow is different than defined in JSON file.
---
Border style
Border styles should match the defined token values.
- Reports a violation if a border style is different than defined in JSON file.
---
Border color
Border colors should match defined border or generic color token values.
- Reports a violation if a border color is different than defined in JSON file.
---
Fill color
Fill colors should match defined fill or generic color token values.
- Reports a violation if a fill color is different than defined in JSON file.
---
Text color
Text colors should match defined text or generic color token values.
- Reports a violation if a text color is different than defined in JSON file.
---
Text size
Text sizes should match the defined token values.
- Reports a violation if a text size is different than defined in JSON file.
---
Text line height
Text line heights should match the defined token values.
- Reports a violation if a text line height is different than defined in JSON file.
---
Text font family
Font families should match the defined token values.
- Reports a violation if a font family used is different than defined in JSON file.
---
Artboard names
Artboard names should follow the naming conventions.
- Reports a violation if an artboard name is different than defined in JSON file.
---
Symbol names
Symbol names should follow the naming conventions.
- Reports a violation if a symbol name is different than defined in JSON file.
---
Shared text style names
Names of shared text styles should follow the naming conventions.
- Reports a violation if a shared text style name is different than defined in JSON file.
---
Text content
Texts should not contain defined phrases.
- Reports a violation if a text contains any of the defined phrases.