docs: paths and patterns difference in no-restricted-imports
#18273
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
nzakas
reviewed
Apr 5, 2024
| @@ -286,6 +286,8 @@ import { AllowedObject } from "foo"; | |||
|
|
|||
| This is also an object option whose value is an array. This option allows you to specify multiple modules to restrict using `gitignore`-style patterns. | |||
|
|
|||
| Where `paths` option takes exact import paths, `patterns` option can be used to specify the import paths with more flexibility, allowing for the restriction of multiple modules within the same directory. | |||
There was a problem hiding this comment.
I think we could use some examples in this explanation, as it's still not clear to me what the difference is.
There was a problem hiding this comment.
Done! added examples.
There was a problem hiding this comment.
Suggested change
| Where `paths` option takes exact import paths, `patterns` option can be used to specify the import paths with more flexibility, allowing for the restriction of multiple modules within the same directory. | |
| Where `paths` option takes exact import paths, `patterns` option can be used to specify the import paths with more flexibility, allowing for the restriction of multiple modules within the same directory. For example: |
amareshsm
added
the
accepted
nzakas
requested changes
Apr 10, 2024
| @@ -286,6 +286,8 @@ import { AllowedObject } from "foo"; | |||
|
|
|||
| This is also an object option whose value is an array. This option allows you to specify multiple modules to restrict using `gitignore`-style patterns. | |||
|
|
|||
| Where `paths` option takes exact import paths, `patterns` option can be used to specify the import paths with more flexibility, allowing for the restriction of multiple modules within the same directory. | |||
There was a problem hiding this comment.
Suggested change
| Where `paths` option takes exact import paths, `patterns` option can be used to specify the import paths with more flexibility, allowing for the restriction of multiple modules within the same directory. | |
| Where `paths` option takes exact import paths, `patterns` option can be used to specify the import paths with more flexibility, allowing for the restriction of multiple modules within the same directory. For example: |
| }] | ||
| ``` | ||
|
|
||
| Here rule will only restrict the `import-foo` module. |
There was a problem hiding this comment.
Suggested change
| Here rule will only restrict the `import-foo` module. | |
| This configuration restricts import of the `import-foo` module but wouldn't restrict the import of `import-foo/bar` or `import-foo/baz`. You can use `patterns` to restrict both: |
Comment on lines
301
to
309
| ```json | ||
| "no-restricted-imports": ["error", { | ||
| "patterns": [{ | ||
| "group": ["import1/*"], | ||
| }] | ||
| }] | ||
| ``` | ||
|
|
||
| Here rule will restrict all modules inside `import1` directory. |
There was a problem hiding this comment.
Suggested change
| ```json | |
| "no-restricted-imports": ["error", { | |
| "patterns": [{ | |
| "group": ["import1/*"], | |
| }] | |
| }] | |
| ``` | |
| Here rule will restrict all modules inside `import1` directory. | |
| ```json | |
| "no-restricted-imports": ["error", { | |
| "paths": [{ | |
| "name": "import-foo", | |
| }] | |
| "patterns": [{ | |
| "group": ["import-foo/ba*"], | |
| }] | |
| }] | |
| ``` | |
| This configuration restricts imports not just from `import-foo` using `path`, but also `import-foo/bar` and `import-foo/baz` using `patterns`. |
This was referenced May 29, 2024
This was referenced Jun 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
added difference between the
pathsandpatternsoption ofno-restricted-importsrule.Is there anything you'd like reviewers to focus on?
Fixes: #18253