React: resolve RDT referenced tsconfigs#34800
Open
ia319 wants to merge 3 commits into
Open
Conversation
- select the tsconfig that contains each component file - follow project references when the root config has no source files - cache parsers by tsconfig and react-docgen-typescript options - index parsed tsconfig file names to avoid repeated linear scans
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR refactors TypeScript parser management in the React component manifest to resolve and cache TypeScript programs per-file by finding the tsconfig that owns a file (including projectReferences), and caches/rebuilds ts.Program and react-docgen-typescript FileParser instances keyed by (tsconfigPath, parserOptions). ChangesPer-file tsconfig parser resolution and caching
Sequence Diagram(s) sequenceDiagram
participant API as parseWithReactDocgenTypescript
participant GetParser as getParser(filePath, userOptions)
participant TsconfigLookup as findTsconfigForFile
participant Cache as program/fileParser cache
participant Parser as react-docgen-typescript FileParser
API->>GetParser: request parser for filePath
GetParser->>TsconfigLookup: resolve tsconfig owning filePath
TsconfigLookup-->>GetParser: tsconfig path
GetParser->>Cache: lookup (tsconfigPath, userOptions)
alt cache hit
Cache-->>GetParser: return cached Program/FileParser
else cache miss
GetParser->>Parser: build ts.Program + FileParser
Parser-->>GetParser: FileParser instance
GetParser->>Cache: store Program/FileParser
end
GetParser-->>API: Program, FileParser, typescript
API->>Parser: parse(filePath) using resolved parser
Estimated code review effort🎯 4 (Complex) | ⏱️ ~75 minutes Possibly related PRs
Comment |
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.
Closes #34710
What I did
Root cause:
RDT only used the root
tsconfig.jsonresolved fromprocess.cwd()when parsing component manifest props.In the Vite React TS sandbox, the root
tsconfig.jsononly contains:{ "files": [], "references": [{ "path": "./tsconfig.app.json" }] }As a result, the parser output becomes:
Storybook then creates the TypeScript program using this empty root config. Since
Button.tsxis not included in the program,react-docgen-typescriptcannot find the component docs and returns an empty array. The manifest is therefore generated with:Changes:
When generating the component manifest, RDT now selects the
tsconfigthat actually contains the current component file.tsconfig.json, it traversesprojectReferencesto find the referencedtsconfigthat includes the component file.tsconfigis then used to create the TypeScript program and RDT parser, instead of always using the root config.tsconfig+ parser options, and a file-to-tsconfigindex is maintained to avoid repeated scans.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Verification steps:
cd /home/ia/front-end/storybook-sandboxes/react-vite-default-ts.storybook/main.tsto enable RDT:node -e "const fs=require('fs'); const m=JSON.parse(fs.readFileSync('storybook-static/manifests/components.json','utf8')); console.log(m.components['example-button']);"Before the fix, the output shows:
and the Button props are missing.
After the fix,
example-button.reactDocgenTypescript.propsincludes:Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit
Improvements
Tests