@open-turo/eslint-config-react

@open-turo/eslint-config-react

Turo eslint configuration for react. The config expects that Typescript is being used as it extends eslint-config-typescript.

Usage

Install the package and all of its peer dependencies:

npx install-peerdeps --dev @open-turo/eslint-config-react

Then in your .eslintrc file, extend from the default configuration of this package, which is the recommended eslint configuration for our existing front-end projects.

To use this config, just add to your .eslintrc the following:

"extends": "@open-turo/eslint-config-typescript"

Legacy preset

There is a legacy preset that extends @open-turo/eslint-config-typescript/legacy. This only exists for backwards compatibility with existing projects. It is strongly recommended to use the standard preset.

To use the legacy preset, update your .eslintrc file to be:

{
  "extends": "@open-turo/eslint-config-react/legacy"
}

Development

Pre-commit

Install pre-commit and the commit hooks:

pre-commit install
pre-commit install --hook-type commit-msg

Keeping peerDependencies up-to-date

Transitive peerDependencies should be added, and kept up to date. A useful tool for that task is npx check-peer-dependencies, which shows us our missing (or outdated) peerDependencies.

Get Help

Please review Issues, post new Issues against this repository as needed.

Contributions

Please see here for guidelines on how to contribute to this project.