Parser Configuration

/**
 * Constructs a parser for a default configuration
 * @param parserOpts - Parser options for customizing behavior
 * @returns FileParser instance with default TypeScript config
 */
function withDefaultConfig(parserOpts: ParserOptions = defaultParserOpts): FileParser;

import { withDefaultConfig } from "react-docgen-typescript";

// Create parser with custom options
const parser = withDefaultConfig({
  propFilter: {
    skipPropsWithName: ['className', 'style'],
    skipPropsWithoutDoc: true
  },
  shouldExtractLiteralValuesFromEnum: true
});

// Use the parser multiple times
const buttonDocs = parser.parse("./src/Button.tsx");
const inputDocs = parser.parse("./src/Input.tsx");

/**
 * Constructs a parser for a specified tsconfig file
 * @param tsconfigPath - Path to tsconfig.json file
 * @param parserOpts - Parser options for customizing behavior
 * @returns FileParser instance with custom TypeScript config
 * @throws Error when tsconfig cannot be loaded or parsed
 */
function withCustomConfig(
  tsconfigPath: string,
  parserOpts: ParserOptions
): FileParser;

import { withCustomConfig } from "react-docgen-typescript";

// Use project's tsconfig.json
const parser = withCustomConfig("./tsconfig.json", {
  savePropValueAsString: true
});

// Use specific tsconfig for documentation
const parser = withCustomConfig("./tsconfig.docs.json", {
  shouldExtractValuesFromUnion: true,
  componentNameResolver: (exp, source) => {
    // Custom component name resolution logic
    return exp.getName() === "default" ? "MyComponent" : exp.getName();
  }
});

const docs = parser.parse("./src/components/*.tsx");

/**
 * Constructs a parser for a specified set of TS compiler options
 * @param compilerOptions - TypeScript compiler options
 * @param parserOpts - Parser options for customizing behavior
 * @returns FileParser instance with specified compiler options
 */
function withCompilerOptions(
  compilerOptions: ts.CompilerOptions,
  parserOpts: ParserOptions = defaultParserOpts
): FileParser;

import { withCompilerOptions } from "react-docgen-typescript";
import * as ts from "typescript";

// Custom compiler options
const parser = withCompilerOptions(
  {
    jsx: ts.JsxEmit.ReactJSX,
    target: ts.ScriptTarget.ES2020,
    moduleResolution: ts.ModuleResolutionKind.NodeJs,
    strict: true,
    esModuleInterop: true
  },
  {
    shouldExtractLiteralValuesFromEnum: true,
    shouldSortUnions: true
  }
);

const docs = parser.parse("./src/ModernComponent.tsx");

interface FileParser {
  /**
   * Parse component files and return documentation
   * @param filePathOrPaths - Single file path or array of paths
   * @returns Array of component documentation
   */
  parse(filePathOrPaths: string | string[]): ComponentDoc[];
  
  /**
   * Parse with custom TypeScript program provider
   * @param filePathOrPaths - Single file path or array of paths  
   * @param programProvider - Function that returns TypeScript Program
   * @returns Array of component documentation
   */
  parseWithProgramProvider(
    filePathOrPaths: string | string[],
    programProvider?: () => ts.Program
  ): ComponentDoc[];
}

import { withDefaultConfig } from "react-docgen-typescript";

// Create shared parser for consistent configuration
const sharedParser = withDefaultConfig({
  propFilter: {
    skipPropsWithName: ['className', 'style', 'children'],
    skipPropsWithoutDoc: true
  },
  shouldExtractLiteralValuesFromEnum: true,
  savePropValueAsString: true
});

// Use across multiple parsing operations
const componentDocs = [
  ...sharedParser.parse("./src/components/Button.tsx"),
  ...sharedParser.parse("./src/components/Input.tsx"),
  ...sharedParser.parse("./src/components/Modal.tsx")
];

import { withCompilerOptions } from "react-docgen-typescript";
import * as ts from "typescript";

const compilerOptions = {
  jsx: ts.JsxEmit.React,
  target: ts.ScriptTarget.ES2019,
  moduleResolution: ts.ModuleResolutionKind.NodeJs
};

const parser = withCompilerOptions(compilerOptions);

// Create TypeScript program once for multiple parses
const filePaths = ["./src/Button.tsx", "./src/Input.tsx"];
const program = ts.createProgram(filePaths, compilerOptions);

const docs = parser.parseWithProgramProvider(filePaths, () => program);

import { withCustomConfig } from "react-docgen-typescript";

try {
  const parser = withCustomConfig("./invalid-tsconfig.json", {});
} catch (error) {
  // Handle configuration errors
  if (error.message.includes("Cannot load custom tsconfig.json")) {
    console.error("Invalid tsconfig path:", error.message);
  }
}