Skip to content

React: Respect tsconfigPath option in react-docgen-typescript parser #34390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Muhammad-Nur-Alamsyah-Anwar wants to merge 3 commits into from
Closed

React: Respect tsconfigPath option in react-docgen-typescript parser #34390

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bbe4cbd
React: Respect tsconfigPath option in react-docgen-typescript parser
Muhammad-Nur-Alamsyah-Anwar Mar 29, 2026
300233a
chore: fix formatting
Muhammad-Nur-Alamsyah-Anwar Mar 30, 2026
bfaa03b
handle tsconfig read errors gracefully
Muhammad-Nur-Alamsyah-Anwar Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions code/renderers/react/src/componentManifest/reactDocgenTypescript.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { dirname } from 'node:path';
import { dirname, resolve } from 'node:path';

import {
type ComponentDoc,
Expand Down Expand Up @@ -192,18 +192,25 @@ async function getParser(userOptions?: ParserOptions) {
}

if (!parser) {
const configPath = findTsconfigPath(process.cwd());
// If the user provided a tsconfigPath, use it instead of auto-detecting
const { tsconfigPath: customTsconfigPath, ...restUserOptions } = (userOptions ??
{}) as ParserOptions & { tsconfigPath?: string };
const configPath = customTsconfigPath
? resolve(process.cwd(), customTsconfigPath)
: findTsconfigPath(process.cwd());
cachedCompilerOptions = { noErrorTruncation: true, strict: true };

if (configPath) {
const { config } = typescript.readConfigFile(configPath, typescript.sys.readFile);
const parsed = typescript.parseJsonConfigFileContent(
config,
typescript.sys,
dirname(configPath)
);
cachedCompilerOptions = { ...parsed.options, noErrorTruncation: true };
cachedFileNames = parsed.fileNames;
const { config, error } = typescript.readConfigFile(configPath, typescript.sys.readFile);
if (!error && config) {
const parsed = typescript.parseJsonConfigFileContent(
config,
typescript.sys,
dirname(configPath)
);
cachedCompilerOptions = { ...parsed.options, noErrorTruncation: true };
cachedFileNames = parsed.fileNames;
}
}

const program = typescript.createProgram(
Expand All @@ -217,7 +224,7 @@ async function getParser(userOptions?: ParserOptions) {
const parserOptions: ParserOptions = {
shouldExtractLiteralValuesFromEnum: true,
shouldRemoveUndefinedFromOptional: true,
...userOptions,
...restUserOptions,
// Always force savePropValueAsString so default values are in a consistent format
savePropValueAsString: true,
};
Expand Down
Loading