@opencreek/eslint-plugin-ts

@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"
            }
        ],
        "@opencreek/nextjs-pages-no-default-export-function": "error"
    }
}

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")
}

@opencreek/nextjs-pages-no-default-export-function Dissallows export default function exports in nextjs pages.

Because of how storybook uses acorn, and it interplays with react doc gen and default exports that have values attached, we need to always have them extra. This only checks files that are in a pages folder currently.

Fails:

export default function BlaPage() {
    //...
}

BlaPage.Layout = "layout"

Passes:

function BlaPage() {
    //...
}

BlaPage.Layout = "layout"

export default function BlaPage

export default function BlaPage() {
    //...
}