ts-morph-analyze

TypeScript Code Analysis with ts-morph

Analyze TypeScript code structure to extract APIs, signatures, and relationships without implementation details.

Installation

cd .claude/skills/ts-morph-analyze
pnpm install

Available Scripts

summarize-class.ts

Extract the API signature of a class or interface, showing only public members without implementation.

Usage:

npx tsx scripts/summarize-class.ts <tsconfig> <file> <name> [--private] [--jsdoc]

Parameters:

Example:

npx tsx scripts/summarize-class.ts ./tsconfig.json src/nodes/types.ts ExecutableNode

Output:

export abstract class ExecutableNode {
  readonly nodeId: string;
  constructor(nodeId: string);
  abstract execute(ctx: Context): Promise<Response>;
  protected createResponse(status: number, data: unknown): Response;
}

list-exports.ts

List all exports from a file or directory with their types and signatures.

Usage:

npx tsx scripts/list-exports.ts <tsconfig> <path> [--recursive] [--types-only] [--functions-only] [--classes-only]

Parameters:

Example:

npx tsx scripts/list-exports.ts ./tsconfig.json src/utils/

Output:

src/utils/string.ts:
  export function formatDate(date: Date): string
  export function parseJSON<T>(input: string): Result<T>
  export type Result<T> = { success: true; value: T } | { success: false; error: string }

src/utils/validation.ts:
  export function validateEmail(email: string): boolean
  export interface ValidationResult { valid: boolean; errors: string[] }

show-hierarchy.ts

Display the inheritance hierarchy for a class, showing parent classes and implemented interfaces.

Usage:

npx tsx scripts/show-hierarchy.ts <tsconfig> <file> <class-name> [--descendants] [--depth=N]

Parameters:

Example:

npx tsx scripts/show-hierarchy.ts ./tsconfig.json src/nodes/text-node.ts TextNode --descendants

Output:

TextNode
├── extends: ExecutableNode
│   └── implements: NodeInterface
└── descendants:
    ├── MarkdownNode
    └── HtmlNode

extract-interface.ts

Generate a TypeScript interface from a class's public members.

Usage:

npx tsx scripts/extract-interface.ts <tsconfig> <file> <class-name> [--name=InterfaceName] [--include-protected]

Parameters:

Example:

npx tsx scripts/extract-interface.ts ./tsconfig.json src/services/user.ts UserService --name=IUserService

Output:

export interface IUserService {
  readonly id: string;
  getName(): string;
  getEmail(): Promise<string>;
  update(data: UserData): Promise<void>;
}

Use Cases

• API Review: Quickly understand a class's public interface
• Documentation: Generate API summaries for documentation
• Refactoring Planning: See inheritance relationships before changes
• Interface Extraction: Create interfaces from existing implementations
• Codebase Exploration: List exports to understand module structure

Output Formats

All scripts output TypeScript syntax by default. The output can be:

• Piped to a file: npx tsx scripts/summarize-class.ts ... > api.d.ts
• Used for documentation
• Compared with git diff to track API changes