1.2.1

changelog.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 1.2.1
+fix(core): Fixed usage of plugins in project context and readme generation
+
+## 1.2.0
+feat(aidocs_classes): Enhance changelog generation by supporting complete generation in the absence of previous changelog files
+
+## 1.1.42
+fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions
+
+## 1.1.41
+fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@git.zone/tsdoc",
-  "version": "1.1.30",
+  "version": "1.2.1",
   "private": false,
   "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
-  "main": "dist_ts/index.js",
-  "typings": "dist_ts/index.d.ts",
   "type": "module",
-  "author": "Lossless GmbH",
+  "exports": {
+    ".": "./dist_ts/index.js"
+  },
+  "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "bin": {
     "tsdoc": "cli.js"

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.
 

test/test.aidoc.nonci.ts

@@ -8,20 +8,32 @@ 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);
 });
 
 tap.test('should start AIdocs', async () => {
   await aidocs.start();
+});
+
+tap.skip.test('should start AIdocs', async () => {
   await aidocs.buildReadme('./');
-})
+});
 
-tap.test('should start AIdocs', async () => {
+tap.skip.test('should start AIdocs', async () => {
-  await aidocs.start();
   await aidocs.buildDescription('./');
+});
+
+tap.test('should build commit object', async () => {
+  const commitObject = await aidocs.buildNextCommitObject('./');
+  console.log(commitObject);
+  expect(commitObject).not.toBeUndefined();
+  expect(commitObject).toHaveProperty('recommendedNextVersion');
+  expect(commitObject).toHaveProperty('recommendedNextVersionLevel');
+  expect(commitObject).toHaveProperty('recommendedNextVersionScope');
+  expect(commitObject).toHaveProperty('recommendedNextVersionMessage');
+
 })
 
-
+tap.start();
-tap.start();

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@git.zone/tsdoc',
-  version: '1.1.30',
+  version: '1.2.1',
   description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
 }

ts/aidocs_classes/commit.ts

@@ -2,6 +2,14 @@ import * as plugins from '../plugins.js';
 import { AiDoc } from '../classes.aidoc.js';
 import { ProjectContext } from './projectcontext.js';
 
+export interface INextCommitObject {
+  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
+  recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
+  recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
+  recommendedNextVersion: string; // the recommended next version of the project, x.x.x
+  changelog?: string; // the changelog for the next version
+}
+
 export class Commit {
   private aiDocsRef: AiDoc;
   private projectDir: string;
@@ -11,9 +19,23 @@ export class Commit {
     this.projectDir = projectDirArg;
   }
 
-  public async build() {
+  public async buildNextCommitObject(): Promise<INextCommitObject> {
+    const smartgitInstance = new plugins.smartgit.Smartgit();
+    await smartgitInstance.init();
+    const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(
+      smartgitInstance,
+      this.projectDir
+    );
+    const diffString = await gitRepo.getUncommittedDiff();
     const projectContext = new ProjectContext(this.projectDir);
-    const contextString = await projectContext.update();
+    let contextString = await projectContext.update();
+    contextString = `
+${contextString}
+
+Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
+
+${diffString || 'No changes.'}
+    `;
 
     let result = await this.aiDocsRef.openaiInstance.chat({
       systemMessage: `
@@ -28,9 +50,10 @@ Your answer should be parseable with JSON.parse() without modifying anything.
 
 Here is the structure of the JSON you should return:
 {
-  recommendedNextVersionLevel: 'patch' | 'minor' | 'major'; // the recommended next version level of the project
+  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
-  recommendedNextVersion: string; // the recommended next version of the project
+  recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
-  message: string; // the commit message. use conventional commits format
+  recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
+  recommendedNextVersion: string; // the recommended next version of the project, x.x.x
 }
 
 You are being given the files of the project. You should use them to create the commit message.
@@ -41,15 +64,52 @@ Also you are given a diff
       userMessage: contextString,
     });
 
-    console.log(result.message);
+    // console.log(result.message);
-    const resultObject = JSON.parse(result.message.replace('```json', '').replace('```', ''));
+    const resultObject: INextCommitObject = JSON.parse(
+      result.message.replace('```json', '').replace('```', '')
+    );
 
-    const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;
+    // lets build the changelog based on that
-    const npmextraJsonContent = JSON.parse(npmextraJson.contents.toString());
+    const commitMessages = await gitRepo.getAllCommitMessages();
+    const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
+    let previousChangelog: plugins.smartfile.SmartFile;
+    if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
+      previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
+    }
+    let result2 = await this.aiDocsRef.openaiInstance.chat({
+      messageHistory: [],
+      systemMessage: `
+You are building a changelog file for the projext.
+Omit commits and versions that lack relevant changes.
 
-    npmextraJsonContent.gitzone.module.commit = resultObject.message;
+You are given
+* the previous changelog file (if available)
+* the commit messages of the project
 
-    npmextraJson.contents = Buffer.from(JSON.stringify(npmextraJsonContent, null, 2));
+Only return the changelog file, so it can be written directly to changelog.md
-    await npmextraJson.write();
+
+For the latest version, that is not yet part of the commit messages, add a placeholder entry that uses {{nextVersion}} and {{nextVersionMessage}} as variables to filled later.
+Only output newer versions and their changes compared to ones already mentioned. We take of appending your output later.
+If there is no previous changelog file, generate a complete changelog from commit messages with heading and everything + the placeholder section mentioned above.
+      `,
+      userMessage: `
+The previous changelog file is:
+${!previousChangelog ? 'No previous changelog file found' : previousChangelog.contents.toString()}
+
+Here are the commit messages so far:
+
+${commitMessages.join('\n\n')}
+`,
+    });
+    if (previousChangelog) {
+      let newChangelog = result2.message;
+      newChangelog = newChangelog.replace('# Changelog\n\n', '');
+      let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
+      newChangelog = `# Changelog\n\n${newChangelog}\n\n${oldChangelog}`;
+      resultObject.changelog = newChangelog;
+    } else {
+      resultObject.changelog = result2.message;
+    }
+    return resultObject;
   }
 }

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;

ts/aidocs_classes/index.ts

@@ -1,3 +1,4 @@
+export * from './commit.js';
 export * from './description.js';
 export * from './projectcontext.js';
 export * from './readme.js';

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:`)
+    console.log(`Using the following files for the documentation:`);
-    filesArg.map(fileArg => {
+    filesArg.map((fileArg) => {
       console.log(`  -> ${fileArg.relative}`);
-    })
+    });
     return filesArg
       .map((smartfile) => {
         return `

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 npmExtraJson = JSON.parse(
-    const legalInfo = npmExtraJson?.tsdoc?.legal
+      (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;
   }
-}
+}

ts/classes.aidoc.ts

@@ -7,7 +7,7 @@ export class AiDoc {
 
   public npmextraKV: plugins.npmextra.KeyValueStore;
   public qenvInstance: plugins.qenv.Qenv;
-  public smartinteractInstance: plugins.smartinteract.SmartInteract;
+  public aidocInteract: plugins.smartinteract.SmartInteract;
   public openaiInstance: plugins.smartai.OpenAiProvider;
 
   argvArg: any;
@@ -33,7 +33,7 @@ export class AiDoc {
 
   public async start() {
     // lets care about prerequisites
-    this.smartinteractInstance = new plugins.smartinteract.SmartInteract();
+    this.aidocInteract = new plugins.smartinteract.SmartInteract();
     this.qenvInstance = new plugins.qenv.Qenv();
     if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
       this.npmextraKV = new plugins.npmextra.KeyValueStore({
@@ -51,9 +51,9 @@ export class AiDoc {
           // lets try smartinteract
           // wait for a second until OpenAI fixes punycode problem...
           await plugins.smartdelay.delayFor(1000);
-          const answerObject = await this.smartinteractInstance.askQuestion({
+          const answerObject = await this.aidocInteract.askQuestion({
             type: 'input',
-            message: `Please provide your OpenAI token`,
+            message: `Please provide your OpenAI token. This will be persisted in your home directory.`,
             name: 'OPENAI_TOKEN',
             default: '',
           });
@@ -85,8 +85,9 @@ export class AiDoc {
     return await descriptionInstance.build();
   }
 
-  public async buildNextCommit(projectDirArg: string) {
+  public async buildNextCommitObject(projectDirArg: string) {
-    
+    const commitInstance = new aiDocsClasses.Commit(this, projectDirArg);
+    return await commitInstance.buildNextCommitObject();
   }
 
   public async getProjectContext(projectDirArg: string) {

ts/classes.typedoc.ts

@@ -20,15 +20,15 @@ export class TypeDoc {
 
   public async compile(options?: { publicSubdir?: string }) {
     const data = {
-      "compilerOptions": {
+      compilerOptions: {
-        "experimentalDecorators": true,
+        experimentalDecorators: true,
-        "useDefineForClassFields": false,
+        useDefineForClassFields: false,
-        "target": "ES2022",
+        target: 'ES2022',
-        "module": "NodeNext",
+        module: 'NodeNext',
-        "moduleResolution": "NodeNext",
+        moduleResolution: 'NodeNext',
-        "esModuleInterop": true,
+        esModuleInterop: true,
-        "verbatimModuleSyntax": true,
+        verbatimModuleSyntax: true,
-        "skipLibCheck": 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);
   }

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);

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');