eslint-plugin-import-alias

ESLint rule for restricting imports to path aliases

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
eslint-plugin-import-alias
1031.2.04 years ago4 years agoMinified + gzip package size for eslint-plugin-import-alias in KB

Readme

eslint-plugin-import-alias
An ESLint rule for forcing import path aliases.

Install

npm install --save-dev eslint-plugin-import-alias

Usage

import { test } from '@src/test'; // valid
import { test } from './test'; // invalid
import { test } from '../test'; // invalid

// Optional relative depth can be specified.
import { test } from './test'; // valid, { relativeDepth: 0 }
import { test } from '../test'; // valid, { relativeDepth: 1 }
import { test } from '../../test'; // invalid, { relativeDepth: 1 }

Configure

{
  "rules": {
    "import-alias/import-alias": [
      "error",
      {
        "relativeDepth": 0,
        "aliases": [
          { "alias": "@src", "matcher": "^src" }, // src/modules/app/test -> @src/modules/app/test
          { "alias": "@test", "matcher": "^test\/unit" }, // test/unit/modules/app -> @test/modules/app
          { "alias": "@testRoot", "matcher": "^(test)\/e2e" } // test/e2e/modules/app -> @testRoot/e2e/modules/app
        ]
      }
    ]
  }
}

Aliases can be configured to fix the path and rewrite to an aliased path. Each alias has the alias text and a regex matcher that will match against the resolved path from the root directory of the eslint process (usually the project root). For example, if the resolved file path is in the 'src' folder (src/modules/app/test) then 'src' will be replaced with '@src'. Optionally, you can define a capture group to replace only the part within the capture group, but still match against the whole regex.
A 'rootDir' can be defined to resolve the file paths from. This defaults to process.cwd(). In a lot of cases, this is already the project root in most cases.
module.exports = {
  "rules": {
    "import-alias/import-alias": [
      "error",
      {
        "relativeDepth": 0,
        "rootDir": __dirname,
        "aliases": [
          { "alias": "@src", "matcher": "^src" } // src/modules/app/test -> @src/modules/app/test
        ]
      }
    ]
  }
};