@git.zone/tsdoc
Version:
An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
25 lines (24 loc) • 1.08 kB
TypeScript
import * as plugins from './plugins.js';
import * as aiDocsClasses from './aidocs_classes/index.js';
export declare class AiDoc {
private openaiToken;
npmextraKV: plugins.npmextra.KeyValueStore;
qenvInstance: plugins.qenv.Qenv;
aidocInteract: plugins.smartinteract.SmartInteract;
openaiInstance: plugins.smartai.OpenAiProvider;
argvArg: any;
constructor(argvArg?: any);
private printSanitizedToken;
start(): Promise<void>;
buildReadme(projectDirArg: string): Promise<string>;
buildDescription(projectDirArg: string): Promise<string>;
buildNextCommitObject(projectDirArg: string): Promise<aiDocsClasses.INextCommitObject>;
getProjectContext(projectDirArg: string): Promise<{
smartfilePackageJSON: plugins.smartfile.SmartFile;
smartfilesReadme: plugins.smartfile.SmartFile;
smartfilesReadmeHints: plugins.smartfile.SmartFile;
smartfilesNpmextraJSON: plugins.smartfile.SmartFile;
smartfilesMod: plugins.smartfile.SmartFile[];
smartfilesTest: plugins.smartfile.SmartFile[];
}>;
}