stylelint 15.10.3

Stylelint is a robust and customizable CSS linter that aids in the prevention of errors and enforcement of conventions in your stylesheets. With over 100 built-in rules for modern CSS syntax and features, Stylelint ensures your code is not only valid but also consistent and adheres to best practices. It even possesses the capability to fix problems automatically when possible. Extensible through plugins, Stylelint caters to bespoke requirements and supports languages like SCSS, Sass, Less, and SugarSS. With its emphasis on conventions, Stylelint can help disallow specific units, enforce naming patterns, set limits like the number of ID selectors, and specify notations for modern color functions.

To start using Stylelint, you'll need to first install it in your project. Use npm or yarn to add it as a development dependency:

// with npm
npm install stylelint --save-dev

// with yarn
yarn add stylelint --dev

Once installed, create a configuration file (.stylelintrc) in your project root. This file will contain rules that Stylelint will enforce:

// .stylelintrc
{
  "rules": {
    "block-no-empty": true,
    "color-no-invalid-hex": true,
    // add more rules as per your requirement
  }
}

You can lint your stylesheet files using the Stylelint command followed by the file or directory path:

// Lint a single file
npx stylelint "path/to/file.css"

// Lint an entire directory
npx stylelint "path/to/directory/*.css"

Stylelint can also be integrated with build systems like Gulp, Grunt, and webpack through respective plugins. Moreover, many popular text editors have Stylelint plugins that provide linting inside the editor itself.

The complete documentation for Stylelint can be found on their GitHub repository under the "docs" directory. The documentation is comprehensive, offering guidance on getting started, customizing, configuring, and detailed information about all the rules. There are also guides for ignoring code, using the CLI, and for the Node.js API. Overall, the docs serve as an in-depth resource for everything you need to know about Stylelint.