refactor(site): match v1 tsconfig; simplify tsconfig.test.json #426
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
Summary of changes: * ordered configurations for ease of readability * allowJs removed -> not needed after Next.js * noImplicitAny removed -> this is set to true by strict * strictNullChecks removed -> this is set to true by strict * removed lingering next-env.d.ts in include
Because that the base tsconfig was simplified when changing from Next.js, this one now duplicates most of it. I still believe having a separate tsconfig is a good idea for the purposes of separating tests from source code. It especially can make it easier for eslint and jest performance.
kylecarbs
approved these changes
Mar 13, 2022
Codecov Report
@@ Coverage Diff @@
## main #426 +/- ##
==========================================
- Coverage 68.29% 68.23% -0.07%
==========================================
Files 159 159
Lines 9226 9226
Branches 73 73
==========================================
- Hits 6301 6295 -6
- Misses 2305 2312 +7
+ Partials 620 619 -1
Continue to review full report at Codecov.
|
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.
Summary (a1164f4)
Matched the
tsconfig.jsonpost migration to webpack with that of v1Details
allowJsremoved -> not needed after Next.jsnext-env.d.tsfrom fileincludesnoImplicitAnyremoved -> this is set totruebystrictand is really only meaningful when being selectively stricttruebystrictand is really only meaningful when being selectively strictImpact of Changes
There is no observable impact (this is just a refactor), outside of readability and parity with v1.
Why re-order?
Sometimes using an arbitrary ordering means more scans (think like a O(N) search) to figure out what properties are configured. In the case of TS configuration, I think alphabetical makes sense because the configurations are usually small. In other cases, it's helpful to have logical groupings. In other words, this improvement is in theme of "at a glance behaviors": being able to retrieve information "at a glance" without having to search for it.
Summary (7e195d3)
Greatly simplified the
tsconfig.test.jsongiven the changes that happened to the basetsconfig.jsonfrom the migration. Thetsconfig.test.jsonwas duplicating properties that were already configured in the basetsconfig.json! The only real difference now is theincludes/excludes, which makes sense given that one is meant for the test project, and not the other. Having parity on all other configurations means less "magic" between these scenarios.Impact of Changes