@adp-psych/stylelint-config

stylelint configuration

Usage no npm install needed!

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

README

Anthony Di Pietro’s stylelint Configuration

The stylelint configuration for Anthony Di Pietro’s projects.

Usage

Installation

Install the package from npm (requires Node.js):

npm install --save-dev @adp-psych/stylelint-config

Install peer dependencies:

npm install --save-dev stylelint stylelint-a11y stylelint-at-rule-no-children stylelint-color-format stylelint-config-recommended stylelint-config-standard stylelint-declaration-block-no-ignored-properties stylelint-declaration-strict-value stylelint-find-rules stylelint-group-selectors stylelint-high-performance-animation stylelint-images stylelint-media-use-custom-media stylelint-no-browser-hacks stylelint-no-indistinguishable-colors stylelint-no-unsupported-browser-features stylelint-order stylelint-selector-no-empty stylelint-selector-tag-no-without-class stylelint-use-logical stylelint-use-nesting stylelint-value-no-unknown-custom-properties

Configuration

Configure stylelint to use the configuration by editing stylelint.config.js:

module.exports = {
    'extends': '@adp-psych/stylelint-config',
};

Development

Documentation

Generate documentation into the doc directory with JSDoc:

npm run doc

Linting

Lint the project with ESLint and npm-package-json-lint:

npm run lint

Testing

Test the configuration by linting test.css, a CSS file that contains only a @charset at-rule:

npm run test

Dependencies

Check for new dependencies with npm-check:

npm run npm-check

Rules

Check for new rules with stylelint-find-rules:

npm run stylelint-find-rules

Release

Publish a release with np:

npm run release

Legal Information

Copyright

Copyright © 2018, 2019, 2020 Anthony Di Pietro

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.