UNPKG

@git.zone/tsdoc

Version:

A comprehensive TypeScript documentation tool that leverages AI to generate and enhance project documentation, including dynamic README creation, API docs via TypeDoc, and smart commit message generation.

47 lines (46 loc) 1.41 kB
import type { IContextResult, TaskType } from './types.js'; /** * Factory class for creating task-specific context */ export declare class TaskContextFactory { private projectDir; private configManager; /** * Create a new TaskContextFactory * @param projectDirArg The project directory */ constructor(projectDirArg: string); /** * Initialize the factory */ initialize(): Promise<void>; /** * Create context for README generation */ createContextForReadme(): Promise<IContextResult>; /** * Create context for description generation */ createContextForDescription(): Promise<IContextResult>; /** * Create context for commit message generation * @param gitDiff Optional git diff to include */ createContextForCommit(gitDiff?: string): Promise<IContextResult>; /** * Create context for any task type * @param taskType The task type to create context for * @param additionalContent Optional additional content to include */ createContextForTask(taskType: TaskType, additionalContent?: string): Promise<IContextResult>; /** * Get token stats for all task types */ getTokenStats(): Promise<Record<TaskType, { tokenCount: number; savings: number; includedFiles: number; trimmedFiles: number; excludedFiles: number; }>>; }