Skip to content

Commit

Permalink
Update README.md (#375)
Browse files Browse the repository at this point in the history
mention that there are other ways to use the linter
  • Loading branch information
alexeagle authored Dec 6, 2023
1 parent a606e28 commit b498bb1
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,13 @@ This allows npm packages within this monorepo to depend on each other.
## Linting

We demonstrate the usage of [rules_lint]. There are a few ways to wire this up, we show two:
- in the `next.js/` folder, `npm run lint` does a `bazel build` with a config setting that makes the build fail when lint violations are found.
- in the `react` folder, an `eslint_test` target results in test failures when lint violations are found.
- *build failure*: in the `next.js/` folder, `npm run lint` does a `bazel build` with a config setting that makes the build fail when lint violations are found.
- *test failure*: in the `react` folder, an `eslint_test` target results in test failures when lint violations are found.

However, in both cases this inhibits creation of new lint rules or even upgrading the linter, because it requires updating the entire repository to fix or suppress
new lint violations at the same time.
We recommend showing lint results during code review instead.
See <https://github.com/aspect-build/rules_lint/blob/main/docs/linting.md>

[rules_js]: https://docs.aspect.build/rules/aspect_rules_js
[rules_lint]: https://github.com/aspect-build/rules_lint

0 comments on commit b498bb1

Please sign in to comment.