@proxima-oss/eslint-config v6.0.1

Proxima Capital's ESLint-Config

This repo contains Proxima's canonical eslint config, it is strongly recommended that you keep your TypeScript repositories in-line with this config where possible.

Different type of eslint configs

There are currently three different types of configs available to use under two different catagories. You can access the config two ways. Either through the package.json or a dedicated .eslintrc(.js) file.

Correctness

The correctness rule set is all of our current eslint config rules that keep the code in a correct manor, i.e if(true) is always truthy and shouldn't be in our code base.

Style

The style rule set encompasses all of our stylist rules. We have two subsets of these, Verbose and Standard. The difference between the two is that standard allows type-inferring while the verbose rule set makes the dev declare what type the type is on the variable.

i.e.

Standard: const lExampleVar = aClass.GetVar();

Verbose: const lExampleVar: ExampleType = aClass.GetVar();

These eslint configs both extend correctness. This is because correctness should always be used and when we import more than one eslint config, there overrides clash which can lead to correctness-rules/style-rules missing.

package.json modifications

This is the slickest way to access the config. Add one of the following objects to the package.json:

"eslintConfig": {
    "extends": "@proxima-oss/eslint-config/style/standard"
},

"eslintConfig": {
    "extends": "@proxima-oss/eslint-config/style/verbose"
},

"eslintConfig": {
    "extends": "@proxima-oss/eslint-config/correctness"
},

In line with the eslint recommendations, the next easiest way to use this config in your repo is to extend the eslintrc.js in your root directory. That is,

// repo_root/.eslintrc.js
module.exports = {
    "extends": "@proxima-oss/eslint-config/style/standard"
}

module.exports = {
    "extends": "@proxima-oss/eslint-config/style/verbose"
}

module.exports = {
    "extends": "@proxima-oss/eslint-config/correctness"
}

Development

If you want to make additions to this configuration and don't want to wait between npm publishes, your best bet is to use npm link to symbolically link your changes to the package you want to try it out in.

Let's say you wanted to make changes here and test them out in the infrastructure repo:

# inside this repo
npm link # <- this makes a symbolic link in the global node_modules folder
cd ../infrastructure
# copy the symlink into the ./node_modules/@proxima-oss/eslint-config/
npm link @proxima-oss/eslint-config

Now, provided your infrastructure/.eslintrc.js or infrastructure/package.json is configured as above, you should see the effects of your changes.

Don't forget to npm unlink (npm uninstall) after you publish your changes:

# inside the infrastructure repo
npm unlink --no-save @proxima-oss/eslint-config
npm install # download latest eslint-config