@pengubot/eslint-config

PenguBot's Organisation Standard ESLint and TSConfig

---

Installation

Installing the Peer Dependencies:

yarn add -D eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin

Then install this config:

yarn add -D @pengubot/eslint-config

Installation

ESLint

To use it as your ESLint config you can add this to your .eslintrc file:

{
    "extends": ["@pengubot"]
}

Or you can add this to your package.json:

{
    "eslintConfig": {
        "extends": "@pengubot"
    }
}

Then create a tsconfig.eslint.json similar to the following example in the same directory:

{
    "extends": "./tsconfig.json",
    "include": ["src"]
}

TypeScript

To use @pengubot/eslint-config's TypeScript config you can add this to your tsconfig.json:

{
    "extends": "@pengubot/eslint-config"
}

Support

License

MIT