groww-oss / eslint-config

Standard Eslint config adopted in Groww. Customized as per requirement and preferences of devs in Groww.

eslint-config

Standard Eslint config adopted in Groww. Customized as per requirement and preferences of devs in Groww.

Install

for npm >=5

npx install-peerdeps --dev @groww-tech/eslint-config

for npm <5

1. Install all the packages returned by the following command.

npm info "@groww-tech/eslint-config@latest" peerDependencies

2. Then run

npm install --save-dev "@groww-tech/eslint-config"

Usage

Add "extends": "@groww-tech/eslint-config" to your .eslintrc

This configuration is for use in Groww projects. Use at your own risk.

eslint-config's Issues

Spacing/indentation rules version 1.0.2

Issue tracker for all the spacing/indentation rules

//no a=b ; always a=b;  no space after
"semi-spacing": ["warn", { "before": false, "after": true }], 
"space-before-blocks": ["warn", "always"], future
"space-before-function-paren": ["warn", "always"],

// no space after if(x===2) formating discuss
"space-in-parens": ["error", "never"],

//a=b+2 -> a = b + 2
"space-infix-ops": "warn", future

//https://eslint.org/docs/rules/space-unary-ops
"space-unary-ops": ["warn", { "words": true, "nonwords": false }], future

Migration Log

This is an auto-generated issue. The migration log is in the following comment(s).

Cannot read property 'loc' of undefined

While editing some 'ts' files the following error is shown. This can be fixed by handing over indentation to @typescript-eslint/indent

see
eslint/eslint#13956 (comment)

Version 1.0.2 Release Plan

We kept version 1.0.1 very minimal so to make a better adoption and integration experience. That has been achieved

The goal of version 1.0.2 will be to enable rules that enable formatting and indentation rule and to make sure that no spacing-related discrepancy is happening anywhere in the code.

This will help developers and reviewers to never care about the spacing or anything related while coding or during code review. Some basic indentation has been there in version 1.0.1 but still, there are many inconsistencies remaining due to the lenient eslint config.

We will be trying to as close as to the accepted styling guidelines. If there isn't a strong case against what the norm is we will avoid making changes

For example, using 2 spaces between functions. There isn't much increase in readability or anything with this. So we will allow only 1 space. In general 1 space is preferred most of the time.

semi-colon rule semi: always error

Enforce semi column rule. The rule is set to always meaning using semi colon is must