Skip to content
Permalink
Browse files
feat: no-restricted-imports support casing (#15439)
* fix: no-restricted-imports support casing

Path matching in `.gitignore` can be case-sensitive, and
ignore@5.2.0 supports this as well as maintains support for
relative paths, whose support was dropped after 4.0.6 but
restored in 5.2.0 (this was a blocker for past upgrades).

By default, this rule remains case-insensitive to maintain
backwards compatibility with earlier versions. Only by explicitly
specifying it in a custom pattern object can it be triggered.

* Set allowRelativePaths directly in files

Per member feedback, the allowing of relative paths
was not entirely intentional for rules using the
`ignore` library. This commit also reverts the
utility for creating `ignore` instances.

* Update word in docs for allowRelativePaths

Per reviewer feedback
  • Loading branch information
gfyoung committed Jan 15, 2022
1 parent f50f849 commit 19ad061290e1e97f760cfdce90a651cea9042c32
Showing with 67 additions and 6 deletions.
  1. +29 −0 docs/rules/no-restricted-imports.md
  2. +15 −4 lib/rules/no-restricted-imports.js
  3. +2 −1 lib/rules/no-restricted-modules.js
  4. +1 −1 package.json
  5. +20 −0 tests/lib/rules/no-restricted-imports.js
@@ -91,6 +91,17 @@ or like this if you want to apply a custom message to pattern matches:

The custom message will be appended to the default error message.

Pattern matches can also be configured to be case-sensitive:

```json
"no-restricted-imports": ["error", {
"patterns": [{
"group": ["import1/private/prefix[A-Z]*"],
"caseSensitive": true
}]
}]
```

To restrict the use of all Node.js core imports (via <https://github.com/nodejs/node/tree/master/lib>):

```json
@@ -176,6 +187,15 @@ import * as Foo from "foo";
import pick from 'lodash/pick';
```

```js
/*eslint no-restricted-imports: ["error", { patterns: [{
group: ["foo[A-Z]*"],
caseSensitive: true
}]}]*/
import pick from 'fooBar';
```

Examples of **correct** code for this rule:

```js
@@ -218,6 +238,15 @@ import { AllowedObject as DisallowedObject } from "foo";
import lodash from 'lodash';
```

```js
/*eslint no-restricted-imports: ["error", { patterns: [{
group: ["foo[A-Z]*"],
caseSensitive: true
}]}]*/
import pick from 'food';
```

## When Not To Use It

Don't use this rule or don't include a module in the list for this rule if you want to be able to import a module in your project without an ESLint error or warning.
@@ -69,6 +69,9 @@ const arrayOfStringsOrObjectPatterns = {
message: {
type: "string",
minLength: 1
},
caseSensitive: {
type: "boolean"
}
},
additionalProperties: false,
@@ -148,10 +151,18 @@ module.exports = {
}, {});

// Handle patterns too, either as strings or groups
const restrictedPatterns = (isPathAndPatternsObject ? options[0].patterns : []) || [];
const restrictedPatternGroups = restrictedPatterns.length > 0 && typeof restrictedPatterns[0] === "string"
? [{ matcher: ignore().add(restrictedPatterns) }]
: restrictedPatterns.map(({ group, message }) => ({ matcher: ignore().add(group), customMessage: message }));
let restrictedPatterns = (isPathAndPatternsObject ? options[0].patterns : []) || [];

// standardize to array of objects if we have an array of strings
if (restrictedPatterns.length > 0 && typeof restrictedPatterns[0] === "string") {
restrictedPatterns = [{ group: restrictedPatterns }];
}

// relative paths are supported for this rule
const restrictedPatternGroups = restrictedPatterns.map(({ group, message, caseSensitive }) => ({
matcher: ignore({ allowRelativePaths: true, ignorecase: !caseSensitive }).add(group),
customMessage: message
}));

// if no imports are restricted we don't need to check
if (Object.keys(restrictedPaths).length === 0 && restrictedPatternGroups.length === 0) {
@@ -103,7 +103,8 @@ module.exports = {
return {};
}

const ig = ignore().add(restrictedPatterns);
// relative paths are supported for this rule
const ig = ignore({ allowRelativePaths: true }).add(restrictedPatterns);


/**
@@ -66,7 +66,7 @@
"functional-red-black-tree": "^1.0.1",
"glob-parent": "^6.0.1",
"globals": "^13.6.0",
"ignore": "^4.0.6",
"ignore": "^5.2.0",
"import-fresh": "^3.0.0",
"imurmurhash": "^0.1.4",
"is-glob": "^4.0.0",
@@ -54,6 +54,16 @@ ruleTester.run("no-restricted-imports", rule, {
code: "import withPatterns from \"foo/bar\";",
options: [{ patterns: [{ group: ["foo/*", "!foo/bar"], message: "foo is forbidden, use bar instead" }] }]
},
{
code: "import withPatternsCaseSensitive from 'foo';",
options: [{
patterns: [{
group: ["FOO"],
message: "foo is forbidden, use bar instead",
caseSensitive: true
}]
}]
},
{
code: "import AllowedObject from \"foo\";",
options: [{
@@ -344,6 +354,16 @@ ruleTester.run("no-restricted-imports", rule, {
column: 1,
endColumn: 36
}]
}, {
code: "import withPatternsCaseInsensitive from 'foo';",
options: [{ patterns: [{ group: ["FOO"] }] }],
errors: [{
message: "'foo' import is restricted from being used by a pattern.",
type: "ImportDeclaration",
line: 1,
column: 1,
endColumn: 47
}]
}, {
code: "import withGitignores from \"foo/bar\";",
options: [{ patterns: ["foo/*", "!foo/baz"] }],

0 comments on commit 19ad061

Please sign in to comment.