Added new option 'allowTypeImport' (#50)

* feat: added option to allow type import

* test: add allowTypeImport test

* docs: add allowTypeImport

* Update __tests__/index.js

Co-authored-by: よしこ <[email protected]>

* Update strict-dependencies/index.js

Co-authored-by: よしこ <[email protected]>

* fix: #50 (review)

---------

Co-authored-by: よしこ <[email protected]>

Author: keyiiiii

README.md

@@ -22,6 +22,9 @@ npm install eslint-plugin-strict-dependencies --save-dev
     - Paths of files where target module imports are allowed.
   - allowSameModule: `boolean`
     - Whether it can be imported by other files in the same directory
+  - excludeTypeImportChecks: `boolean`
+    - Whether to exclude type import checks
+    - e.x. `import type { Suspense } from 'react'`
 
 ### Options
 
@@ -75,7 +78,9 @@ npm install eslint-plugin-strict-dependencies --save-dev
         "module": "src/components/ui",
         "allowReferenceFrom": ["src/components/page"],
         // components/ui can import other components/ui
-        "allowSameModule": true
+        "allowSameModule": true,
+        // components/ui exclude type import checks
+        "excludeTypeImportChecks": true
       },
 
       /**

__tests__/index.js

@@ -79,6 +79,11 @@ const mockImportDeclaration = {
   },
 };
 
+const mockImportDeclarationImportKindType = {
+  importKind: 'type',
+  ...mockImportDeclaration
+};
+
 describe('create', () => {
   it('should return object', () => {
     const created = create({options: [[]]})
@@ -455,4 +460,31 @@ describe('create.ImportDeclaration', () => {
     expect(getFilename).toBeCalledTimes(1)
     expect(report).not.toBeCalled()
   })
+
+  it('should not report if excludeTypeImportChecks is true', () => {
+    resolveImportPath.mockReturnValue('src/components/ui/Text')
+    const getFilename = jest.fn(() =>
+      path.join(process.cwd(), 'src/pages/index.tsx')
+    )
+    const report = jest.fn()
+    const { ImportDeclaration: checkImport } = create({
+      options: [
+        [
+          {
+            module: 'src/components/ui',
+            allowReferenceFrom: ['src/aaa'],
+            allowSameModule: false,
+            excludeTypeImportChecks: true,
+          },
+        ],
+      ],
+      getFilename,
+      report,
+    })
+
+    checkImport(mockImportDeclarationImportKindType)
+
+    expect(getFilename).toBeCalledTimes(1)
+    expect(report).not.toBeCalled()
+  })
 })

strict-dependencies/index.js

@@ -40,6 +40,9 @@ module.exports = {
               allowSameModule: {
                 type: 'boolean',
               },
+              excludeTypeImportChecks: {
+                type: 'boolean'
+              }
             },
           },
         ],
@@ -88,6 +91,8 @@ module.exports = {
             isMatch(relativeFilePath, allowPath),
           ) || // または同一モジュール間の参照が許可されている場合
           (dependency.allowSameModule && isMatch(relativeFilePath, dependency.module))
+          // または明示的に対象外としたtype importである場合
+          || (dependency.excludeTypeImportChecks && node.importKind === 'type')
 
           if (isAllowedByPath) return