@procore/eslint-config-procore

ESLint configuration used at Procore

Usage no npm install needed!

<script type="module">
  import procoreEslintConfigProcore from 'https://cdn.skypack.dev/@procore/eslint-config-procore';
</script>

README

eslint-config

A (hopefully) shared eslint config for Procore

Installation

This package relies on peer dependencies that you can add with this command

yarn add \
  @procore/eslint-config-procore \
  prettier \
  eslint \
  eslint-config-airbnb \
  eslint-config-prettier \
  eslint-plugin-jsx-a11y \
  eslint-plugin-prettier \
  eslint-plugin-react \
  eslint-plugin-react-hooks \
  eslint-plugin-import \
  -DE

Then extend from the config package in your .eslintrc

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

In your package.json, you can add to the "scripts" so that you can do yarn lint:

"scripts": {
  "lint": "eslint '*/**/*.{js,jsx,ts,tsx}'",
},

If you need to, add a .eslintignore:

/node_modules/**
/coverage/**
/build/**