Add @css-modules-kit/stylelint-plugin/config (#148)

* chore: update stylelint

* chore: update example

* feat: add `@css-modules-kit/stylelint-plugin/config`

* chore: update stylelint-plugin README

* chore: add changelog

Author: mizdra

.changeset/gentle-crews-bow.md

@@ -0,0 +1,5 @@
+---
+'@css-modules-kit/stylelint-plugin': minor
+---
+
+feat: add `@css-modules-kit/stylelint-plugin/config`

example/src/b.module.css

@@ -1,2 +1,2 @@
-.b_1 { color: red; }
+.b_1 { color: red; composes: b_2; }
 @value b_2: red;

example/stylelint.config.js

@@ -1,8 +1,8 @@
 /** @type {import('stylelint').Config} */
 export default {
-  plugins: ['@css-modules-kit/stylelint-plugin'],
+  extends: ['@css-modules-kit/stylelint-plugin/config'],
   rules: {
-    'css-modules-kit/no-unused-class-names': true,
-    'css-modules-kit/no-missing-component-file': true,
+    'at-rule-no-unknown': true,
+    'property-no-unknown': true,
   },
 };

package-lock.json

@@ -43,7 +43,7 @@
     "eslint": "^9.22.0",
     "npm-run-all2": "^7.0.2",
     "prettier": "^3.5.3",
-    "stylelint": "^16.15.0",
+    "stylelint": "^16.17.0",
     "typescript": "^5.8.2",
     "vitest": "^3.0.8"
   }

package.json

@@ -14,11 +14,7 @@ npm i -D @css-modules-kit/stylelint-plugin
 // stylelint.config.js
 /** @type {import('stylelint').Config} */
 export default {
-  plugins: ['@css-modules-kit/stylelint-plugin'],
-  rules: {
-    'css-modules-kit/no-unused-class-names': true,
-    'css-modules-kit/no-missing-component-file': true,
-  },
+  extends: ['@css-modules-kit/stylelint-plugin/config'],
 };
 ```
 

packages/stylelint-plugin/README.md

@@ -12,7 +12,20 @@
   "author": "mizdra <[email protected]>",
   "license": "MIT",
   "private": false,
-  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./config": {
+      "import": {
+        "types": "./dist/config.d.ts",
+        "default": "./dist/config.js"
+      }
+    }
+  },
   "scripts": {
     "build": "tsc -b tsconfig.build.json"
   },

packages/stylelint-plugin/package.json

@@ -0,0 +1,45 @@
+import type { Config } from 'stylelint';
+
+const config: Config = {
+  plugins: ['@css-modules-kit/stylelint-plugin'],
+  languageOptions: {
+    syntax: {
+      atRules: {
+        value: {
+          // Example:
+          // - `@value a: #123;`
+          // - `@value empty:;`
+          // - `@value withoutSemicolon #123;`
+          // - `@value a from './test.module.css';`
+          // - `@value a, b from './test.module.css';`
+          // - `@value a as aliased_a from './test.module.css';`
+          //
+          // CSS Modules Kit does not support the following for implementation simplicity:
+          // - `@value (a, b) from '...';`
+          // - `@value a from moduleName;`
+          //
+          // ref: https://github.com/css-modules/postcss-icss-values/blob/acdf34a62cc2537a9507b1e9fd34db486e5cb0f8/test/test.js
+          prelude:
+            '<custom-ident> :? <declaration-value>? | [ [ <custom-ident> [ as <custom-ident> ]? ]# from <string> ]',
+        },
+      },
+      properties: {
+        // Example:
+        // - `composes: a;`
+        // - `composes: a from './test.module.css';`
+        // - `composes: a, b from './test.module.css';`
+        // - `composes: a b from './test.module.css';`
+        // - `composes: global(a) from './test.module.css';`
+        //
+        // ref: https://github.com/css-modules/postcss-modules-extract-imports/blob/16f9c570e517cf3558b88cf96dcadf794230965a/src/index.js
+        composes: '[ [ <custom-ident> | global(<custom-ident>) ] ,? ]+ [ from <string> ]?',
+      },
+    },
+  },
+  rules: {
+    'css-modules-kit/no-unused-class-names': true,
+    'css-modules-kit/no-missing-component-file': true,
+  },
+};
+
+export = config;