@opencreek/eslint-plugin-ts

0.4.4 • Public • Published

@opencreek/eslint-plugin-ts

Disalows relative path across the baseUrl of your tsconfig

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install @opencreek/eslint-plugin-ts:

npm install @opencreek/eslint-plugin-ts --save-dev
yarn  add --dev @opencreek/eslint-plugin-ts

Usage

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

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

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

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

Supported Rules

@opencreek/ts/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")
}

Package Sidebar

Install

npm i @opencreek/eslint-plugin-ts

Weekly Downloads

11

Version

0.4.4

License

MIT

Unpacked Size

64.4 kB

Total Files

6

Last publish

Collaborators

  • happenslol
  • reckter
  • lionc
  • mhlz