@anolilab/stylelint-config 4.0.3 → 4.0.5

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## @anolilab/stylelint-config [4.0.5](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/stylelint-config@4.0.4...@anolilab/stylelint-config@4.0.5) (2023-06-23)
+
+
+
+### Dependencies
+
+* **browserslist-config-anolilab:** upgraded to 4.0.7
+* **@anolilab/semantic-release-preset:** upgraded to 4.0.1
+
+## @anolilab/stylelint-config [4.0.4](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/stylelint-config@4.0.3...@anolilab/stylelint-config@4.0.4) (2023-06-23)
+
+
+
+### Dependencies
+
+* **@anolilab/package-json-utils:** upgraded to 1.5.0
+* **browserslist-config-anolilab:** upgraded to 4.0.6
+* **@anolilab/semantic-release-preset:** upgraded to 4.0.0
+
 ## @anolilab/stylelint-config [4.0.3](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/stylelint-config@4.0.2...@anolilab/stylelint-config@4.0.3) (2023-06-22)
 
 

package/README.md

@@ -1,8 +1,8 @@
-# Stylelint Config
+<div align="center">
 
-Stylelint config enforcing an understandable and consistent code style.
+<h1>Shareable Stylelint Config</h1>
 
-<div align="center">
+This npm package provides a set of shareable configurations for Stylelint 15+ — a linter for CSS.
 
 [![npm-image]][npm-url] [![license-image]][license-url]
 
@@ -20,17 +20,40 @@ Stylelint config enforcing an understandable and consistent code style.
 
 ---
 
+## Propose
+
+Our package offers a comprehensive collection of opinionated, yet adaptable configurations for [stylelint](https://stylelint.io/).
+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
 
 ```bash
 npm install --dev-save browserslist stylelint @anolilab/stylelint-config
 ```
 
+```sh
+pnpm add -D browserslist stylelint @anolilab/stylelint-config
+```
+
+```sh
+yarn add -D browserslist stylelint @anolilab/stylelint-config
+```
+
 ## Usage
 
-If you don’t have a `.stylelintrc.cjs`, we will create the file for you after installing `@anolilab/stylelint-config`.
+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.cjs`, then you can extend the `.stylelintrc.cjs`, with `@anolilab/stylelint-config`.
+If you already have a `.stylelintrc.js`, then you can extend the `.stylelintrc.js`, with `@anolilab/stylelint-config`.
 
 ```js
 module.exports = {
@@ -40,6 +63,11 @@ module.exports = {
 };
 ```
 
+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](https://stylelint.io/user-guide/configure).
+
+## Tailwind Support
+
 For tailwind you need to extend the stylelint rules
 
 ```js
@@ -61,17 +89,31 @@ module.exports = {
 };
 ```
 
-Add this command to your `package.json` scripts section
+## 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`.
+
+```sh
+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`:
 
 ```json
   {
     "scripts": {
-      "lint:css": "stylelint --config=./.stylelintrc.cjs '**/*.{js,jsx,tsx,ts,less,css,scss,sass}'",
-      "lint:css:fix": "stylelint --config=./.stylelintrc.cjs '**/*.{js,jsx,tsx,ts,less,css,scss,sass}' --fix"
+      "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.
 
 ## Supported Node.js Versions

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@anolilab/stylelint-config",
-    "version": "4.0.3",
+    "version": "4.0.5",
     "description": "Stylelint shareable config for the Anolilab stylesheet guide.",
     "keywords": [
         "css",
@@ -60,8 +60,8 @@
         "test:coverage": "vitest --config ./vitest.config.ts --run --coverage"
     },
     "dependencies": {
-        "@anolilab/package-json-utils": "1.4.1",
-        "browserslist-config-anolilab": "4.0.5",
+        "@anolilab/package-json-utils": "1.5.0",
+        "browserslist-config-anolilab": "4.0.7",
         "stylelint-a11y": "^1.2.3",
         "stylelint-config-rational-order": "^0.1.2",
         "stylelint-config-standard": "^33.0.0",
@@ -72,7 +72,7 @@
         "stylelint-selector-no-empty": "^1.0.9"
     },
     "devDependencies": {
-        "@anolilab/semantic-release-preset": "3.1.3",
+        "@anolilab/semantic-release-preset": "4.0.1",
         "postcss": "^8.4.24",
         "semantic-release": "^21.0.5",
         "stylelint": "15.8.0",