@terminal-nerds/stylelint-config

➡️ Extendable Stylelint configuration, part of the terminal-nerds/configs project.

Prerequisites

ℹ️ This configuration package require these tools to use locally on your device(s):

1. Latest Node.js LTS (Long-Term Support) version
2. One of Node.js package managers:
   • pnpm
   • yarn
   • npm
3. Latest Stylelint version

Basic usage

👣 Follow the steps below:

1. Install it with the Node.js package manager of your choice (in our case, we use pnpm).

    pnpm install --save-dev stylelint @terminal-nerds/stylelint-config

2. Create a stylelint configuration file - .stylelintrc.(c)js.

3. Extend this module package configuration.

   /** @type {import("stylelint").Config} */
   const config = {
   	extends: "@terminal-nerds/stylelint-config",
   };
   
   module.exports = config;

📖 For the Stylelint CLI usage, please refer to its documentation.

Used configurations & plugins

⚙️ This configuration module for Stylelint loads configurations and plugins options conditionally.

Configurations

| Configurations | Version | Loading condition(s) | | -------------------------------- | ----------------------------------------------- | --------------------------- | | stylelint-config-prettier | | prettier as dependency | | stylelint-config-standard | | NO sass as dependency | | stylelint-config-standard-scss | | sass as dependency | | stylelint-config-tailwindcss | | tailwindcss as dependency |

Plugins

| Plugin | Version | Loading condition(s) | | ------------------------------------------- | ---------------------------------------------------------- | -------------------- | | stylelint-css-modules | | - | | stylelint-high-performance-animation | | - | | stylelint-no-unsupported-browser-features | | - | | stylelint-order | | - | | stylelint-scss | | sass as dependency |

Security

🔐 For more information, please refer to the Security section at the root of the terminal-nerds/configs monorepo.

Contributing

🤝 Contributions of any kind are welcome!

Please refer to the monorepo (terminal-nerds/configs) project's CONTRIBUTING file for more information if you wish to get involved.

License

⚖️ For more information, please refer to the License section at the root of the terminal-nerds/configs monorepo.

Resources

• Awesome Stylelint