README.md

ESLint Config brainbits Typescript

This package contains our eslint rules we use at brainbits for typescript projects. It is based on the eslint-config-brainbits rules and replaces some default rules with specialized ones wich are provided by the typescript eslint plugin.

Usage

Install the package via npm.

$ npm install --save-dev eslint-config-brainbits-typescript

After installation of the package you have to install all required peer dependencies.

$ npx install-peerdeps --dev eslint-config-brainbits-typescript

Add it to your .eslintrc

{
    "extends": ["brainbits-typescript"],
    "parserOptions": {
        "project": "./tsconfig.json"
    }
}

Note: The eslint typescript parser requires the path to your tsconfig.json file in the parser options.