@scentregroup/stylelint-config

Stylelint config for Scentre Group projects.

Usage no npm install needed!

<script type="module">
  import scentregroupStylelintConfig from 'https://cdn.skypack.dev/@scentregroup/stylelint-config';
</script>

README

Scentre Group Stylelint Config

This package contains Scentre Group's Stylelint configuration.

Usage

  1. Run yarn add stylelint stylelint-scss @scentregroup/stylelint-config --dev
  2. Run touch .stylelintrc.js
  3. Extend @scentregroup/stylelint-config, i.e. add the following to .stylelintrc.js:
module.exports = {
  extends: ['@scentregroup/stylelint-config']
}
  1. Add a lint:style task to scripts in package.json: stylelint 'src/**/*.{css,scss}'

Development

If you would like to try out the repository locally:

  1. Run git clone git@github.com:ScentreGroup/javascript_config.git
  2. cd javascript_config/stylelint-config
  3. Create a global link to this repository via yarn link
  4. In the repository you would like to test, run yarn link @scentregroup/stylelint-config.
  5. You can then proceed as per the Usage section.