Skip to content

mkizka/eslint-plugin-relative-import

Repository files navigation

@mkizka/eslint-plugin-relative-import

import { foo } from "~/lib/utils";
// ↓
import { foo } from "../lib/utils";

Installation

npm i -D @mkizka/eslint-plugin-relative-import

Example

// eslint.config.js
import { relativeImport } from "@mkizka/eslint-plugin-relative-import";

export default [relativeImport({ alias: { "~": "./src" } })];

or

// eslint.config.js
import { relativeImportPlugin } from "@mkizka/eslint-plugin-relative-import";

export default [
  {
    plugins: {
      "@mkizka/relative-import": relativeImportPlugin,
    },
    rules: {
      "@mkizka/relative-import/no-path-alias": [
        "error",
        { alias: { "~": "./src" } },
      ],
    },
  },
];

or

// .eslintrc
{
  "plugins": ["@mkizka/relative-import"],
  "rules": {
    "@mkizka/relative-import/no-path-alias": [
      "error",
      { "alias": { "~": "./src" } },
    ],
  },
}

About

ESLint plugin to enforce relative imports

Topics

Resources

License

Stars

Watchers

Forks

Contributors