@procore/eslint-config

Procore Technologies, Inc ESLint configuration.

Quick Start

Install the package, using your preferred client:

yarn

Install @procore/eslint-config only.

yarn add -D @procore/eslint-config

Include @procore/eslint-config and all peer dependencies.

yarn add -D @procore/eslint-config @babel/core@latest eslint@latest prettier@latest typescript@latest

npm

Install @procore/eslint-config only.

npm install -D @procore/eslint-config

Include @procore/eslint-config and all peer dependencies.

npm install -D @procore/eslint-config @babel/core@latest eslint@latest prettier@latest typescript@latest

Add the configuration to your [ESLint][eslint] configuration (example: .eslintrc.json):

{
  "extends: ["@procore/eslint-config"]
}

Run [ESLint][eslint] as you normally would:

yarn eslint .

NOTE: @procore/eslint-config requires the following as dependencies in order to work properly:

• @babel/core >=7.11.0
• eslint: ^7.0.0 || ^8.0.0
• prettier: >=2.0.0
• typescript: >=2.8.0

It is assumed that most of these are already installed in your project, but you can use the install command(s) above to ensure that any missing dependencies are installed.