@proximacapital-public/eslint-config v4.0.2

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. Currently all the rules are sitting inside the index.js (which is exported via the package.json); however a refactor may eventually occur that breaks the rules up into various files for easier management.

This package has peer dependencies and you'll want to resolve them when using this as a dev dependency. See the package.json. This package is also a core dependency of @proximacapital/infrastructure, read through both Usage sections to learn how to source the config straight from infra.

Usage

There are two ways to use this config. Either through the package.json or a dedicated .eslintrc(.js) file.

In either case, you'll need to add the following dev dependencies to your package.json:

"devDependencies": {
  "@proximacapitalpublic/eslint-config": "0.0.2",
  "@typescript-eslint/eslint-plugin": "4.29.1",
  "@typescript-eslint/eslint-plugin-tslint": "4.29.1",
  "@typescript-eslint/parser": "4.29.1",
  "eslint": "7.32.0",
  "eslint-plugin-import": "2.24.0",
  "eslint-plugin-import-newlines": "1.1.4",
  "eslint-plugin-typescript-sort-keys": "1.7.0",
  "eslint-plugin-unicorn": "35.0.0",
}

package.json modifications

This is the slickest way to access the config. Add the following object to the package.json:

"eslintConfig": {
  "extends": "@proximacapitalpublic/eslint-config"
},

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: "@proximacapitalpublic/eslint-config"
}

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/@proximacapital/eslint-config/
npm link @proximacapitalpublic/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 @proximacapitalpublic/eslint-config
npm install # download latest eslint-config