Enforce tilde ranges for packages with type definitions #6971
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
mxdvl
force-pushed
the
mxdvl/types-mismatch-fix
branch
from
a887fb1 to
cb5be70
Compare
mxdvl
changed the title
|
Size Change: 0 B Total Size: 2.98 MB ℹ️ View Unchanged
|
⚡️ Lighthouse report for the changes in this PRLighthouse tested 2 URLs Report for Article
Report for Front
|
mxdvl
force-pushed
the
mxdvl/types-mismatch-fix
branch
3 times, most recently
from
fdbced7 to
a12762b
Compare
30 tasks
mxdvl
force-pushed
the
mxdvl/types-mismatch
branch
from
df51e7c to
453ded8
Compare
Use tilde ranges for packages with a type definition, as this is what the contract from DefinitelyTyped expects https://github.com/DefinitelyTyped/DefinitelyTyped#how-do-definitely-typed-package-versions-relate-to-versions-of-the-corresponding-library https://github.com/npm/node-semver#tilde-ranges-123-12-1
mxdvl
force-pushed
the
mxdvl/types-mismatch-fix
branch
from
17235e2 to
4727604
Compare
This was referenced Jan 20, 2023
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.
What does this change?
Enforce the
~tilde range syntax for@types/*packages and their matching source, as this is the only one that guarantees a matching version, as per the DefinitelyTyped contract.Leave @type packages without a source as-is.
Example of successful run: https://github.com/guardian/dotcom-rendering/actions/runs/3938014495/jobs/6736198283
Why?
Builds on top of #6966 for a stricter check and possibly enforce a CI check to fail
Mismatches in @types packages significantly reduce any type safety gained by using TypeScript.
Closes #6965
Example