Sha256: 2bb5645fc263146995996dc3f64a9511cba777d042f232bee8d626e50242c828

Contents?: true

Size: 1.45 KB

Versions: 49

Compression:

Stored size: 1.45 KB

Contents

# import/no-relative-packages

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->

Use this rule to prevent importing packages through relative paths.

It's useful in Yarn/Lerna workspaces, were it's possible to import a sibling
package using `../package` relative path, while direct `package` is the correct one.

## Examples

Given the following folder structure:

```pt
my-project
├── packages
│   ├── foo
│   │   ├── index.js
│   │   └── package.json
│   └── bar
│       ├── index.js
│       └── package.json
└── entry.js
```

And the .eslintrc file:

```json
{
  ...
  "rules": {
    "import/no-relative-packages": "error"
  }
}
```

The following patterns are considered problems:

```js
/**
 *  in my-project/packages/foo.js
 */

import bar from '../bar'; // Import sibling package using relative path
import entry from '../../entry.js'; // Import from parent package using relative path

/**
 *  in my-project/entry.js
 */

import bar from './packages/bar'; // Import child package using relative path
```

The following patterns are NOT considered problems:

```js
/**
 *  in my-project/packages/foo.js
 */

import bar from 'bar'; // Import sibling package using package name

/**
 *  in my-project/entry.js
 */

import bar from 'bar'; // Import sibling package using package name
```

Version data entries

49 entries across 49 versions & 1 rubygems

Version Path
immosquare-cleaner-0.1.60 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.59 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.58 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.57 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.56 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.55 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.54 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.53 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.52 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.51 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.50 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.49 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.48 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.47 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.46 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.45 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.44 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.43 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.42 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md
immosquare-cleaner-0.1.41 node_modules/eslint-plugin-import/docs/rules/no-relative-packages.md