@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.

Relevant notes

The eslint configurations in this repo extend @open-turo/eslint-config-typescript/legacy; as it is the base TS eslint config that supports our existing front-end codebase.

However, if you are creating a new React project and you think you would benefit from having the configurations in this repository extend the default @open-turo/eslint-config-typescript config instead, please raise an issue and/or feel free to create a PR to add a new default that extends it, and rename the current configurations to legacy and legacy-extended respectively. We are not doing that for now to reduce maintenance burden, as it would be unused.

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"

We used to have an alternative extended preset, which added more react-related plugins, but after some testing, it has been integrated into the default preset.

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.