@purpurds/eslint-plugin-purpur 6.9.0 → 6.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@purpurds/eslint-plugin-purpur",
-  "version": "6.9.0",
+  "version": "6.10.0",
   "main": "src/index.js",
   "files": [
     "index.js",
@@ -10,16 +10,17 @@
   ],
   "dependencies": {
     "requireindex": "~1.2.0",
-    "@purpurds/purpur": "6.9.0"
+    "@purpurds/purpur": "6.10.0"
   },
   "devDependencies": {
     "@types/node": "20.12.12",
     "eslint-config-prettier": "~8.10.0",
     "eslint-plugin-prettier": "~3.4.1",
-    "eslint": "^8.57.0",
-    "lint-staged": "~10.5.3",
+    "eslint": "9.24.0",
+    "lint-staged": "15.5.0",
     "mocha": "~10.2.0",
-    "prettier": "~2.8.8"
+    "prettier": "~2.8.8",
+    "@purpurds/component-rig": "1.0.0"
   },
   "peerDependencies": {
     "eslint": ">=8"

package/readme.md

@@ -8,8 +8,20 @@ rush: `rush add -p @purpurds/eslint-plugin-purpur --dev`
 
 npm: `npm i @purpurds/eslint-plugin-purpur`
 
-## Basic usage
 
+## Flat config 
+```ts
+import purpurPlugin from "@purpurds/eslint-plugin-purpur"
+
+export default [
+  {
+    files: ["**/*.ts?(x)"],  
+    ...purpurPlugin.configs["recommended-flat"],
+  }
+]
+```
+
+## Legacy config
 ```js
 // eslint <= 8
 module.exports = {
@@ -19,33 +31,30 @@ module.exports = {
 
 ## Custom usage
 
-Available rules:
-
-- `no-barrel-imports`
-
-```js
-// eslint <= 8
-module.exports = {
-  plugins: ["@purpurds/purpur"],
-  rules: {
-    "@purpurds/purpur/[RULE_NAME]": "error" | "warn",
-  },
-};
-```
-
-```js
-// eslint >= 9
-import purpur from "@purpur/eslint-plugin-purpur";
+### Flat config
+```ts
+import purpurPlugin from "@purpur/eslint-plugin-purpur";
 
 export default [
   {
-    files: ["**/*.js"],
+    files: ["**/*.ts?(x)"],  
     plugins: {
-      purpur: purpur,
+      purpur: purpurPlugin,
     },
     rules: {
-      "purpur/no-barrel-imports": "error",
+      "purpur/no-barrel-imports-flat": "error",
     },
   },
 ];
 ```
+
+### Legacy config
+```js
+// eslint <= 8
+module.exports = {
+  plugins: ["@purpurds/purpur"],
+  rules: {
+    "@purpurds/purpur/no-barrel-imports": "error" | "warn",
+  },
+};
+```

package/src/configs/recommended-flat.js

@@ -0,0 +1,7 @@
+// @ts-check
+module.exports = {
+  plugins: ["@purpurds/purpur"],
+  rules: {
+    "@purpurds/purpur/no-barrel-imports-flat": "error",
+  },
+};

package/src/rules/no-barrel-imports-flat.js

@@ -0,0 +1,96 @@
+// eslint-plugin-no-barrel-import.js
+const { toKebabCase } = require("../internal/utils");
+const componentsMetadata = require("@purpurds/purpur/components-metadata");
+
+const exportToModuleMap = new Map(
+  componentsMetadata.flatMap((metadata) =>
+    metadata.exports.map((exportName) => [exportName, metadata.moduleName])
+  )
+);
+
+const isValidImport = (moduleName, node) => {
+  if (node.source.value === `@purpurds/purpur/${moduleName}`) {
+    const metadata = componentsMetadata.find(
+      (componentMetadata) => componentMetadata.moduleName === moduleName
+    );
+    return node.specifiers.every((specifier) => metadata.exports.includes(specifier.imported.name));
+  }
+
+  return false;
+};
+
+const invalidBarrelImports = [
+  "@purpurds/purpur",
+  "@purpurds/purpur/icon",
+  "@purpurds/purpur/illustrative-icon",
+];
+
+module.exports = {
+  rules: {
+    "no-barrel-import": {
+      meta: {
+        type: "problem",
+        docs: {
+          description: "Disallows imports from barrel files in '@purpurds/purpur'",
+          category: "Best Practices",
+          recommended: true,
+        },
+        messages: {
+          noBarrelImport: `Bad purpur import, do not import directly from {{wrongImport}}. Do this instead:\n\n{{correctImport}}\n\n`,
+        },
+        fixable: "code",
+        schema: [],
+      },
+      create: (context) => ({
+        ImportDeclaration(node) {
+          if (
+            invalidBarrelImports.includes(node.source.value) &&
+            !isValidImport("icon", node) &&
+            !isValidImport("illustrative-icon", node)
+          ) {
+            const importsByModule = new Map();
+
+            node.specifiers.forEach((specifier) => {
+              const importName = specifier.imported.name;
+              const localName = specifier.local.name;
+              const moduleName = exportToModuleMap.get(importName) || toKebabCase(importName);
+
+              if (!importsByModule.has(moduleName)) {
+                importsByModule.set(moduleName, []);
+              }
+              importsByModule.get(moduleName).push({ importName, localName });
+            });
+
+            const importsSortedByModuleName = Array.from(importsByModule.entries())
+              .sort(([a], [b]) => a.localeCompare(b))
+              .map(([moduleName, importNames]) => [
+                moduleName,
+                importNames.sort((a, b) => a.importName.localeCompare(b.importName)),
+              ]);
+
+            const correctImport = importsSortedByModuleName
+              .map(
+                ([moduleName, importNames]) =>
+                  `import { ${importNames
+                    .map(({ importName, localName }) =>
+                      importName === localName ? importName : `${importName} as ${localName}`
+                    )
+                    .join(", ")} } from "@purpurds/purpur/${moduleName}";`
+              )
+              .join("\n");
+
+            context.report({
+              node,
+              messageId: "noBarrelImport",
+              data: {
+                correctImport,
+                wrongImport: node.source.value,
+              },
+              fix: (fixer) => fixer.replaceText(node, correctImport),
+            });
+          }
+        },
+      }),
+    },
+  },
+};