eslint-plugin-module

0.1.0 • Public • Published

eslint-plugin-module

ESLint plugins for module.

npm install eslint-plugin-moudle -g

rules

no-extraneous-dependencies

Forbid the import of external modules that are not declared in the package.json's dependencies, devDependencies, optionalDependencies, peerDependencies, or bundledDependencies. The closest parent package.json will be used. If no package.json is found, the rule will not lint anything. This behaviour can be changed with the rule option packageDir.

This rule is inspired by import/no-extraneous-dependencies and TSLint rule no-implicit-dependencies.

The difference between import/no-extraneous-dependencies, is that modules don't have to be installed for this rule to work.

This rule supports the following options:

devDependencies: If set to false, then the rule will show an error when devDependencies are imported. Defaults to true.

optionalDependencies: If set to false, then the rule will show an error when optionalDependencies are imported. Defaults to true.

peerDependencies: If set to false, then the rule will show an error when peerDependencies are imported. Defaults to false.

bundledDependencies: If set to false, then the rule will show an error when bundledDependencies are imported. Defaults to true.

whitelist: Whitelisted modules can to be added to skip checking their existence in package.json.

You can set the options like this:

"module/no-extraneous-dependencies": ["error", {"devDependencies": false, "optionalDependencies": false, "peerDependencies": false}]

You can also use an array of globs instead of literal booleans:

"module/no-extraneous-dependencies": ["error", {"devDependencies": ["**/*.test.js", "**/*.spec.js"]}]

You can set the whitelist modules like this:

"module/no-extraneous-dependencies": ["error", {"devDependencies": ["@components"]}]

Readme

Keywords

Package Sidebar

Install

npm i eslint-plugin-module

Weekly Downloads

5

Version

0.1.0

License

BSD-3-Clause

Unpacked Size

18.8 kB

Total Files

6

Last publish

Collaborators

  • chenjun1011
  • rax-publisher
  • yuanyan