@fastcms/stylelint-config

Shared @stylelint configs for projects of @fastcms

Installation

Use npx to install peerdeps automatically or install peerDependencies and optionalDependencies with npm/yarn manually.

# Install using npm
$ npm info "@fastcms/stylelint-config" peerDependencies optionalDependencies
$ npx install-peerdeps --dev @fastcms/stylelint-config

# Install using yarn
$ yarn add --dev @fastcms/stylelint-config postcss stylelint

Usage

After installation, add stylelint entry to package.json file.

{
  "extends": "@fastcms/stylelint-config"
}

Or create a stylelint config file .stylelintrc.js to the project root.

module.exports = {
  extends: ['@fastcms/stylelint-config'],
  rules: {
    'plugin/no-unsupported-browser-features': [
      true,
      {
        severity: 'warning',
        ignore: [],
      },
    ],
  },
};

Scripts

Add stylelint scripts to package.json, then run Stylelint with yarn run stylelint manually, or integrate with GitHub Actions.

{
  "scripts": {
    "stylelint": "stylelint --aei \"**/*.{css,less,scss,wxss,jsx,tsx}\"",
    "stylelint:fix": "stylelint --fix --aei \"**/*.{css,less,scss,wxss,jsx,tsx}\""
  }
}

License

The codebase and documentation in this repository are released under the MIT License