README

eslint-plugin-import

[![github actions][actions-image]][actions-url]

[![coverage][codecov-image]][codecov-url]




This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, and prevent issues with misspelling of file paths and import names. All the goodness that the ES2015+ static module syntax intends to provide, marked up in your editor.

IF YOU ARE USING THIS WITH SUBLIME: see the bottom section for important info.

 Rules



💼 Configurations enabled in.\
⚠️ Configurations set to warn in.\
🚫 Configurations disabled in.\
❗ Set in the errors configuration.\
☑️ Set in the recommended configuration.\
⌨️ Set in the typescript configuration.\
🚸 Set in the warnings configuration.\
🔧 Automatically fixable by the --fix CLI option.\
💡 Manually fixable by editor suggestions.\
❌ Deprecated.

 Helpful warnings

| Name                                                                   | Description                                                                           | 💼   | ⚠️    | 🚫 | 🔧 | 💡 | ❌  |
| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | :--- | :---- | :- | :- | :- | :- |
| export                                         | Forbid any invalid exports, i.e. re-export of the same name.                          | ❗ ☑️ |       |    |    |    |    |
| no-deprecated                           | Forbid imported names marked with @deprecated documentation tag.                    |      |       |    |    |    |    |
| no-empty-named-blocks           | Forbid empty named import blocks.                                                     |      |       |    | 🔧 | 💡 |    |
| no-extraneous-dependencies | Forbid the use of extraneous packages.                                                |      |       |    |    |    |    |
| no-mutable-exports                 | Forbid the use of mutable exports with var or let.                                |      |       |    |    |    |    |
| no-named-as-default               | Forbid use of exported name as identifier of default export.                          |      | ☑️ 🚸 |    |    |    |    |
| no-named-as-default-member | Forbid use of exported name as property of default export.                            |      | ☑️ 🚸 |    |    |    |    |
| no-unused-modules                   | Forbid modules without exports, or exports without matching import in another module. |      |       |    |    |    |    |

 Module systems

| Name                                                               | Description                                                          | 💼 | ⚠️ | 🚫 | 🔧 | 💡 | ❌  |
| :----------------------------------------------------------------- | :------------------------------------------------------------------- | :- | :- | :- | :- | :- | :- |
| no-amd                                     | Forbid AMD require and define calls.                             |    |    |    |