diff --git a/package.json b/package.json index 09c37fe..1fa8aed 100644 --- a/package.json +++ b/package.json @@ -76,4 +76,4 @@ "url": "https://gitlab.com/gitzone/tsdoc/issues" }, "homepage": "https://gitlab.com/gitzone/tsdoc#readme" -} +} \ No newline at end of file diff --git a/readme.md b/readme.md index 47542a9..557a310 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,5 @@ # @git.zone/tsdoc + An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects. ## Install @@ -50,7 +51,7 @@ tsdoc The `typedoc` command will generate documentation compliant with the TypeDoc format. ```bash -tsdoc typedoc --publicSubdir docs +tsdoc typedoc --publicSubdir docs ``` ### Example @@ -62,7 +63,7 @@ const tsconfigPath = plugins.path.join(__dirname, 'tsconfig.json'); const outputPath = plugins.path.join(__dirname, 'docs'); await plugins.smartshellInstance.exec( - `typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts` + `typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`, ); ``` @@ -243,7 +244,7 @@ import * as plugins from './plugins'; export const packageDir = plugins.path.join( plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), - '../' + '../', ); export const cwd = process.cwd(); export const binDir = plugins.path.join(packageDir, './node_modules/.bin'); @@ -273,7 +274,7 @@ import { AiDoc } from './classes.aidoc'; export const run = async () => { const tsdocCli = new plugins.smartcli.Smartcli(); - tsdocCli.standardCommand().subscribe(async argvArg => { + tsdocCli.standardCommand().subscribe(async (argvArg) => { switch (true) { case await TypeDoc.isTypeDocDir(paths.cwd): tsdocCli.triggerCommand('typedoc', argvArg); @@ -283,14 +284,14 @@ export const run = async () => { } }); - tsdocCli.addCommand('typedoc').subscribe(async argvArg => { + tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => { const typeDocInstance = new TypeDoc(paths.cwd); await typeDocInstance.compile({ - publicSubdir: argvArg.publicSubdir + publicSubdir: argvArg.publicSubdir, }); }); - tsdocCli.addCommand('aidoc').subscribe(async argvArg => { + tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => { const aidocInstance = new AiDoc(argvArg); await aidocInstance.start(); await aidocInstance.buildReadme(paths.cwd); @@ -309,7 +310,7 @@ The `@git.zone/tsdoc` tool is designed to be extensible. Explore the source file ## License and Legal Information -This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. +This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. **Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file. diff --git a/test/test.aidoc.nonci.ts b/test/test.aidoc.nonci.ts index 260b16a..b76f32f 100644 --- a/test/test.aidoc.nonci.ts +++ b/test/test.aidoc.nonci.ts @@ -8,7 +8,7 @@ let aidocs: tsdocs.AiDoc; tap.test('should create an AIdocs class', async () => { aidocs = new tsdocs.AiDoc({ - 'OPENAI_TOKEN': await testQenv.getEnvVarOnDemand('OPENAI_TOKEN') + OPENAI_TOKEN: await testQenv.getEnvVarOnDemand('OPENAI_TOKEN'), }); expect(aidocs).toBeInstanceOf(tsdocs.AiDoc); }); @@ -16,12 +16,11 @@ tap.test('should create an AIdocs class', async () => { tap.test('should start AIdocs', async () => { await aidocs.start(); await aidocs.buildReadme('./'); -}) +}); tap.test('should start AIdocs', async () => { await aidocs.start(); await aidocs.buildDescription('./'); -}) +}); - -tap.start(); \ No newline at end of file +tap.start(); diff --git a/ts/00_commitinfo_data.ts b/ts/00_commitinfo_data.ts index 5333304..a9fb780 100644 --- a/ts/00_commitinfo_data.ts +++ b/ts/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@git.zone/tsdoc', - version: '1.1.30', + version: '1.1.31', description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.' } diff --git a/ts/aidocs_classes/description.ts b/ts/aidocs_classes/description.ts index 939f4b1..f3f6eed 100644 --- a/ts/aidocs_classes/description.ts +++ b/ts/aidocs_classes/description.ts @@ -45,7 +45,7 @@ Don't wrap the JSON in three ticks json!!! console.log(result.message); const resultObject: IDescriptionInterface = JSON.parse( - result.message.replace('```json', '').replace('```', '') + result.message.replace('```json', '').replace('```', ''), ); const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON; diff --git a/ts/aidocs_classes/projectcontext.ts b/ts/aidocs_classes/projectcontext.ts index 7ee2458..a88d57b 100644 --- a/ts/aidocs_classes/projectcontext.ts +++ b/ts/aidocs_classes/projectcontext.ts @@ -13,28 +13,28 @@ export class ProjectContext { public async gatherFiles() { const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath( plugins.path.join(this.projectDir, 'package.json'), - this.projectDir + this.projectDir, ); const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath( plugins.path.join(this.projectDir, 'readme.md'), - this.projectDir + this.projectDir, ); const smartfilesReadmeHints = await plugins.smartfile.SmartFile.fromFilePath( plugins.path.join(this.projectDir, 'readme.hints.md'), - this.projectDir + this.projectDir, ); const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath( plugins.path.join(this.projectDir, 'npmextra.json'), - this.projectDir + this.projectDir, ); const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject( this.projectDir, - 'ts*/**/*.ts' + 'ts*/**/*.ts', ); const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject( this.projectDir, - 'test/**/*.ts' + 'test/**/*.ts', ); return { smartfilePackageJSON, @@ -47,10 +47,10 @@ export class ProjectContext { } public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) { - console.log(`Using the following files for the documentation:`) - filesArg.map(fileArg => { + console.log(`Using the following files for the documentation:`); + filesArg.map((fileArg) => { console.log(` -> ${fileArg.relative}`); - }) + }); return filesArg .map((smartfile) => { return ` diff --git a/ts/aidocs_classes/readme.ts b/ts/aidocs_classes/readme.ts index c66c2ec..a17ccbc 100644 --- a/ts/aidocs_classes/readme.ts +++ b/ts/aidocs_classes/readme.ts @@ -3,7 +3,6 @@ import * as plugins from '../plugins.js'; import { ProjectContext } from './projectcontext.js'; export class Readme { - // INSTANCE private aiDocsRef: AiDoc; private projectDir: string; @@ -21,8 +20,10 @@ export class Readme { const contextString = await projectContext.update(); // lets first check legal before introducung any cost - const npmExtraJson = JSON.parse(((await projectContext.gatherFiles()).smartfilesNpmextraJSON).contents.toString()); - const legalInfo = npmExtraJson?.tsdoc?.legal + const npmExtraJson = JSON.parse( + (await projectContext.gatherFiles()).smartfilesNpmextraJSON.contents.toString(), + ); + const legalInfo = npmExtraJson?.tsdoc?.legal; if (!legalInfo) { const error = new Error(`No legal information found in npmextra.json`); console.log(error); @@ -67,12 +68,9 @@ The Readme should follow the following template: messageHistory: [], userMessage: contextString, }); - finalReadmeString += result.message + '\n' + legalInfo; - - console.log(`\n======================\n`); console.log(result.message); console.log(`\n======================\n`); @@ -83,4 +81,4 @@ The Readme should follow the following template: return result.message; } -} \ No newline at end of file +} diff --git a/ts/classes.aidoc.ts b/ts/classes.aidoc.ts index 308f9aa..823fd30 100644 --- a/ts/classes.aidoc.ts +++ b/ts/classes.aidoc.ts @@ -85,9 +85,7 @@ export class AiDoc { return await descriptionInstance.build(); } - public async buildNextCommit(projectDirArg: string) { - - } + public async buildNextCommit(projectDirArg: string) {} public async getProjectContext(projectDirArg: string) { const projectContextInstance = new aiDocsClasses.ProjectContext(projectDirArg); diff --git a/ts/classes.typedoc.ts b/ts/classes.typedoc.ts index b888837..6291f00 100644 --- a/ts/classes.typedoc.ts +++ b/ts/classes.typedoc.ts @@ -20,15 +20,15 @@ export class TypeDoc { public async compile(options?: { publicSubdir?: string }) { const data = { - "compilerOptions": { - "experimentalDecorators": true, - "useDefineForClassFields": false, - "target": "ES2022", - "module": "NodeNext", - "moduleResolution": "NodeNext", - "esModuleInterop": true, - "verbatimModuleSyntax": true, - "skipLibCheck": true, + compilerOptions: { + experimentalDecorators: true, + useDefineForClassFields: false, + target: 'ES2022', + module: 'NodeNext', + moduleResolution: 'NodeNext', + esModuleInterop: true, + verbatimModuleSyntax: true, + skipLibCheck: true, }, include: [], }; @@ -51,7 +51,7 @@ export class TypeDoc { targetDir = plugins.path.join(targetDir, options.publicSubdir); } await this.smartshellInstance.exec( - `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts` + `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`, ); plugins.smartfile.fs.remove(paths.tsconfigFile); } diff --git a/ts/cli.ts b/ts/cli.ts index e1806de..91a3324 100644 --- a/ts/cli.ts +++ b/ts/cli.ts @@ -36,7 +36,7 @@ export const run = async () => { logger.log('info', `Generating new keywords...`); logger.log('info', `This may take some time...`); aidocInstance.buildDescription(paths.cwd); - }) + }); tsdocCli.addCommand('test').subscribe((argvArg) => { tsdocCli.triggerCommand('typedoc', argvArg); diff --git a/ts/paths.ts b/ts/paths.ts index 8c25e4c..040843d 100644 --- a/ts/paths.ts +++ b/ts/paths.ts @@ -1,7 +1,10 @@ import * as plugins from './plugins.js'; // dirs -export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../'); +export const packageDir = plugins.path.join( + plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), + '../', +); export const cwd = process.cwd(); export const binDir = plugins.path.join(packageDir, './node_modules/.bin'); export const assetsDir = plugins.path.join(packageDir, './assets');