1.4.4

changelog.md

@@ -0,0 +1,109 @@
+# Changelog
+
+## 2025-02-25 - 1.4.4 - fix(dependencies)
+Update dependencies to latest versions
+
+- Updated '@push.rocks/smartai' from '^0.0.17' to '^0.4.2'
+- Updated 'typedoc' from '^0.26.1' to '^0.27.9'
+
+## 2025-01-14 - 1.4.3 - fix(aidocs_classes)
+Improve readme generation instructions to ensure correct markdown formatting.
+
+- Added guidance to avoid using backticks at the beginning and end of readme generation to prevent markdown issues.
+- Clarified that the output is directly written to readme.md and backticks should only be used for code blocks.
+
+## 2024-10-28 - 1.4.2 - fix(cli)
+Ensure async completion for aidoc readme and description generation
+
+- Added await statements for asynchronous methods buildReadme and buildDescription in the aidoc command.
+
+## 2024-10-28 - 1.4.1 - fix(readme)
+Correct async call to getModuleSubDirs in readme generation.
+
+- Fixed an issue with asynchronous handling in readme generation for submodules.
+- Ensured that getModuleSubDirs function is called with await to handle promises properly.
+
+## 2024-10-28 - 1.4.0 - feat(aidocs)
+Added support for building readmes for sub-modules in aidocs
+
+- Updated the `Readme` class to handle monorepo projects by generating readmes for sub-modules.
+- Integrated `tspublish` to identify sub-modules for readme generation.
+
+## 2024-06-24 - 1.3.12 - fix(aidocs)
+Fix changelog generation by handling leading newlines
+
+- Fixed handling of leading newlines in the changelog to ensure proper formatting.
+
+## 2024-06-23 - 1.3.11 - fix(core)
+Fixed new changelog formatting issue to retain consistent spacing.
+
+- Adjusted the new changelog generation to ensure consistent spacing for improved readability.
+
+## 2024-06-23 - 1.3.10 - fix(aidocs_classes)
+Fix changelog format to remove extra newline
+
+- Updated `ts/aidocs_classes/commit.ts` to fix the changelog format.
+
+## 2024-06-23 - 1.3.9 - fix(aidoc)
+Fix changelog generation by properly stripping markdown code fences
+
+- Corrected the changelog generation code to ensure markdown code fences are properly stripped.
+
+
+## 2024-06-23 - 1.3.8 - fix(changelog)
+Fix changelog generation by properly stripping markdown code fences
+
+- Corrected the changelog generation code to ensure markdown code fences are properly stripped.
+
+## 2024-06-23 - 1.3.7 - fix(aidoc)
+Update to include package-lock.json in uncommitted changes check
+
+- Modified the getUncommittedDiff method call in commit.ts to include package-lock.json along with pnpm-lock.yaml
+
+
+## 2024-06-23 - 1.3.6 - fix(commit)
+Fixed issue with retrieving uncommitted diffs in git repository
+
+- Revised logic to correctly handle uncommitted changes by using an array for `getUncommittedDiff` method
+- Ensured proper handling and representation of uncommitted changes in the output
+
+
+## 2024-06-23 - 1.3.5 - fix(aidocs_classes)
+Refactor and enhance changelog formatting
+
+- Updated the `commit.ts` file to improve the changelog formatting and ensure consistency.
+- Enhanced the changelog instructions to include summarizing messages for omitted commits.
+- Removed unnecessary console logging in `projectcontext.ts`.
+
+
+```markdown
+## 2024-06-23 - 1.3.3 - fix(aidocs_classes)
+Fix changelog formatting issue in commit class
+
+## 2024-06-23 - 1.3.2 - fix(aidocs_classes)
+Fix minor bugs and update dependencies in aidocs_classes
+
+## 2024-06-23 - 1.3.1 - fix(aidocs_classes)
+Fix typo in INextCommitObject interface and update date format in changelog generation.
+
+## 2024-06-23 - 1.3.0 - fix(aidocs_classes)
+Fix typo in INextCommitObject interface
+
+## 2024-06-23 - 1.2.4 - feat(core)
+Added smarttime dependency and improved changelog generation
+
+## 2024-06-23 - 1.2.3 - fix(logging)
+Refactor logger initialization to use commitinfo data
+
+## 2024-06-23 - 1.2.2 - fix(aidocs)
+Fix bug in AiDoc class causing undefined token handling
+
+## 2024-06-23 - 1.2.0 - fix(core)
+Fixed usage of plugins in project context and readme generation
+
+## 2024-06-23 - 1.1.42 - feat(aidocs_classes)
+Enhance changelog generation by supporting complete generation in the absence of previous changelog files
+
+## 2024-06-23 - 1.1.41 - fix(aidocs_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.4.4",
   "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"
@@ -22,23 +23,25 @@
     "@git.zone/tsrun": "^1.2.46",
     "@git.zone/tstest": "^1.0.90",
     "@push.rocks/tapbundle": "^5.0.23",
-    "@types/node": "^20.14.8"
+    "@types/node": "^22.8.1"
   },
   "dependencies": {
+    "@git.zone/tspublish": "^1.5.5",
     "@push.rocks/early": "^4.0.3",
     "@push.rocks/npmextra": "^5.0.23",
     "@push.rocks/qenv": "^6.0.5",
-    "@push.rocks/smartai": "^0.0.17",
+    "@push.rocks/smartai": "^0.4.2",
     "@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.27.9",
     "typescript": "^5.5.2"
   },
   "files": [

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

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

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.4.4',
   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,26 @@ 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 diffStringArray = await gitRepo.getUncommittedDiff([
+      'pnpm-lock.yaml',
+      'package-lock.json',
+    ]);
     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:
+
+${diffStringArray[0] ? diffStringArray.join('\n\n') : 'No changes.'}
+    `;
 
     let result = await this.aiDocsRef.openaiInstance.chat({
       systemMessage: `
@@ -27,12 +53,17 @@ 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
 }
 
+For the recommendedNextVersionDetails, please only add a detail entries to the array if it has an obvious value to the reader.
+
 You are being given the files of the project. You should use them to create the commit message.
 Also you are given a diff
 
@@ -41,15 +72,63 @@ 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();
+      console.log(JSON.stringify(commitMessages, null, 2));
+      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, but make sure to mention them as a range with a summarizing message instead.
 
-    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.replaceAll('```markdown', '').replaceAll('```', ''),
+        'utf8'
+      );
+    }
+
+    let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
+    if (oldChangelog.startsWith('\n')) {
+      oldChangelog = oldChangelog.replace('\n', '');
+    }
+    let newDateString = new plugins.smarttime.ExtendedDate().exportToHyphedSortableDate();
+    let newChangelog = `# Changelog\n\n${`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
+{{nextVersionMessage}}
+
+{{nextVersionDetails}}`}\n\n${oldChangelog}`;
+    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,9 @@ export class ProjectContext {
   }
 
   public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
-    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

@@ -1,9 +1,10 @@
 import type { AiDoc } from '../classes.aidoc.js';
 import * as plugins from '../plugins.js';
+import * as paths from '../paths.js';
 import { ProjectContext } from './projectcontext.js';
+import { logger } from '../logging.js';
 
 export class Readme {
-
   // INSTANCE
   private aiDocsRef: AiDoc;
   private projectDir: string;
@@ -21,8 +22,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);
@@ -68,11 +71,8 @@ The Readme should follow the following template:
       userMessage: contextString,
     });
 
