eslint-plugin-stratified-design 0.10.0 → 0.12.0

package/lib/rules/lower-level-imports.js

@@ -167,6 +167,8 @@ module.exports = {
     const isFileIndex = isFileIndexOfModule(options, fileDir, filePath);
 
     const report = (node) => {
+      if (node.importKind === "type") return;
+
       if (isExcludedFile) return;
 
       const { modulePath, isModuleExcluded } = createModulePath(

package/lib/rules/no-disallowed-imports.js

@@ -16,7 +16,7 @@ const { createAliases, fromCwd, match } = require("../helpers/common");
  * @typedef {import('eslint').AST.Token} Token
  * @typedef {import('eslint').SourceCode} SourceCode
  * @typedef {{
- *  import: { member: string[], from: string },
+ *  import: { member: '*' | string[], from: string },
  *  allow: string[],
  *  disallow: string[],
  * }} ImportPath
@@ -30,6 +30,8 @@ const DEFAULT = "default";
 
 const NAMESPACE = "*";
 
+const ANY_MEMBER = "*";
+
 const importSchema = {
   type: "object",
   properties: {
@@ -37,8 +39,16 @@ const importSchema = {
       type: "object",
       properties: {
         member: {
-          type: "array",
-          items: [{ type: "string" }], // 'default' means default specifier
+          oneOf: [
+            {
+              type: "array",
+              items: [{ type: "string" }], // 'default' means default specifier
+            },
+            {
+              type: "string",
+              pattern: `^[${ANY_MEMBER}]$`
+            }
+          ]
         },
         from: { type: "string" },
       },
@@ -93,7 +103,7 @@ module.exports = {
       additionalItems: false,
     },
     messages: {
-      "no-disallowed-imports": "'{{member}}' should NOT be imported",
+      "no-disallowed-imports": "{{member}} should NOT be imported from '{{from}}'",
     },
   },
   create(context) {
@@ -126,6 +136,10 @@ module.exports = {
             return [theMember, theImportSpec];
           }
 
+          if (importSpec.import.member === ANY_MEMBER) {
+            return ['Any member', importSpec]
+          }
+
           const importedSpecifiers = node.specifiers.map((specifier) => {
             if (specifier.type === "ImportSpecifier")
               return specifier.imported.name;
@@ -143,16 +157,14 @@ module.exports = {
             match(fromCwd(context.cwd, modulePath))(importSpec.import.from)
           ) {
             if (member === DEFAULT || member === NAMESPACE) {
-              return [
-                node.specifiers.find(
-                  ({ type }) =>
-                    type === "ImportDefaultSpecifier" ||
-                    type === "ImportNamespaceSpecifier"
-                ).local.name,
-                importSpec,
-              ];
+              const theMember = node.specifiers.find(
+                ({ type }) =>
+                  type === "ImportDefaultSpecifier" ||
+                  type === "ImportNamespaceSpecifier"
+              ).local.name
+              return [`'${theMember}'`, importSpec];
             }
-            return [member, importSpec];
+            return [`'${member}'`, importSpec];
           }
 
           return [undefined, undefined];
@@ -174,7 +186,7 @@ module.exports = {
         context.report({
           node,
           messageId: "no-disallowed-imports",
-          data: { member: theMember },
+          data: { member: theMember, from: theImportSpec.import.from },
         });
       },
     };

package/lib/rules/stratified-imports.js

@@ -124,6 +124,8 @@ module.exports = {
      * @returns
      */
     const report = (node) => {
+      if (node.importKind === "type") return;
+
       if (!isStructureValid) {
         reportError(node, "invalid-json");
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-stratified-design",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "ESlint rules for stratified design",
   "keywords": [
     "eslint",
@@ -27,6 +27,7 @@
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
+    "@typescript-eslint/parser": "^7.1.0",
     "eslint": "^8.19.0",
     "eslint-plugin-eslint-plugin": "^5.0.0",
     "eslint-plugin-node": "^11.1.0",

package/tests/lib/rules/lower-level-imports.js

@@ -9,7 +9,8 @@
 //------------------------------------------------------------------------------
 
 const rule = require("../../../lib/rules/lower-level-imports"),
-  RuleTester = require("eslint").RuleTester;
+  RuleTester = require("eslint").RuleTester,
+  path = require("path");
 
 //------------------------------------------------------------------------------
 // Tests
@@ -28,7 +29,10 @@ const structure = [
 ];
 
 const ruleTester = new RuleTester({
-  parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+  parser: path.resolve(
+    "./node_modules/@typescript-eslint/parser/dist/parser.js"
+  ),
+  parserOptions: { ecmaVersion: "latest", sourceType: "module" },
 });
 
 ruleTester.run("lower-level-imports", rule, {
@@ -232,6 +236,11 @@ ruleTester.run("lower-level-imports", rule, {
       filename: "./src/layer1/subLayer2.js",
       options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
     },
+    {
+      code: "import type { SomeType } from '@/layer2/subLayer2'",
+      filename: "./src/layer1/subLayer2.js",
+      options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
+    },
   ],
   invalid: [
     {

package/tests/lib/rules/no-disallowed-imports.js

@@ -131,6 +131,34 @@ ruleTester.run("no-disallowed-imports", rule, {
         },
       ],
     },
+    {
+      code: "import { anyMember } from './fileA'",
+      filename: "./src/fileB.js",
+      options: [
+        {
+          imports: [
+            {
+              import: { member: "*", from: "src/fileA" },
+              allow: ["src/**/*.js"],
+            },
+          ],
+        },
+      ],
+    },
+    {
+      code: "import * as namespace from './fileA'",
+      filename: "./src/fileB.js",
+      options: [
+        {
+          imports: [
+            {
+              import: { member: "*", from: "src/fileA" },
+              allow: ["src/**/*.js"],
+            },
+          ],
+        },
+      ],
+    },
   ],
   invalid: [
     {
@@ -146,7 +174,7 @@ ruleTester.run("no-disallowed-imports", rule, {
           ],
         },
       ],
-      errors: [{ messageId: "no-disallowed-imports", data: { member: "foo" } }],
+      errors: [{ messageId: "no-disallowed-imports", data: { member: "'foo'", from: "src/fileA" } }],
     },
     {
       code: "import { foo } from './fileA'",
@@ -161,7 +189,7 @@ ruleTester.run("no-disallowed-imports", rule, {
           ],
         },
       ],
-      errors: [{ messageId: "no-disallowed-imports", data: { member: "foo" } }],
+      errors: [{ messageId: "no-disallowed-imports", data: { member: "'foo'", from: "src/fileA" } }],
     },
     {
       code: "import { foo } from './fileA'",
@@ -177,7 +205,7 @@ ruleTester.run("no-disallowed-imports", rule, {
           ],
         },
       ],
-      errors: [{ messageId: "no-disallowed-imports", data: { member: "foo" } }],
+      errors: [{ messageId: "no-disallowed-imports", data: { member: "'foo'", from: "src/fileA" } }],
     },
     {
       code: "import foo from './fileA'",
@@ -192,7 +220,7 @@ ruleTester.run("no-disallowed-imports", rule, {
           ],
         },
       ],
-      errors: [{ messageId: "no-disallowed-imports", data: { member: "foo" } }],
+      errors: [{ messageId: "no-disallowed-imports", data: { member: "'foo'", from: "src/fileA" } }],
     },
     {
       code: "import * as name from './fileA'",
@@ -208,7 +236,24 @@ ruleTester.run("no-disallowed-imports", rule, {
         },
       ],
       errors: [
-        { messageId: "no-disallowed-imports", data: { member: "name" } },
+        { messageId: "no-disallowed-imports", data: { member: "'name'", from: "src/fileA" } },
+      ],
+    },
+    {
+      code: "import { anyMember } from './fileA'",
+      filename: "./src/fileB.js",
+      options: [
+        {
+          imports: [
+            {
+              import: { member: "*", from: "src/fileA" },
+              disallow: ["src/**/*.js"],
+            },
+          ],
+        },
+      ],
+      errors: [
+        { messageId: "no-disallowed-imports", data: { member: "Any member", from: "src/fileA" } },
       ],
     },
   ],

package/tests/lib/rules/stratified-imports.js

@@ -10,6 +10,7 @@
 
 const rule = require("../../../lib/rules/stratified-imports");
 const RuleTester = require("eslint").RuleTester;
+const path = require("path");
 
 //------------------------------------------------------------------------------
 // Tests
@@ -57,7 +58,10 @@ const RuleTester = require("eslint").RuleTester;
 */
 
 const ruleTester = new RuleTester({
-  parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+  parser: path.resolve(
+    "./node_modules/@typescript-eslint/parser/dist/parser.js"
+  ),
+  parserOptions: { ecmaVersion: "latest", sourceType: "module" },
 });
 
 ruleTester.run("stratified-imports", rule, {
@@ -162,6 +166,11 @@ ruleTester.run("stratified-imports", rule, {
       filename: "./mocked/stratified-imports/layerA.js",
       options: [{ aliases: { "@/": "./mocked/stratified-imports/" } }],
     },
+    {
+      code: "import type { SomeType } from './layerA'",
+      filename: "./mocked/stratified-imports/layerB.js",
+      options: [],
+    },
   ],
   invalid: [
     {