diff --git a/docs/rules/no-restricted-paths.md b/docs/rules/no-restricted-paths.md index bfcb9af23..b3cf36232 100644 --- a/docs/rules/no-restricted-paths.md +++ b/docs/rules/no-restricted-paths.md @@ -8,8 +8,10 @@ In order to prevent such scenarios this rule allows you to define restricted zon ## Rule Details This rule has one option. The option is an object containing the definition of all restricted `zones` and the optional `basePath` which is used to resolve relative paths within. -The default value for `basePath` is the current working directory. -Each zone consists of the `target` path and a `from` path. The `target` is the path where the restricted imports should be applied. The `from` path defines the folder that is not allowed to be used in an import. An optional `except` may be defined for a zone, allowing exception paths that would otherwise violate the related `from`. Note that `except` is relative to `from` and cannot backtrack to a parent directory. +It may also specify an `allowedImportKinds`. +The default value for `basePath` is the current working directory and the default value for `allowedImportKinds` is an empty array. + +Each zone consists of the `target` path and a `from` path. The `target` is the path where the restricted imports should be applied. The `from` path defines the folder that is not allowed to be used in an import. An optional `except` may be defined for a zone, allowing exception paths that would otherwise violate the related `from`. Note that `except` is relative to `from` and cannot backtrack to a parent directory. Additionally an override of `allowedImportKinds` can be given for each zone. You may also specify an optional `message` for a zone, which will be displayed in case of the rule violation. ### Examples @@ -64,7 +66,8 @@ and the current configuration is set to: "target": "./tests/files/restricted-paths/server/one", "from": "./tests/files/restricted-paths/server", "except": ["./one"] -} ] } +} ], +"allowedImportKinds": ["type"] } ``` The following pattern is considered a problem: @@ -73,8 +76,12 @@ The following pattern is considered a problem: import a from '../two/a' ``` -The following pattern is not considered a problem: +The following patterns are not considered a problem: ```js import b from './b' ``` + +```ts +import type T from '../two/a' +``` diff --git a/src/rules/no-restricted-paths.js b/src/rules/no-restricted-paths.js index a94b11ec1..73ee10a52 100644 --- a/src/rules/no-restricted-paths.js +++ b/src/rules/no-restricted-paths.js @@ -6,6 +6,14 @@ import isStaticRequire from '../core/staticRequire' import docsUrl from '../docsUrl' import importType from '../core/importType' +const allowedImportKindsSchema = { + type: 'array', + items: { + type: 'string', + }, + uniqueItems: true, +} + module.exports = { meta: { type: 'problem', @@ -32,12 +40,14 @@ module.exports = { }, uniqueItems: true, }, + allowedImportKinds: allowedImportKindsSchema, message: { type: 'string' }, }, additionalProperties: false, }, }, basePath: { type: 'string' }, + allowedImportKinds: allowedImportKindsSchema, }, additionalProperties: false, }, @@ -48,6 +58,7 @@ module.exports = { const options = context.options[0] || {} const restrictedPaths = options.zones || [] const basePath = options.basePath || process.cwd() + const allowedImportKinds = options.allowedImportKinds || [] const currentFilename = context.getFilename() const matchingZones = restrictedPaths.filter((zone) => { const targetPath = path.resolve(basePath, zone.target) @@ -68,8 +79,8 @@ module.exports = { }) } - function checkForRestrictedImportPath(importPath, node) { - const absoluteImportPath = resolve(importPath, context) + function checkForRestrictedImportPath(importPathNode, importNode) { + const absoluteImportPath = resolve(importPathNode.value, context) if (!absoluteImportPath) { return @@ -90,7 +101,7 @@ module.exports = { .every((absoluteExceptionPath) => isValidExceptionPath(absoluteFrom, absoluteExceptionPath)) if (!hasValidExceptionPaths) { - reportInvalidExceptionPath(node) + reportInvalidExceptionPath(importPathNode) return } @@ -101,23 +112,30 @@ module.exports = { return } + const typeIsExpected = (zone.allowedImportKinds || allowedImportKinds) + .some((kind) => kind === importNode.importKind) + + if (typeIsExpected) { + return + } + context.report({ - node, + node: importPathNode, message: `Unexpected path "{{importPath}}" imported in restricted zone.${zone.message ? ` ${zone.message}` : ''}`, - data: { importPath }, + data: { importPath: importPathNode.value }, }) }) } return { ImportDeclaration(node) { - checkForRestrictedImportPath(node.source.value, node.source) + checkForRestrictedImportPath(node.source, node) }, CallExpression(node) { if (isStaticRequire(node)) { const [ firstArgument ] = node.arguments - checkForRestrictedImportPath(firstArgument.value, firstArgument) + checkForRestrictedImportPath(firstArgument, node) } }, } diff --git a/tests/src/rules/no-restricted-paths.js b/tests/src/rules/no-restricted-paths.js index bd5ab2931..40ebabac1 100644 --- a/tests/src/rules/no-restricted-paths.js +++ b/tests/src/rules/no-restricted-paths.js @@ -67,6 +67,17 @@ ruleTester.run('no-restricted-paths', rule, { // builtin (ignore) test({ code: 'require("os")' }), + + // type imports + test({ + code: 'import type a from "../client/a.js"', + parser: require.resolve('babel-eslint'), + filename: testFilePath('./restricted-paths/server/b.js'), + options: [ { + allowedImportKinds: ['type'], + zones: [ { target: './tests/files/restricted-paths/server', from: './tests/files/restricted-paths/client' } ], + } ], + }), ], invalid: [ @@ -179,5 +190,62 @@ ruleTester.run('no-restricted-paths', rule, { column: 15, } ], }), + + // type imports + test({ + code: 'import type T from "../server/b.js";', + parser: require.resolve('babel-eslint'), + filename: testFilePath('./restricted-paths/client/a.js'), + options: [ { + zones: [ { target: './tests/files/restricted-paths/client', from: './tests/files/restricted-paths/server' } ], + } ], + errors: [ { + message: 'Unexpected path "../server/b.js" imported in restricted zone.', + line: 1, + column: 20, + } ], + }), + test({ + code: ` + import type { T } from "../server/b.js"; + import b from "../server/b.js"; + `, + parser: require.resolve('babel-eslint'), + filename: testFilePath('./restricted-paths/client/a.js'), + options: [ { + allowedImportKinds: ['type'], + zones: [ { target: './tests/files/restricted-paths/client', from: './tests/files/restricted-paths/server' } ], + } ], + errors: [ { + message: 'Unexpected path "../server/b.js" imported in restricted zone.', + line: 3, + column: 23, + } ], + }), + test({ + code: ` + import type { T } from "../server/b.js"; + import b from "../server/b.js"; + `, + parser: require.resolve('babel-eslint'), + filename: testFilePath('./restricted-paths/client/a.js'), + options: [ { + allowedImportKinds: ['type'], + zones: [ { + target: './tests/files/restricted-paths/client', + from: './tests/files/restricted-paths/server', + allowedImportKinds: [], + } ], + } ], + errors: [ { + message: 'Unexpected path "../server/b.js" imported in restricted zone.', + line: 2, + column: 32, + }, { + message: 'Unexpected path "../server/b.js" imported in restricted zone.', + line: 3, + column: 23, + } ], + }), ], })