1.3.3

changelog.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## 2024-06-23 - 1.3.3 - fix(aidocs_classes)
+Fix minor bugs and update dependencies in aidocs_classes
+- Fixed typo in INextCommitObject interface within the aidocs_classes.
+- Updated date format in changelog generation from European format to hyphened sortable format.
+- Updated @push.rocks/smartgit dependency from version 3.0.4 to 3.1.0.
+- Updated typedoc dependency from version 0.26.0 to 0.26.1.
+- Improved commit message generation by adding handling for empty diffs and updating changelog instructions.
+
+
+## 23.06.2024 - 1.3.2 - fix(aidocs_classes)
+Fix typo in INextCommitObject interface and update date format in changelog generation.
+- Corrected typo in INextCommitObject interface within the aidocs_classes directory.
+- Updated date format in changelog generation from European format to hyphened sortable format.
+
+## 2023-xx-xx - 1.3.1 - aidocs_classes
+Fix typo in INextCommitObject interface
+- Corrected a minor typo in the INextCommitObject interface for consistency.
+
+## 2023-xx-xx - 1.3.0 - core
+Added smarttime dependency and improved changelog generation
+- Introduced smarttime dependency to the core module.
+- Enhanced changelog generation to be more efficient.
+
+## 2023-xx-xx - 1.2.4 - logging
+Refactor logger initialization to use commitinfo data
+- Logger initialization now utilizes commitinfo data for better context and accuracy.
+
+## 2023-xx-xx - 1.2.3 - aidocs
+Fix bug in AiDoc class causing undefined token handling
+- Resolved an issue in the AiDoc class where undefined tokens were not being handled correctly.
+
+## 2023-xx-xx - 1.2.1 - core
+Fixed usage of plugins in project context and readme generation
+- Improved the usage of plugins within the project context.
+- Fixed issues related to README.md generation.
+
+## 2023-xx-xx - 1.2.0 - aidocs_classes
+Enhance changelog generation by supporting complete generation in the absence of previous changelog files
+- Updated changelog generation to support complete generation even when previous changelog files are absent.
+
+## 2023-xx-xx - 1.1.42 - aidoc_classes
+Improve commit message generation by handling empty diffs and updating changelog instructions
+- Enhanced commit message generation to handle empty diffs.
+- Updated instructions for changelog generation for better clarity.
+

package.json

