@opencreek/eslint-plugin

@opencreek/eslint-plugin

Disalows relative path across the baseUrl of your tsconfig

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-no-relative-base-url-imports:

npm install @opencreek/eslint-plugin --save-dev

yarn  add --dev @opencreek/eslint-plugin

Usage

Add @opencreek to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": ["@opencreek"]
}

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

{
    "rules": {
        "@opencreek/no-relative-imports": [
            "error",
            {
                "baseUrl": "./src"
            }
        ]
    }
}

Supported Rules

@opencreek/no-relative-imports Disable relative imports.

Config options

{
    "baseUrl": "./src", // The base url that you have set in the tsconfig
    "allowLocalImports": "local" // possible values: "local" | "in-base-path".
    // "local": Allows local imports (eg.: "./test")
    // "in-base-path": Allows everything that does not go back to the base url level (eg: "../../test" in "src/a/b/c/test.ts")
}