Make KeyPaths not require @ts-ignore #1842
Merged
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
🦋 Changeset detectedLatest commit: 8701588 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
size-limit report 📦
|
Merged
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.
Currently,
KeyPathsrequires a@ts-ignoreline, because TypeScript can't verify thatO[K]is aRecord<string, unknown>.In order to fix this, we can change
KeyPaths<O extends Record<string, unknown>>to justKeyPaths<O>, but internally still verify that when recursing throughO, we only recurse whenO[K] extends Record<string, unknown>.This makes it so that
KeyPathscan be called on any value and I'm not sure if the repercussions of that are relevant. However, we should avoid@ts-ignorein types that are potentially consumed by projects using @primer/react, otherwise we essentially require that they haveskipLibCheck: truein their TS config files.There may be some better way of solving this, but my TypeScript knowledge isn't strong enough to figure it out 😄