@@ -1,12 +1,13 @@
 {
   "name": "@git.zone/tsdoc",
-  "version": "1.1.30",
+  "version": "1.3.3",
   "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"
@@ -32,13 +33,14 @@
     "@push.rocks/smartcli": "^4.0.11",
     "@push.rocks/smartdelay": "^3.0.5",
     "@push.rocks/smartfile": "^11.0.20",
-    "@push.rocks/smartgit": "^3.0.4",
+    "@push.rocks/smartgit": "^3.1.0",
     "@push.rocks/smartinteract": "^2.0.15",
     "@push.rocks/smartlog": "^3.0.7",
     "@push.rocks/smartlog-destination-local": "^9.0.2",
     "@push.rocks/smartpath": "^5.0.18",
     "@push.rocks/smartshell": "^3.0.5",
-    "typedoc": "^0.26.0",
+    "@push.rocks/smarttime": "^4.0.6",
+    "typedoc": "^0.26.1",
     "typescript": "^5.5.2"
   },
   "files": [

pnpm-lock.yaml

@@ -30,8 +30,8 @@ importers:
         specifier: ^11.0.20
         version: 11.0.20
       '@push.rocks/smartgit':
-        specifier: ^3.0.4
+        specifier: ^3.1.0
-        version: 3.0.4
+        version: 3.1.0
       '@push.rocks/smartinteract':
         specifier: ^2.0.15
         version: 2.0.15
@@ -47,9 +47,12 @@ importers:
       '@push.rocks/smartshell':
         specifier: ^3.0.5
         version: 3.0.5
+      '@push.rocks/smarttime':
+        specifier: ^4.0.6
+        version: 4.0.6
       typedoc:
-        specifier: ^0.26.0
+        specifier: ^0.26.1
-        version: 0.26.0(typescript@5.5.2)
+        version: 0.26.1(typescript@5.5.2)
       typescript:
         specifier: ^5.5.2
         version: 5.5.2
@@ -429,8 +432,8 @@ packages:
   '@push.rocks/smartfile@11.0.20':
     resolution: {integrity: sha512-gJERlNE2fNah9HLq6W3srcl1GZwlz2vFVZRmb50TQLabmWF4qyTlaMYAwY8ffgf8np4TsHAa4s+kL5F0zUfUUg==}
 
-  '@push.rocks/smartgit@3.0.4':
+  '@push.rocks/smartgit@3.1.0':
-    resolution: {integrity: sha512-6uYifD4rGjTp6KO8kdaVenXeef0uZOfQSTuLuG3+ubpMXwZNSp0iQWx+XgS5pQipzG0+3p4ddnQ7/R8gm7LWOg==}
+    resolution: {integrity: sha512-a3LbECFQSURkJc9t8CGJrzv7ZzfG1c83x424nb6jfj3jVJXCqjMvs1AkmpkUiro77J7yg4CavTu8vslAfrPIOw==}
 
   '@push.rocks/smarthash@3.0.4':
     resolution: {integrity: sha512-HJ/fSx41jm0CvSaqMLa6b2nuNK5rHAqAeAq3dAB7Sq9BCPm2M0J5ZVDTzEAH8pS91XYniUiwuE0jwPERNn9hmw==}
@@ -1924,8 +1927,8 @@ packages:
     resolution: {integrity: sha512-LpB/54B+/2J5hqQ7imZHfdU31OlgQqx7ZicVlkm9kzg9/w8GKLEcFfJl/t7DCEDueOyBAD6zCCwTO6Fzs0NoEQ==}
     engines: {node: '>=16'}
 
-  isomorphic-git@1.25.10:
+  isomorphic-git@1.26.2:
-    resolution: {integrity: sha512-IxGiaKBwAdcgBXwIcxJU6rHLk+NrzYaaPKXXQffcA0GW3IUrQXdUPDXDo+hkGVcYruuz/7JlGBiuaeTCgIgivQ==}
+    resolution: {integrity: sha512-swKxfDm/GyaU5ojGwKtfs3EiHwlUf3iP1iIHPduaJHA5y1cIzMDFo3ogwdW6i00UmAjYQNKyF2BZgj/jz58/2A==}
     engines: {node: '>=12'}
     hasBin: true
 
@@ -3015,8 +3018,8 @@ packages:
     resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==}
     engines: {node: '>= 0.6'}
 
-  typedoc@0.26.0:
+  typedoc@0.26.1:
-    resolution: {integrity: sha512-OcYevjHsMN8DfpaL0dSBGAEBhOxuBB5Au8QVs9oz9iB0kRStPZwXLFWqh9gwbMUxNjW3yQuIM5GrVVauMJ2Akw==}
+    resolution: {integrity: sha512-APsVXqh93jTlpkLuw6+/IORx7n5LN8hzJV8nvMIrYYaIva0VCq0CoDN7Z3hsRThEYVExI/qoFHnAAxrhG+Wd7Q==}
     engines: {node: '>= 18'}
     hasBin: true
     peerDependencies:
@@ -3864,7 +3867,7 @@ snapshots:
       glob: 10.4.1
       js-yaml: 4.1.0
 
-  '@push.rocks/smartgit@3.0.4':
+  '@push.rocks/smartgit@3.1.0':
     dependencies:
       '@push.rocks/smartenv': 5.0.12
       '@push.rocks/smartfile': 11.0.20
@@ -3872,10 +3875,11 @@ snapshots:
       '@push.rocks/smartpromise': 4.0.3
       '@push.rocks/smartshell': 3.0.5
       '@push.rocks/smartstring': 4.0.15
+      '@push.rocks/smarttime': 4.0.6
       '@types/diff': 5.2.1
       '@types/minimatch': 5.1.2
       diff: 5.2.0
