README.md

@yikoyu/stylelint-config

➡️ Extendable Stylelint configuration, part of the yikoyu/unconfig 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 @yikoyu/stylelint-config

2. If using pnpm, please add configuration to the .npmrc file.

   public-hoist-pattern[]=*stylelint*
   public-hoist-pattern[]=postcss*
   

3. Create a stylelint configuration file - stylelint.config.(js|cjs|.mjs).

4. Extend this module package configuration.

   import { yikoyu } from '@yikoyu/stylelint-config'
   
   export default yikoyu()

📖 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-recess-order		order as dependency
stylelint-config-recommended-vue		vue as dependency
stylelint-config-standard		NO sass as dependency
stylelint-config-standard-scss		sass as dependency

License

⚖️ For more information, please refer to the License section at the root of the yikoyu/unconfig monorepo.

---

Resources

• Awesome Stylelint