-
     finalReadmeString += result.message + '\n' + legalInfo;
 
-    
-
     console.log(`\n======================\n`);
     console.log(result.message);
     console.log(`\n======================\n`);
@@ -81,6 +81,64 @@ The Readme should follow the following template:
     readme.contents = Buffer.from(finalReadmeString);
     await readme.write();
 
+    // lets care about monorepo aspects
+    const tsPublishInstance = new plugins.tspublish.TsPublish();
+    const subModules = await tsPublishInstance.getModuleSubDirs(paths.cwd);
+    logger.log('info', `Found ${Object.keys(subModules).length} sub modules`);
+    for (const subModule of Object.keys(subModules)) {
+      logger.log('info', `Building readme for ${subModule}`);
+      const subModuleContextString = await projectContext.update();
+      let result = await this.aiDocsRef.openaiInstance.chat({
+        systemMessage: `
+  You create markdown readmes for npm projects. You only output the markdown readme.
+
+  IMPORTANT: YOU ARE NOW CREATING THE README FOR THE FOLLOWING SUB MODULE: ${subModule} !!!!!!!!!!!
+  The Sub Module will be published with the following data:
+  ${JSON.stringify(plugins.smartfile.fs.toStringSync(plugins.path.join(paths.cwd, subModule, 'tspublish.json')), null, 2)}
+
+  
+  The Readme should follow the following template:
+  
+  # Project Name
+  [
+    The name is the module name of package.json
+    The description is in the description field of package.json
+  ]
+  
+  ## Install
+  [
+    Write a short text on how to install the project
+  ]
+  
+  ## Usage
+  [ 
+    Give code examples here.
+    Construct sensible scenarios for the user.
+    Make sure to show a complete set of features of the module.
+    Don't omit use cases.
+    It does not matter how much time you need.
+    ALWAYS USE ESM SYNTAX AND TYPESCRIPT.
+    DON'T CHICKEN OUT. Write at least 4000 words. More if necessary.
+    If there is already a readme, take the Usage section as base. Remove outdated content, and expand and improve upon the valid parts.
+    Super important: Check for completenes.
+    Don't include any licensing information. This will be added in a later step.
+    Avoid "in conclusions".
+  
+    Good to know:
+    * npmextra.json contains overall module information.
+    * readme.hints.md provides valuable hints about module ideas.
+    * Your output lands directly in the readme.md file.
+    * Don't use \`\`\` at the beginning or the end. It'll cause problems. Only use it for codeblocks. You are directly writing markdown. No need to introduce it weirdly.
+  ]
+              `,
+        messageHistory: [],
+        userMessage: subModuleContextString,
+      });
+
+      const subModuleReadmeString = result.message + '\n' + legalInfo;
+      await plugins.smartfile.memory.toFs(subModuleReadmeString, plugins.path.join(paths.cwd, subModule, 'readme.md'));
+      logger.log('success', `Built readme for ${subModule}`);
+    }
     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

@@ -28,15 +28,15 @@ export const run = async () => {
   });
 
   tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
-    logger.log('info', `Generating new readme...`);
-    logger.log('info', `This may take some time...`);
     const aidocInstance = new AiDoc();
     await aidocInstance.start();
-    aidocInstance.buildReadme(paths.cwd);
+    logger.log('info', `Generating new readme...`);
+    logger.log('info', `This may take some time...`);
+    await aidocInstance.buildReadme(paths.cwd);
     logger.log('info', `Generating new keywords...`);
     logger.log('info', `This may take some time...`);
-    aidocInstance.buildDescription(paths.cwd);
+    await 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,8 +31,14 @@ export {
   smartlogDestinationLocal,
   smartpath,
   smartshell,
+  smarttime,
 };
 
+// @git.zone scope
+import * as tspublish from '@git.zone/tspublish';
+
+export { tspublish };
+
 // third party scope
 import * as typedoc from 'typedoc';