\n \n Daniel Bannert's open source work is supported by the community on GitHub Sponsors\n \n
\n
\n\n---\n\n## Propose\n\nOur package offers a comprehensive collection of opinionated, yet adaptable configurations for [stylelint](https://stylelint.io/).\nThese configurations are designed to empower developers in achieving consistent code styling and mitigating common errors. Here’s what our package brings to the table:\n\n- 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.\n\n- 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.\n\n- 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.\n\n- 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.\n\nIn 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.\n\n## Install\n\n```sh\nnpm install @anolilab/stylelint-config\n```\n\n```sh\nyarn add @anolilab/stylelint-config\n```\n\n```sh\npnpm add @anolilab/stylelint-config\n```\n\n## Usage\n\nIf you don’t have a `.stylelintrc.js` or the other supported filenames and `.stylelintignore`, we can create the file for you after installing `@anolilab/stylelint-config`, call `pnpm stylelint-config:install`.\n\n> Note: If the script detects an existing `.stylelintrc.js` file, it will not overwrite it.\n\nIf you already have a `.stylelintrc.js`, then you can extend the `.stylelintrc.js`, with `@anolilab/stylelint-config`.\n\n```js\nmodule.exports = {\n extends: [\n \"@anolilab/stylelint-config\",\n ]\n};\n```\n\nYou can also customize the rules provided in the configurations or create your own configuration that extends one of the provided configurations.\nFor more information on how to configure stylelint, see the [stylelint configuration documentation](https://stylelint.io/user-guide/configure).\n\n## Tailwind Support\n\nIs build in, so nothing to do.\n\n## Add a Package.json Script\n\nTo 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`.\n\n```sh\npnpm pkg set scripts.lint:css=\"stylelint --config=./.stylelintrc.js '**/*.{js,jsx,tsx,ts,less,css,scss,sass}'\"\npnpm pkg set scripts.lint:css:fix=\"pnpm run lint:css --fix\"\n```\n\n> For `npm` users, replace `pnpm` with `npm` in the above command.\n\nOr copy the following to your `package.json`:\n\n```json\n{\n \"scripts\": {\n \"lint:css\": \"stylelint --config=./.stylelintrc.js '**/*.{js,jsx,tsx,ts,less,css,scss,sass}'\",\n \"lint:css:fix\": \"stylelint --config=./.stylelintrc.js '**/*.{js,jsx,tsx,ts,less,css,scss,sass}' --fix\"\n }\n}\n```\n\nThis will run `stylelint` on all defined files in your app’s directory and its subdirectories.\nYou can customize the files and directories to be linted as needed.\n\n> Note: this package use `browserslist` to detect the correct browserslist config.\n\n## Configurations\n\nThe package exports the following configurations, to create your own configuration that extends one or all of the provided configurations.\n\n- `@anolilab/stylelint-config` -> all rules\n\n\n- `@anolilab/stylelint-config/a11y`\n- `@anolilab/stylelint-config/declaration-block-no-ignored-properties`\n- `@anolilab/stylelint-config/no-unsupported-browser-features`\n- `@anolilab/stylelint-config/require-units`\n- `@anolilab/stylelint-config/selector-no-empty`\n- `@anolilab/stylelint-config/standard`\n- `@anolilab/stylelint-config/tailwindcss`\n\n## Related\n\n## Supported Node.js Versions\n\nLibraries in this ecosystem make the best effort to track [Node.js’ release schedule](https://github.com/nodejs/release#release-schedule).\n\nHere’s [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).\n\n## Contributing\n\nIf you would like to help take a look at the [list of issues](https://github.com/anolilab/javascript-style-guide/issues) and check our [Contributing](.github/CONTRIBUTING.md) guidelines.\n\n> **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.\n\n## Credits\n\n- [Daniel Bannert](https://github.com/prisis)\n\n- [All Contributors](https://github.com/anolilab/javascript-style-guide/graphs/contributors)\n\n## Made with ❤️ at Anolilab\n\nThis is an open source project and will always remain free to use. If you think it’s cool, please star it 🌟. [Anolilab](https://anolilab.com/open-source) is a Development and AI Studio. Contact at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or want to say hi!\n\n## License\n\nThe anolilab stylelint-config is open-sourced software licensed under the [MIT][license-url]\n\n\n\n[license-badge]: https://img.shields.io/npm/l/@anolilab/stylelint-config?style=for-the-badge\n[license]: https://github.com/anolilab/javascript-style-guide/blob/main/LICENSE\n[npm-downloads-badge]: https://img.shields.io/npm/dm/@anolilab/stylelint-config?style=for-the-badge\n[npm-downloads]: https://www.npmjs.com/package/@anolilab/stylelint-config\n[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge\n[prs-welcome]: https://github.com/anolilab/javascript-style-guide/blob/main/.github/CONTRIBUTING.md\n[chat-badge]: https://img.shields.io/discord/902465130518949899.svg?style=for-the-badge\n[chat]: https://discord.com/invite/4VuvwWGaaB\n[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript\n[typescript-url]: https://www.typescriptlang.org/\n[license-url]: https://opensource.org/licenses/MIT\n","readmeFilename":""}
![\"stylelint-config\"](\"__assets__/package-og.svg\")
\n\n