stricter-plugin-tangerine
v0.2.0stricter-plugin-tangerine
A set of Stricter rules developed by Atlassian as part of Atlassian Frontend.
Installation
Install Stricter locally or globally:
$ yarn add --dev stricter
If you've installed Stricter
globally, you'll have to install the tangerine
plugin globally too.
Otherwise, install it locally:
$ yarn add --dev stricter-plugin-tangerine
Configuration
Note: This will most likely change in the future to a proper plugin system
Specify the rules dir of this plugin in the rulesDir
configuration of your stricter.config.js
file:
{
"rulesDir": ["my-custom-rules", "node_modules/stricter-plugin-tangerine/rules"]
}
You can now enable the rules you want to use:
{
"rules": {
"tangerine/project-structure": "error"
}
}
Rules
project-structure
- Enforce a specific file structure for your project (project-structure)
Contributing
All rules are located in separate directories, in the corresponding rules/<ruleCategory>
directory. The rule's name must be identical to its directory name.
Every rule must contain:
index.js
- The rule's implementation, following this template.README.md
- The rule's documentation, following this template.test.js
- The rule's tests, following this template.
After adding a new rule, run yarn docs:generate-pkg
from the root directory to add a link to the
frontpage README.md
file.
All rules are exposed automatically.
To change this file, edit
template
instead, then run yarn docs:generate-pkg
from the root directory
Metadata
- MIT
- Whatever
- Atlassian
- released 10/2/2019