-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1055 from benmosher/release-2.10.0
Release 2.10.0
- Loading branch information
Showing
34 changed files
with
1,122 additions
and
62 deletions.
There are no files selected for viewing
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# import/no-cycle | ||
|
||
Ensures that there is no resolvable path back to this module via its dependencies. | ||
|
||
This includes cycles of depth 1 (imported module imports me) to `Infinity`, if the | ||
[`maxDepth`](#maxdepth) option is not set. | ||
|
||
```js | ||
// dep-b.js | ||
import './dep-a.js' | ||
|
||
export function b() { /* ... */ } | ||
|
||
// dep-a.js | ||
import { b } from './dep-b.js' // reported: Dependency cycle detected. | ||
``` | ||
|
||
This rule does _not_ detect imports that resolve directly to the linted module; | ||
for that, see [`no-self-import`]. | ||
|
||
|
||
## Rule Details | ||
|
||
### Options | ||
|
||
By default, this rule only detects cycles for ES6 imports, but see the [`no-unresolved` options](./no-unresolved.md#options) as this rule also supports the same `commonjs` and `amd` flags. However, these flags only impact which import types are _linted_; the | ||
import/export infrastructure only registers `import` statements in dependencies, so | ||
cycles created by `require` within imported modules may not be detected. | ||
|
||
#### `maxDepth` | ||
|
||
There is a `maxDepth` option available to prevent full expansion of very deep dependency trees: | ||
|
||
```js | ||
/*eslint import/no-unresolved: [2, { maxDepth: 1 }]*/ | ||
|
||
// dep-c.js | ||
import './dep-a.js' | ||
|
||
// dep-b.js | ||
import './dep-c.js' | ||
|
||
export function b() { /* ... */ } | ||
|
||
// dep-a.js | ||
import { b } from './dep-b.js' // not reported as the cycle is at depth 2 | ||
``` | ||
|
||
This is not necessarily recommended, but available as a cost/benefit tradeoff mechanism | ||
for reducing total project lint time, if needed. | ||
|
||
## When Not To Use It | ||
|
||
This rule is comparatively computationally expensive. If you are pressed for lint | ||
time, or don't think you have an issue with dependency cycles, you may not want | ||
this rule enabled. | ||
|
||
## Further Reading | ||
|
||
- [Original inspiring issue](https://github.com/benmosher/eslint-plugin-import/issues/941) | ||
- Rule to detect that module imports itself: [`no-self-import`] | ||
|
||
[`no-self-import`]: ./no-self-import.md |
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
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
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
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
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
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
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
Empty file.
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
Oops, something went wrong.