eslint-plugin-internal
![npm version](https://img.shields.io/npm/v/@groww-tech/eslint-plugin-internal?color=51C838)
ESLint Plugin with customized rules as per requirement and preferences of devs in Groww.
Installation
You'll first need to install ESLint:
$ npm i eslint @typescript-eslint/parser --save-dev
Next, install @groww-tech/eslint-plugin-internal
:
$ npm install @groww-tech/eslint-plugin-internal --save-dev
Usage
Add internal
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": [
"@groww-tech/eslint-plugin-internal"
]
}
Then configure the rules you want to use under the rules section.
{
"parser": "@typescript-eslint/parser",
"rules": {
"@groww-tech/internal/two-line-above-function":"error",
}
}
Supported Rules
avoid-negation-unary-if-else
padded-blocks-bottom-if-else-try-catch
prefer-type-alias
two-line-above-function
two-line-between-class-members
This plugin is for use in Groww projects. Use at your own risk.