chore(null): Add CI task to check for new files to add to tsconfig.strictNullChecks.json #5918
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
sfoslund
reviewed
Aug 15, 2022
| To ensure these files are included: | ||
| 1) Pull this branch | ||
| 2) Run "yarn null:autoadd" | ||
| 3) Commit and push the resulting change to tsconfig.strictNullChecks.json |
There was a problem hiding this comment.
I'm confused by this logic- the comment at the top of the file says that we're verifying that there are NO changes to tsconfig.strictNullChecks.json, but this error message suggests that we DO want to update that file. What is the actual expected outcome?
There was a problem hiding this comment.
The expected outcome is that CI will pass if this finds no changes and will fail if it does, prompting the author to run it and add those changes manually. This workflow is based on the behavior we use in accessibility-insights-for-android-service to ensure that gradle.lock is kept up-to-date
sfoslund
approved these changes
Aug 15, 2022
| To ensure these files are included: | ||
| 1) Pull this branch | ||
| 2) Run "yarn null:autoadd" | ||
| 3) Commit and push the resulting change to tsconfig.strictNullChecks.json |
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.
Details
Add an additional task to the
lintsCI job to runyarn null:autoaddand determine if there are new files to be added totsconfig.strictNullChecks.jsonfor the PR. If it fails, it will display an error message reminding the author to runyarn null:autoaddand commit the results.Motivation
This will help us work towards #2869 as we add/change files. As things are now, if someone wants to focus on adding some files to
tsconfig.strictNullChecks.jsonin a dedicated PR, they often find a whole host of additional files that could have been added earlier. This PR ensures we expand our strict null checks whenever there are new files to include.Context
Another approach we identified for keeping
tsconfig.strictNullChecks.jsonup to date involves flippingtsconfig.strictNullChecks.jsonto explicitlyexcludefiles instead of usinginclude, thus automatically including new files. This would require adjusting all of our strict null scripts (e.g., autoadd, find, etc.) to follow that convention, which is not an insignificant amount of work.Pull request checklist
yarn fastpassyarn test)<rootDir>/test-results/unit/coveragefix:,chore:,feat(feature-name):,refactor:). SeeCONTRIBUTING.md.