eslint-plugin-strict-dependencies 0.0.1 → 1.0.1

package/README.md

@@ -1,6 +1,8 @@
 # eslint-plugin-strict-dependencies
 
-NOTE: eslint-plugin-strict-dependencies uses tsconfig, tsconfig.json must be present.
+ESlint plugin to define custom module dependency rules.
+
+NOTE: `eslint-plugin-strict-dependencies` uses tsconfig, tsconfig.json must be present.
 
 ## Installation
 
@@ -16,7 +18,18 @@ npm install eslint-plugin-strict-dependencies --save-dev
   - allowReferenceFrom: `string[]` (Glob or Forward matching string)
     - Paths of files where target module imports are allowed.
   - allowSameModule: `boolean`
-    - Whether or not the target module itself can import on the target module
+    - Whether it can be imported by other files in the same directory
+
+### Options
+
+- resolveRelativeImport: `boolean[default = false]`
+  - Whether to resolve relative import as in the following example
+  - `src/components/aaa.ts`
+    ```typescript
+    import bbb from './bbb';
+    ```
+     - `resolveRelativeImport = false`: Resolve as `./bbb` (excluded from lint target)
+     - `resolveRelativeImport = true`:  Resolve as `src/components/bbb`: (included from lint target)
 
 ## Usage
 
@@ -31,8 +44,8 @@ npm install eslint-plugin-strict-dependencies --save-dev
     "error",
     [
       /**
-       * example:
-       * Components only allow dependencies in the following directions
+       * Example:
+       * Limit the dependencies in the following directions
        * pages -> components/page -> components/ui
        */
       {
@@ -50,7 +63,7 @@ npm install eslint-plugin-strict-dependencies --save-dev
 
       /**
        * example:
-       * Don't import next/router directly, always import it through libs/router.
+       * Disallow to import `next/router` directly. it should always be imported using `libs/router.ts`.
        */
       {
         "module": "next/router",
@@ -58,7 +71,11 @@ npm install eslint-plugin-strict-dependencies --save-dev
         "allowSameModule": false
       },
     ],
-  ],
+    // options
+    // {
+    //   "resolveRelativeImport": true
+    // }
+  ]
 }
 
 ```
@@ -66,4 +83,4 @@ npm install eslint-plugin-strict-dependencies --save-dev
 
 ## License
 
-MIT
+MIT

package/package.json

@@ -1,15 +1,38 @@
 {
   "name": "eslint-plugin-strict-dependencies",
-  "description": "Restrict imports between files according to the configured dependency rules.",
-  "version": "0.0.1",
+  "description": "ESlint plugin to define custom module dependency rules.",
+  "version": "1.0.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/knowledge-work/eslint-plugin-strict-dependencies.git"
   },
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "lint",
+    "rule",
+    "check",
+    "import",
+    "module",
+    "directory",
+    "strict",
+    "dependencies"
+  ],
   "license": "MIT",
   "main": "index.js",
   "files": [
     "strict-dependencies",
     "index.js"
-  ]
+  ],
+  "dependencies": {
+    "is-glob": "^4.0.3",
+    "micromatch": "^4.0.4",
+    "require-strip-json-comments": "^2.0.0"
+  },
+  "devDependencies": {
+    "jest": "^27.2.4"
+  },
+  "scripts": {
+    "test": "jest --coverage"
+  }
 }

package/strict-dependencies/index.js

@@ -43,15 +43,25 @@ module.exports = {
           },
         ],
       },
+      {
+        type: 'object',
+        properties: {
+          resolveRelativeImport: {
+            type: 'boolean',
+          }
+        },
+      },
     ],
   },
   create: (context) => {
     const dependencies = context.options[0]
+    const options = context.options.length > 1 ? context.options[1] : {}
+    const resolveRelativeImport = options.resolveRelativeImport
 
     function checkImport(node) {
       const fileFullPath = context.getFilename()
       const relativeFilePath = path.relative(process.cwd(), fileFullPath)
-      const importPath = resolveImportPath(node.source.value)
+      const importPath = resolveImportPath(node.source.value, resolveRelativeImport ? relativeFilePath : null)
 
       dependencies
         .filter((dependency) => isMatch(importPath, dependency.module))
@@ -64,7 +74,7 @@ module.exports = {
             (dependency.allowSameModule && isMatch(relativeFilePath, dependency.module))
 
           if (!isAllowed) {
-            context.report(node, `import '${importPath}' is not allowed from ${dependency.module}.`)
+            context.report(node, `import '${importPath}' is not allowed from ${relativeFilePath}.`)
           }
         })
     }

package/strict-dependencies/resolveImportPath.js

@@ -1,31 +1,35 @@
 /* eslint-disable */
 
-const fs = require('fs')
 const path = require('path')
+const parseJSON = require('require-strip-json-comments')
 
 /**
  * import文のrootからのパスを求める
  */
-module.exports = (importPath) => {
+module.exports = (importPath, relativeFilePath) => {
   // { [importAlias: string]: OriginalPath }
   const importAliasMap = {}
 
   // Load tsconfig option
   // MEMO: tscとか使って簡単に読める方法がありそう
   try {
-    const tsConfigFile = fs.readFileSync(path.join(process.cwd(), '/tsconfig.json'), 'utf-8')
+    const tsConfigFilePath = path.join(process.cwd(), '/tsconfig.json')
     // Exists ts config
-    const tsConfig = JSON.parse(tsConfigFile)
+    const tsConfig = parseJSON(tsConfigFilePath)
     if (tsConfig.compilerOptions && tsConfig.compilerOptions.paths) {
       Object.keys(tsConfig.compilerOptions.paths).forEach((key) => {
         // FIXME: このlint ruleではimport先が存在するかチェックしておらず、複数のパスから正しい方を選択できないため[0]固定
-        importAliasMap[key] = tsConfig.compilerOptions.paths[key][0]
+        importAliasMap[key] = tsConfig.compilerOptions.baseUrl ? path.join(tsConfig.compilerOptions.baseUrl, tsConfig.compilerOptions.paths[key][0]) : tsConfig.compilerOptions.paths[key][0]
       })
     }
   } catch (e) {
     // DO NOTHING
   }
 
+  if (relativeFilePath && (importPath.startsWith('./') || importPath.startsWith('../'))) {
+    importPath = path.join(path.dirname(relativeFilePath), importPath)
+  }
+
   return Object.keys(importAliasMap).reduce((resolvedImportPath, key) => {
     // FIXME: use glob module instead of replace('*')
     return resolvedImportPath.replace(key.replace('*', ''), importAliasMap[key].replace('*', ''))