Clean build artifacts locally before linting #4396
Draft
+32
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you run `yarn build` and then run ESLint (either in your editor or the `eslint` CLI), you may see false positives — i.e., you may see lint errors show up on CI, but when you try to reproduce them locally, they mysteriously disappear. I am not 100% sure why this happens, but I believe it's because when the ESLint rules that make use of TypeScript run, TypeScript will parse the type declaration files that were generated via `yarn build` and use them as a reference instead of using the live version of the TypeScript files, so if the type declaration files are out of date, then the results of ESLint will also be out of date. Ensuring that all build artifacts are removed before linting makes these false positives go away. This commit adds a clean step to both `yarn lint` and `yarn lint:fix`, and it also ensures that the clean step precedes the build step for consistency.
mcmire
force-pushed
the
clean-before-linting
branch
from
3befa5e
to
7b1c13e
Compare
|
I tried reproducing an example lint failure that you shared with me on Zoom, and was unable to. I am not totally sure about the premise here, that the linter uses build files. It should be operating just on the source files as far as I know. |
|
Interesting, alright. I too was a bit skeptical of my theory. I'll keep this open in case it comes up again. |
MajorLift
reviewed
Jun 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
If you run
yarn buildand then run ESLint (either in your editor or theeslintCLI), you may see false positives — i.e., you may see lint errors show up on CI, but when you try to reproduce them locally, they mysteriously disappear. I am not 100% sure why this happens, but I believe it's because when the TypeScript-backed ESLint rules run, TypeScript will parse the type declaration files that were generated viayarn buildand use them as a reference instead of using the live version of the TypeScript files, so if the type declaration files are out of date, then the results of ESLint will also be out of date. Ensuring that all build artifacts are removed before linting makes these false positives go away.This commit adds the
lint:clean-onlypackage script and then adds it as a prerequisite forlint,lint:fix, andbuild.References
Changelog
(There are no functional changes in this PR)
Checklist