https://github.com/luisadame/eslint-plugin-preferred-import-path

Enforces a consistent use of preferred import paths
https://github.com/luisadame/eslint-plugin-preferred-import-path

Last synced: 3 days ago
JSON representation

Enforces a consistent use of preferred import paths

• Host: GitHub
• URL: https://github.com/luisadame/eslint-plugin-preferred-import-path
• Owner: luisadame
• Created: 2022-03-14T23:52:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-03-15T00:31:09.000Z (over 2 years ago)
• Last Synced: 2024-10-14T00:20:42.498Z (about 1 month ago)
• Language: JavaScript
• Size: 108 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Enforces a consistent use of preferred import paths (preferred-import-path/preferred-import-path)



  



Enforce the use of preferred import path, it allows to keep a consistent use of import paths that may be aliased of typescript

or webpack and you'd prefer your team to use the aliases, instead of relative paths, or absolute paths but that are longer and aliases

keep them short

**Fixable**: This rule is automatically fixable by using the `--fix` option on the command line.

## Rule details

This rule checks that import declaration sources are in line with the map of preferred paths.

This rule accepts an argument that conveys the paths you want to map to the preferred paths:

```js

// .eslintrc.js

module.exports = {

    rules: {

        'preferred-import-path/preferred-import-path': {

            'src/views', '@views',

            'src/components', '@components',

            'src/components/design-system', '@ui'

        }

    }

}

```

With this configuration when an import declaration is found it will check if the source of it is one of the keys of the map it will error/warn about the preference of using the value of such key.

For example, if we have this import:

```js

import { Modal } from 'src/components/Modal';

```

it will autofix to:

```js

import { Modal } from '@components/Modal';

```

## When not to use it

This rule is intended for projects that want to enforce a convention on the use of certain import declarations, most of the time this won't be the case and this rule won't be needed.