@anolilab/stylelint-config

Shareable Stylelint Config

This npm package provides a set of shareable configurations for Stylelint 15+ — a linter for CSS.

---

^{Daniel Bannert's open source work is supported by the community on GitHub Sponsors}

---

Propose

Our package offers a comprehensive collection of opinionated, yet adaptable configurations for stylelint. These configurations are designed to empower developers in achieving consistent code styling and mitigating common errors. Here's what our package brings to the table:

• A Strong Foundation for Code Styling: We provide a robust starting point for your project's code styling. Our configurations serve as a solid foundation that can be effortlessly extended and modified according to your specific needs. With this flexibility, you can easily tailor the styling rules to align with your project's requirements.

• Enforcing Best Practices: Our package ensures adherence to widely accepted best practices for CSS development. By enforcing consistent indentation, discouraging the use of vendor prefixes, and discouraging unnecessary specificity, we promote cleaner and more maintainable code. These practices help streamline collaboration and enhance the readability of your stylesheets.

• Error Prevention: Our configurations are equipped to catch common errors that can often go unnoticed. We help you identify and rectify issues like missing units for numeric values, usage of invalid colors, and utilization of unsupported or deprecated CSS features. By proactively highlighting these errors, we aid in improving the overall quality and compatibility of your stylesheets.

• Consistency Across Codebase: Maintaining consistency throughout your codebase is essential for a polished end result. Our package plays a pivotal role in achieving this objective. By providing clear and consistent rules for code styling, we empower developers to adhere to a unified approach. This not only enhances readability but also simplifies maintenance and collaboration within your team.

In summary, our package equips developers with opinionated yet flexible stylelint configurations. By ensuring consistent code styling and error prevention, we streamline the development process and foster a more efficient and harmonious coding environment.

Install

npm install --dev-save browserslist stylelint @anolilab/stylelint-config

pnpm add -D browserslist stylelint @anolilab/stylelint-config

yarn add -D browserslist stylelint @anolilab/stylelint-config

Usage

If you don’t have a .stylelintrc.js, we will create the file for you after installing @anolilab/stylelint-config.

If you already have a .stylelintrc.js, then you can extend the .stylelintrc.js, with @anolilab/stylelint-config.

Note: If the script detects an existing .stylelintrc.js file, it will not overwrite it.

Note: It can happen that the postinstall script don't run, then you have to add the .stylelintrc.js manually.

module.exports = {
    extends: [
        "@anolilab/stylelint-config",
    ]
};

You can also customize the rules provided in the configurations or create your own configuration that extends one of the provided configurations. For more information on how to configure stylelint, see the stylelint configuration documentation.

Tailwind Support

Is build in, so nothing to do.

Add a Package.json Script

To add an NPM script for running stylelint use command, which will add the lint:css and lint:css:fix script to the scripts section of your package.json.

pnpm pkg set scripts.lint:css="stylelint --config=./.stylelintrc.js '**/*.{js,jsx,tsx,ts,less,css,scss,sass}'"
pnpm pkg set scripts.lint:css:fix="pnpm run lint:css --fix"

For npm users, replace pnpm with npm in the above command.

or copy the following to your package.json:

  {
    "scripts": {
      "lint:css": "stylelint --config=./.stylelintrc.js '**/*.{js,jsx,tsx,ts,less,css,scss,sass}'",
      "lint:css:fix": "stylelint --config=./.stylelintrc.js '**/*.{js,jsx,tsx,ts,less,css,scss,sass}' --fix"
    }
  }

This will run stylelint on all defined files in your app's directory and its subdirectories. You can customize the files and directories to be linted as needed.

Note: this package use browserslist to detect the correct browserslist config.

Configurations

The package exports the following configurations, to create your own configuration that extends one or all of the provided configurations.

• @anolilab/stylelint-config -> all rules

• @anolilab/stylelint-config/a11y

• @anolilab/stylelint-config/declaration-block-no-ignored-properties

• @anolilab/stylelint-config/no-unsupported-browser-features

• @anolilab/stylelint-config/require-units

• @anolilab/stylelint-config/selector-no-empty

• @anolilab/stylelint-config/standard

• @anolilab/stylelint-config/tailwindcss

Supported Node.js Versions

Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.

Contributing

If you would like to help take a look at the list of issues and check our Contributing guild.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

• Daniel Bannert
• All Contributors

License

The anolilab javascript-style-guide is open-sourced software licensed under the MIT license