Shareable stylelint config for CSS and SCSS, following AHD Creative code style
Our default export contains all of our Stylelint rules, along with specific plugins for SCSS syntax.
- Run
npm install stylelint @ahdceative/stylelint-config-ahd --save-dev
- Add
"extends": "@ahdcreative/stylelint-config-ahd"
to your.stylelintrc
- Required Node
- We recommend using nvm
- Clone the project on to your computer
- Run
nvm install
to ensure you have the correct Node version - Run
npm install
to install project dependencies - Ensure your editor is set up to use editorconfig, Prettier, Eslint and Stylelint
- Run
nvm use
to set Node to the correct version - Run tests via
npm run test
- Run linting via
npm run lint
- Run updates to Readme (if rules have changed) via
npm run write-rules
- Run preflight checks before committing final code via
npm run preflight
- Note: When working with the rule set, only modify the
index.js
file, not the.eslintrc
file as it is for local linting only