@chromatix/stylelint-config-chromatix
v0.1.19
Published
Chromatix custom config for stylelint. Based heavily on the WordPress Coding Standards but with some of our own too.
Downloads
399
Readme
stylelint-config-chromatix
Shareable config for stylelint for custom standards at Chromatix Digital Agency.
Based heavily on the WordPress Coding Standards but with some of our own too. Most notably, two spaces instead of tabs. Soz.
This config is still in development. If you have suggestions for improvement or if you disagree with anything this config makes you do, feel free to file an issue.
Publishing to npm/yarn
NOTE: This package is available on npm and once a Pull request has been merged to master the master branch needs to be published to npm/yarn to reflect any changes or updates.
Consult LastPass or Julian for where to find login details for https://www.npmjs.com
Details for how to publish the config to npm can be found here: https://yarnpkg.com/lang/en/docs/publishing-a-package/
Installation
Install globally to use on any project:
yarn global add @chromatix/stylelint-config-chromatix
Install locally to one project:
yarn add --dev @chromatix/stylelint-config-chromatix
You'll also need to have stylelint installed in the same manner.
Usage
Add this to your .stylelintrc.js
file:
module.exports = {
'extends': [
require.resolve( '@chromatix/stylelint-config-chromatix' )
]
};
Then:
Using globally?
Runstylelint "**/*.scss"
.Using locally?
Add"lint:sass": "stylelint \"**/*.scss\""
to yourpackage.json
's"scripts"
section, then runyarn lint:sass
Additional Tips
- Want stylelint to list the filenames it is linting, even if everything passes? Add
--formatter verbose
to yourstylelint
command.
See also
License
MIT.