eslint-plugin-strict-dependencies 1.1.0 → 1.2.1

package/README.md

@@ -1,6 +1,6 @@
 # eslint-plugin-strict-dependencies
 
-ESlint plugin to define custom module dependency rules.
+ESLint plugin to define custom module dependency rules.
 
 NOTE: `eslint-plugin-strict-dependencies` uses tsconfig, tsconfig.json must be present.
 
@@ -14,7 +14,10 @@ npm install eslint-plugin-strict-dependencies --save-dev
 
 - strict-dependencies
   - module: `string` (Glob or Forward matching string)
-    - target module path
+    - Target module path
+  - targetMembers: `string[]`
+    - Target member name
+    - e.x. `["Suspense"]` in `import { Suspense } from 'react'`
   - allowReferenceFrom: `string[]` (Glob or Forward matching string)
     - Paths of files where target module imports are allowed.
   - allowSameModule: `boolean`
@@ -84,6 +87,17 @@ npm install eslint-plugin-strict-dependencies --save-dev
         "allowReferenceFrom": ["src/libs/router.ts"],
         "allowSameModule": false
       },
+
+      /**
+       * example:
+       * Disallow to import Suspense from react. it should always be imported using `libs/react.ts`.
+       */
+        {
+            "module": "react",
+            "targetMembers": ["Suspense"],
+            "allowReferenceFrom": ["src/libs/react.ts"],
+            "allowSameModule": false
+        },
     ],
     // options
     // {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-strict-dependencies",
   "description": "ESlint plugin to define custom module dependency rules.",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/knowledge-work/eslint-plugin-strict-dependencies.git"
@@ -25,13 +25,13 @@
     "index.js"
   ],
   "dependencies": {
-    "is-glob": "^4.0.3",
-    "micromatch": "^4.0.4",
-    "normalize-path": "^3.0.0",
-    "require-strip-json-comments": "^2.0.0"
+    "is-glob": "4.0.3",
+    "micromatch": "4.0.5",
+    "normalize-path": "3.0.0",
+    "require-strip-json-comments": "2.0.0"
   },
   "devDependencies": {
-    "jest": "^27.2.4"
+    "jest": "29.6.2"
   },
   "scripts": {
     "test": "jest --coverage",

package/strict-dependencies/index.js

@@ -68,19 +68,42 @@ module.exports = {
       const relativeFilePath = normalize(path.relative(process.cwd(), fileFullPath))
       const importPath = resolveImportPath(node.source.value, resolveRelativeImport ? relativeFilePath : null, pathIndexMap)
 
+      // specにはImportDefaultSpecifier/ImportNamespaceSpecifier/ImportSpecifierがあり、ImportSpecifierの場合はimportedが存在する
+      const importedModules = node.specifiers.filter(spec => 'imported' in spec).map(spec => spec.imported.name)
+
       dependencies
-        .filter((dependency) => isMatch(importPath, dependency.module))
         .forEach((dependency) => {
-          const isAllowed =
-            // 参照元が許可されている
-            dependency.allowReferenceFrom.some((allowPath) =>
-              isMatch(relativeFilePath, allowPath),
-            ) || // または同一モジュール間の参照が許可されている場合
-            (dependency.allowSameModule && isMatch(relativeFilePath, dependency.module))
+          // そもそもmoduleがimportPathと一致していない場合は必ず報告しない
+          if (!isMatch(importPath, dependency.module)) return;
+
+          /**
+           * 1. 参照元チェックをしてAllowであればそこで処理を終了する
+           * 2. targetMembersが指定されていれば、targetMembersと実際にimportしているモジュールを比較して含まれていればエラーレポートして処理を終了する
+           * 3. targetMembersが指定されていない場合は、エラー扱いなのでエラーレポートして処理を終了する
+           */
+
+          const isAllowedByPath =
+          // 参照元が許可されている
+          dependency.allowReferenceFrom.some((allowPath) =>
+            isMatch(relativeFilePath, allowPath),
+          ) || // または同一モジュール間の参照が許可されている場合
+          (dependency.allowSameModule && isMatch(relativeFilePath, dependency.module))
 
-          if (!isAllowed) {
-            context.report(node, `import '${importPath}' is not allowed from ${relativeFilePath}.`)
+          if (isAllowedByPath) return
+
+          // importedされた値・型名もLintのターゲットに入っている場合の検出処理
+          function getCommonElements(arrA, arrB) {
+            return arrA.filter(element => arrB.includes(element));
+          }
+          if (dependency.targetMembers && Array.isArray(dependency.targetMembers)) {
+            const commonImportedList = getCommonElements(dependency.targetMembers, importedModules)
+            if (commonImportedList.length > 0) {
+              context.report(node, `import specifier '${commonImportedList.join(', ')}' is not allowed from ${relativeFilePath}.`)
+            }
+            return;
           }
+
+          context.report(node, `import '${importPath}' is not allowed from ${relativeFilePath}.`)
         })
     }