From 287096a6730d5e6c7a6c5c0814a9051358195c94 Mon Sep 17 00:00:00 2001 From: Alex Eagle Date: Wed, 6 Dec 2023 08:53:01 -0800 Subject: [PATCH] Update README.md mention that there are other ways to use the linter --- frontend/README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/frontend/README.md b/frontend/README.md index 265149205..2eab25dbe 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -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 [rules_js]: https://docs.aspect.build/rules/aspect_rules_js [rules_lint]: https://github.com/aspect-build/rules_lint