https://github.com/fnando/eslint-plugin-consistent-import

Enforces consistent import paths when using import.
https://github.com/fnando/eslint-plugin-consistent-import

eslint eslint-plugin

Last synced: 28 days ago
JSON representation

Enforces consistent import paths when using import.

• Host: GitHub
• URL: https://github.com/fnando/eslint-plugin-consistent-import
• Owner: fnando
• License: mit
• Created: 2021-10-20T21:05:11.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-08T04:01:00.000Z (9 months ago)
• Last Synced: 2024-10-06T04:29:08.114Z (about 1 month ago)
• Topics: eslint, eslint-plugin
• Language: JavaScript
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# eslint-plugin-consistent-import

[![NPM](https://img.shields.io/npm/v/@fnando/eslint-plugin-consistent-import.svg)](https://www.npmjs.com/package/@fnando/eslint-plugin-consistent-import)

Enforces consistent import paths when using `import`.

- No relative imports.

- No imports with extensions (`.[jt]sx?`).

- No absolute imports starting with `/`.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```console

$ yarn add -D @fnando/eslint-plugin-consistent-import

```

## Usage

Add `consistent-import` to the plugins section of your `.eslintrc` configuration

file. You can omit the `eslint-plugin-` prefix:

```json

{

  "plugins": ["@fnando/consistent-import"]

}

```

Then configure the rules you want to use under the rules section.

```json

{

  "rules": {

    "@fnando/consistent-import/consistent-import": "error"

  }

}

```

You can also extend the recommended configuration (defaults to `error`).

```json

{

  "plugins": ["@fnando/consistent-import"],

  "extends": ["plugin:@fnando/consistent-import/recommended"]

}

```

## License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the 'Software'), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of

the Software, and to permit persons to whom the Software is furnished to do so,

subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.