-
-
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.
Tag v1.15.0
- Loading branch information
Showing
23 changed files
with
486 additions
and
22 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # max-dependencies | ||
|
|
||
| Forbid modules to have too many dependencies (`import` or `require` statements). | ||
|
|
||
| This is a useful rule because a module with too many dependencies is a code smell, and usually indicates the module is doing too much and/or should be broken up into smaller modules. | ||
|
|
||
| Importing multiple named exports from a single module will only count once (e.g. `import {x, y, z} from './foo'` will only count as a single dependency). | ||
|
|
||
| ### Options | ||
|
|
||
| This rule takes the following option: | ||
|
|
||
| `max`: The maximum number of dependencies allowed. Anything over will trigger the rule. **Default is 10** if the rule is enabled and no `max` is specified. | ||
|
|
||
| You can set the option like this: | ||
|
|
||
| ```js | ||
| "import/max-dependencies": ["error", {"max": 10}] | ||
| ``` | ||
|
|
||
|
|
||
| ## Example | ||
|
|
||
| Given a max value of `{"max": 2}`: | ||
|
|
||
| ### Fail | ||
|
|
||
| ```js | ||
| import a from './a'; // 1 | ||
| const b = require('./b'); // 2 | ||
| import c from './c'; // 3 - exceeds max! | ||
| ``` | ||
|
|
||
| ### Pass | ||
|
|
||
| ```js | ||
| import a from './a'; // 1 | ||
| const anotherA = require('./a'); // still 1 | ||
| import {x, y, z} from './foo'; // 2 | ||
| ``` | ||
|
|
||
| ## When Not To Use It | ||
|
|
||
| If you don't care how many dependencies a module has. |
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,27 @@ | ||
| # Forbid import of modules using absolute paths | ||
|
|
||
| Node.js allows the import of modules using an absolute path such as `/home/xyz/file.js`. That is a bad practice as it ties the code using it to your computer, and therefore makes it unusable in packages distributed on `npm` for instance. | ||
|
|
||
| ## Rule Details | ||
|
|
||
| ### Fail | ||
|
|
||
| ```js | ||
| import f from '/foo'; | ||
| import f from '/some/path'; | ||
|
|
||
| var f = require('/foo'); | ||
| var f = require('/some/path'); | ||
| ``` | ||
|
|
||
| ### Pass | ||
|
|
||
| ```js | ||
| import _ from 'lodash'; | ||
| import foo from 'foo'; | ||
| import foo from './foo'; | ||
|
|
||
| var _ = require('lodash'); | ||
| var foo = require('foo'); | ||
| var foo = require('./foo'); | ||
| ``` |
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
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,49 @@ | ||
| import Set from 'es6-set' | ||
| import isStaticRequire from '../core/staticRequire' | ||
|
|
||
| const DEFAULT_MAX = 10 | ||
|
|
||
| const countDependencies = (dependencies, lastNode, context) => { | ||
| const {max} = context.options[0] || { max: DEFAULT_MAX } | ||
|
|
||
| if (dependencies.size > max) { | ||
| context.report( | ||
| lastNode, | ||
| `Maximum number of dependencies (${max}) exceeded.` | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| module.exports = context => { | ||
| const dependencies = new Set() // keep track of dependencies | ||
| let lastNode // keep track of the last node to report on | ||
|
|
||
| return { | ||
| ImportDeclaration(node) { | ||
| dependencies.add(node.source.value) | ||
| lastNode = node.source | ||
| }, | ||
|
|
||
| CallExpression(node) { | ||
| if (isStaticRequire(node)) { | ||
| const [ requirePath ] = node.arguments | ||
| dependencies.add(requirePath.value) | ||
| lastNode = node | ||
| } | ||
| }, | ||
|
|
||
| 'Program:exit': function () { | ||
| countDependencies(dependencies, lastNode, context) | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| module.exports.schema = [ | ||
| { | ||
| 'type': 'object', | ||
| 'properties': { | ||
| 'max': { 'type': 'number' }, | ||
| }, | ||
| 'additionalProperties': false, | ||
| }, | ||
| ] |
Oops, something went wrong.