@css-modules-kit/eslint-plugin 0.0.1 → 0.1.1

package/README.md

@@ -33,11 +33,11 @@ For vscode-eslint users, you need to add the following configuration to your `se
 ```jsonc
 // .vscode/settings.json
 {
-  "eslint.validate": ["css"],
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact", "css"],
 }
 ```
 
 ## Rules
 
-- `css-modules-kit/no-unused-class-names`
-- `css-modules-kit/no-missing-component-file`
+- [`css-modules-kit/no-unused-class-names`](https://github.com/mizdra/css-modules-kit/blob/main/packages/eslint-plugin/docs/rules/no-unused-class-names.md)
+- [`css-modules-kit/no-missing-component-file`](https://github.com/mizdra/css-modules-kit/blob/main/packages/eslint-plugin/docs/rules/no-missing-component-file.md)

package/dist/rules/no-missing-component-file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-missing-component-file.d.ts","sourceRoot":"","sources":["../../src/rules/no-missing-component-file.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAGnC,eAAO,MAAM,sBAAsB,EAAE,IAAI,CAAC,UAsBzC,CAAC"}
+{"version":3,"file":"no-missing-component-file.d.ts","sourceRoot":"","sources":["../../src/rules/no-missing-component-file.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAGnC,eAAO,MAAM,sBAAsB,EAAE,IAAI,CAAC,UA2BzC,CAAC"}

package/dist/rules/no-missing-component-file.js

@@ -10,6 +10,11 @@ exports.noMissingComponentFile = {
         messages: {
             disallow: 'The corresponding component file is not found.',
         },
+        docs: {
+            description: 'Enforce the existence of corresponding component files for CSS module files',
+            recommended: true,
+            url: 'https://github.com/mizdra/css-modules-kit/blob/main/packages/eslint-plugin/docs/rules/no-missing-component-file.md',
+        },
     },
     create(context) {
         const fileName = context.filename;

package/dist/rules/no-missing-component-file.js.map

@@ -1 +1 @@
-{"version":3,"file":"no-missing-component-file.js","sourceRoot":"","sources":["../../src/rules/no-missing-component-file.ts"],"names":[],"mappings":";;;AAAA,gDAA+E;AAE/E,wCAAsC;AAEzB,QAAA,sBAAsB,GAAoB;IACrD,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE;YACR,QAAQ,EAAE,gDAAgD;SAC3D;KACF;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAA,sBAAe,EAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QAEpE,MAAM,aAAa,GAAG,IAAA,4BAAqB,EAAC,QAAQ,EAAE,kBAAQ,CAAC,CAAC;QAEhE,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,CAAC,MAAM,CAAC;gBACb,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;gBAC3B,SAAS,EAAE,UAAU;aACtB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAC"}
+{"version":3,"file":"no-missing-component-file.js","sourceRoot":"","sources":["../../src/rules/no-missing-component-file.ts"],"names":[],"mappings":";;;AAAA,gDAA+E;AAE/E,wCAAsC;AAEzB,QAAA,sBAAsB,GAAoB;IACrD,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE;YACR,QAAQ,EAAE,gDAAgD;SAC3D;QACD,IAAI,EAAE;YACJ,WAAW,EAAE,6EAA6E;YAC1F,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,oHAAoH;SAC1H;KACF;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAA,sBAAe,EAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QAEpE,MAAM,aAAa,GAAG,IAAA,4BAAqB,EAAC,QAAQ,EAAE,kBAAQ,CAAC,CAAC;QAEhE,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,CAAC,MAAM,CAAC;gBACb,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;gBAC3B,SAAS,EAAE,UAAU;aACtB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAC"}

package/dist/rules/no-unused-class-names.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-unused-class-names.d.ts","sourceRoot":"","sources":["../../src/rules/no-unused-class-names.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAInC,eAAO,MAAM,kBAAkB,EAAE,IAAI,CAAC,UAiDrC,CAAC"}
+{"version":3,"file":"no-unused-class-names.d.ts","sourceRoot":"","sources":["../../src/rules/no-unused-class-names.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAInC,eAAO,MAAM,kBAAkB,EAAE,IAAI,CAAC,UAsDrC,CAAC"}

package/dist/rules/no-unused-class-names.js

@@ -14,6 +14,11 @@ exports.noUnusedClassNames = {
         messages: {
             disallow: '"{{className}}" is defined but never used in "{{componentFileName}}"',
         },
+        docs: {
+            description: 'Disallow unused class names in CSS module files',
+            recommended: true,
+            url: 'https://github.com/mizdra/css-modules-kit/blob/main/packages/eslint-plugin/docs/rules/no-unused-class-names.md',
+        },
     },
     create(context) {
         const fileName = context.filename;

package/dist/rules/no-unused-class-names.js.map

@@ -1 +1 @@
-{"version":3,"file":"no-unused-class-names.js","sourceRoot":"","sources":["../../src/rules/no-unused-class-names.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwH;AAExH,8EAA6C;AAC7C,wCAAsC;AAEzB,QAAA,kBAAkB,GAAoB;IACjD,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE;YACR,QAAQ,EAAE,sEAAsE;SACjF;KACF;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAA,sBAAe,EAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QAEpE,MAAM,aAAa,GAAG,IAAA,4BAAqB,EAAC,QAAQ,EAAE,kBAAQ,CAAC,CAAC;QAEhE,qHAAqH;QACrH,wGAAwG;QACxG,yCAAyC;QACzC,IAAI,aAAa,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC;QAE3C,MAAM,cAAc,GAAG,IAAA,yBAAkB,EAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAE9D,MAAM,IAAI,GAAG,IAAA,6BAAU,EAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YACtB,MAAM,EAAE,cAAc,EAAE,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,CAAC;YAE3C,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gBAC3C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5C,OAAO,CAAC,MAAM,CAAC;wBACb,GAAG,EAAE;4BACH,KAAK,EAAE;gCACL,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI;gCAClC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM;6BACvC;4BACD,GAAG,EAAE;gCACH,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI;gCAChC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM;6BACrC;yBACF;wBACD,SAAS,EAAE,UAAU;wBACrB,IAAI,EAAE;4BACJ,SAAS,EAAE,aAAa,CAAC,IAAI;4BAC7B,iBAAiB,EAAE,IAAA,eAAQ,EAAC,aAAa,CAAC,QAAQ,CAAC;yBACpD;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAC"}
+{"version":3,"file":"no-unused-class-names.js","sourceRoot":"","sources":["../../src/rules/no-unused-class-names.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwH;AAExH,8EAA6C;AAC7C,wCAAsC;AAEzB,QAAA,kBAAkB,GAAoB;IACjD,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE;YACR,QAAQ,EAAE,sEAAsE;SACjF;QACD,IAAI,EAAE;YACJ,WAAW,EAAE,iDAAiD;YAC9D,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,gHAAgH;SACtH;KACF;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,IAAA,sBAAe,EAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,CAAC;QAEpE,MAAM,aAAa,GAAG,IAAA,4BAAqB,EAAC,QAAQ,EAAE,kBAAQ,CAAC,CAAC;QAEhE,qHAAqH;QACrH,wGAAwG;QACxG,yCAAyC;QACzC,IAAI,aAAa,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC;QAE3C,MAAM,cAAc,GAAG,IAAA,yBAAkB,EAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAE9D,MAAM,IAAI,GAAG,IAAA,6BAAU,EAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YACtB,MAAM,EAAE,cAAc,EAAE,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,CAAC;YAE3C,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gBAC3C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5C,OAAO,CAAC,MAAM,CAAC;wBACb,GAAG,EAAE;4BACH,KAAK,EAAE;gCACL,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI;gCAClC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM;6BACvC;4BACD,GAAG,EAAE;gCACH,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI;gCAChC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM;6BACrC;yBACF;wBACD,SAAS,EAAE,UAAU;wBACrB,IAAI,EAAE;4BACJ,SAAS,EAAE,aAAa,CAAC,IAAI;4BAC7B,iBAAiB,EAAE,IAAA,eAAQ,EAAC,aAAa,CAAC,QAAQ,CAAC;yBACpD;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@css-modules-kit/eslint-plugin",
   "description": "A eslint plugin for CSS Modules",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "type": "commonjs",
   "sideEffects": false,
   "repository": {
@@ -37,7 +37,7 @@
     "dist"
   ],
   "dependencies": {
-    "@css-modules-kit/core": "^0.1.0",
+    "@css-modules-kit/core": "^0.2.0",
     "postcss-safe-parser": "^7.0.1"
   },
   "peerDependencies": {

package/src/rules/no-missing-component-file.ts

@@ -9,6 +9,11 @@ export const noMissingComponentFile: Rule.RuleModule = {
     messages: {
       disallow: 'The corresponding component file is not found.',
     },
+    docs: {
+      description: 'Enforce the existence of corresponding component files for CSS module files',
+      recommended: true,
+      url: 'https://github.com/mizdra/css-modules-kit/blob/main/packages/eslint-plugin/docs/rules/no-missing-component-file.md',
+    },
   },
   create(context) {
     const fileName = context.filename;

package/src/rules/no-unused-class-names.ts

@@ -10,6 +10,11 @@ export const noUnusedClassNames: Rule.RuleModule = {
     messages: {
       disallow: '"{{className}}" is defined but never used in "{{componentFileName}}"',
     },
+    docs: {
+      description: 'Disallow unused class names in CSS module files',
+      recommended: true,
+      url: 'https://github.com/mizdra/css-modules-kit/blob/main/packages/eslint-plugin/docs/rules/no-unused-class-names.md',
+    },
   },
   create(context) {
     const fileName = context.filename;