Repository navigation
fix: extract props from builtin Readonly wrappers - #1147
Open
blueDaydreaming725 wants to merge 1 commit into
Open
blueDaydreaming725 wants to merge 1 commit into
blueDaydreaming725 wants to merge 1 commit into
Conversation
✅ Deploy Preview for react-docgen ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🦋 Changeset detectedLatest commit: 4f9ab8d The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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 |
This branch has not been deployed
This file contains hidden or 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
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
Components whose props are annotated as
Readonly<Props>lose their prop types and descriptions. The existing wrapper resolver recognises React's prop wrappers but leaves the builtin TypeScriptReadonlyreference unresolved.Extend that resolver to unwrap the global
Readonlyutility, using the existing name resolver to preserve local type aliases, interfaces and imports namedReadonly. Nested wrappers reuse the existing recursion; no public API or dependency changes are needed.Fixes #905.
Validation
parse()regression fail before the fix (3 failures).git diff --checkpassed.Coverage includes nested wrappers, local same-name declarations/imports and absent type arguments. Website and CLI package suites were not run. Includes a patch changeset.