-      isomorphic-git: 1.25.10
+      isomorphic-git: 1.26.2
 
   '@push.rocks/smarthash@3.0.4':
     dependencies:
@@ -5798,7 +5802,7 @@ snapshots:
 
   isexe@3.1.1: {}
 
-  isomorphic-git@1.25.10:
+  isomorphic-git@1.26.2:
     dependencies:
       async-lock: 1.4.1
       clean-git-ref: 2.0.1
@@ -7155,7 +7159,7 @@ snapshots:
       media-typer: 0.3.0
       mime-types: 2.1.35
 
-  typedoc@0.26.0(typescript@5.5.2):
+  typedoc@0.26.1(typescript@5.5.2):
     dependencies:
       lunr: 2.3.9
       markdown-it: 14.1.0

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.3.3',
   description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
 }

ts/aidocs_classes/commit.ts

@@ -2,6 +2,15 @@ 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.
+  recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
+  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 +20,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: `
@@ -27,10 +50,13 @@ Important: Answer only in valid JSON.
 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
+interface {
-  recommendedNextVersion: string; // the recommended next version of the project
+  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
-  message: string; // the commit message. use conventional commits format
+  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.
+  recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
+  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 +67,58 @@ 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;
+    const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
-    const npmextraJsonContent = JSON.parse(npmextraJson.contents.toString());
+    let previousChangelog: plugins.smartfile.SmartFile;
+    if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
+      previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
+    }
 
-    npmextraJsonContent.gitzone.module.commit = resultObject.message;
+    if (!previousChangelog) {
+      // lets build the changelog based on that
+      const commitMessages = await gitRepo.getAllCommitMessages();
+      let result2 = await this.aiDocsRef.openaiInstance.chat({
+        messageHistory: [],
+        systemMessage: `
+You are building a changelog.md file for the project.
+Omit commits and versions that lack relevant changes.
 
-    npmextraJson.contents = Buffer.from(JSON.stringify(npmextraJsonContent, null, 2));
+A changelog entry should look like this:
-    await npmextraJson.write();
+
+    ## yyyy-mm-dd - x.x.x - scope here
+    main descriptiom here
+    - detailed bullet points follow
+
+You are given:
+* the commit messages of the project
+
+Only return the changelog file, so it can be written directly to changelog.md`,
+        userMessage: `
+Here are the commit messages:
+
+${JSON.stringify(commitMessages, null, 2)}
+  `,
+      });
+
+      previousChangelog = await plugins.smartfile.SmartFile.fromString(
+        previousChangelogPath,
+        result2.message,
+        'utf8'
+      );
+    }
+
+    let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
+    let newDateString = new plugins.smarttime.ExtendedDate().exportToHyphedSortableDate();
+    let newChangelog = `# Changelog\n\n${`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
+{{nextVersionMessage}}
+{{nextVersionDetails}}
+`}\n\n${oldChangelog}\n`;
+    resultObject.changelog = newChangelog;
+
+    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}`);
+      // 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/logging.ts

@@ -1,15 +1,6 @@
+import { commitinfo } from './00_commitinfo_data.js';
 import * as plugins from './plugins.js';
 
-export const logger = new plugins.smartlog.Smartlog({
+export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
-  logContext: {
-    company: 'Some Company',
-    companyunit: 'Some CompanyUnit',
-    containerName: 'Some Containername',
-    environment: 'local',
-    runtime: 'node',
-    zone: 'gitzone',
-  },
-  minimumLogLevel: 'silly',
-});
 
 logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());

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

ts/plugins.ts

@@ -16,6 +16,7 @@ import * as smartlog from '@push.rocks/smartlog';
 import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
 import * as smartpath from '@push.rocks/smartpath';
 import * as smartshell from '@push.rocks/smartshell';
+import * as smarttime from '@push.rocks/smarttime';
 
 export {
   npmextra,
@@ -30,6 +31,7 @@ export {
   smartlogDestinationLocal,
   smartpath,
   smartshell,
+  smarttime,
 };
 
 // third party scope