1.3.1

changelog.md

@@ -0,0 +1,37 @@
+# Changelog
+
+## 23.06.2024 - 1.3.1 - {{nextVersionScope}}
+fix(aidocs_classes): Fix typo in INextCommitObject interface
+{{nextVersionDetails}}
+
+
+```markdown
+## [1.2.4]
+### Fixed
+- Refactor logger initialization to use commitinfo data
+
+## 1.3.0
+feat(core): Added smarttime dependency and improved changelog generation
+```
+
+## [1.2.4] - 1.2.4
+fix(logging): Refactor logger initialization to use commitinfo data
+
+## [1.2.3]
+fix(aidocs): Fix bug in AiDoc class causing undefined token handling
+
+## [1.2.2] - 2023-11-20
+### Fixed
+- Fix bug in AiDoc class causing undefined token handling 
+
+## [1.2.1] - 2023-11-10
+### Fixed
+- Fixed usage of plugins in project context and readme generation
+
+## [1.2.0] - 2023-11-01
+### Added
+- Enhance changelog generation by supporting complete generation in the absence of previous changelog files
+
+## [1.1.42] - 2023-10-30
+### Fixed
+- Improve commit message generation by handling empty diffs and updating changelog instructions

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@git.zone/tsdoc",
-  "version": "1.1.34",
+  "version": "1.3.1",
   "private": false,
   "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
   "type": "module",
@@ -39,6 +39,7 @@
     "@push.rocks/smartlog-destination-local": "^9.0.2",
     "@push.rocks/smartpath": "^5.0.18",
     "@push.rocks/smartshell": "^3.0.5",
+    "@push.rocks/smarttime": "^4.0.6",
     "typedoc": "^0.26.0",
     "typescript": "^5.5.2"
   },

pnpm-lock.yaml

@@ -47,6 +47,9 @@ 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
         version: 0.26.0(typescript@5.5.2)

test/test.aidoc.nonci.ts

@@ -29,9 +29,10 @@ tap.test('should build commit object', async () => {
   const commitObject = await aidocs.buildNextCommitObject('./');
   console.log(commitObject);
   expect(commitObject).not.toBeUndefined();
-  expect(commitObject).toHaveProperty('message');
   expect(commitObject).toHaveProperty('recommendedNextVersion');
   expect(commitObject).toHaveProperty('recommendedNextVersionLevel');
+  expect(commitObject).toHaveProperty('recommendedNextVersionScope');
+  expect(commitObject).toHaveProperty('recommendedNextVersionMessage');
 
 })
 

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

ts/aidocs_classes/commit.ts

@@ -3,10 +3,12 @@ import { AiDoc } from '../classes.aidoc.js';
 import { ProjectContext } from './projectcontext.js';
 
 export interface INextCommitObject {
-  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.
-  changelog?: string; // the changelog
+  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 {
@@ -21,17 +23,20 @@ export class Commit {
   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 gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(
+      smartgitInstance,
+      this.projectDir
+    );
     const diffString = await gitRepo.getUncommittedDiff();
-    console.log(diffString);
     const projectContext = new ProjectContext(this.projectDir);
     let contextString = await projectContext.update();
     contextString = `
 ${contextString}
 
-Here is the diff:
+Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
-${diffString}
+
-    `
+${diffString || 'No changes.'}
+    `;
 
     let result = await this.aiDocsRef.openaiInstance.chat({
       systemMessage: `
@@ -45,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.
@@ -60,7 +68,9 @@ Also you are given a diff
     });
 
     // console.log(result.message);
-    const resultObject: INextCommitObject = JSON.parse(result.message.replace('```json', '').replace('```', ''));
+    const resultObject: INextCommitObject = JSON.parse(
+      result.message.replace('```json', '').replace('```', '')
+    );
 
     // lets build the changelog based on that
     const commitMessages = await gitRepo.getAllCommitMessages();
@@ -69,30 +79,43 @@ Also you are given a diff
     if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
       previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
     }
-    let result2 = await this.aiDocsRef.openaiInstance.chat({
+
-      messageHistory: [],
+    if (!previousChangelog) {
-      systemMessage: `
+      let result2 = await this.aiDocsRef.openaiInstance.chat({
-You are building a changelog file for the projext.
+        messageHistory: [],
+        systemMessage: `
+You are building a changelog.md file for the project.
 Omit commits and versions that lack relevant changes.
 
-You are given
+A changelog entry should look like this:
-* the previous changelog file (if available)
+
+    ## 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
+Only return the changelog file, so it can be written directly to changelog.md`,
+        userMessage: `
+Here are the commit messages:
 
-For the latest version, that is not yet part of the commit messages, use {{nextVersion}} and {{nextDescription}} placeholders.
+${commitMessages.join('\n')}
-      `,
+  `,
-      userMessage: `
+      });
-The previous changelog file is:
+    
-${(!previousChangelog) ? 'No previous changelog file found' : previousChangelog.contents.toString()}
+      previousChangelog = await plugins.smartfile.SmartFile.fromString(previousChangelogPath, result2.message, 'utf8');
+    }
 
-Here are the commit messages so far:
+    let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
+    let newDateString = new plugins.smarttime.ExtendedDate().exportToEuropeanDate();
+    let newChangelog = `# Changelog\n\n${
+`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
+{{nextVersionMessage}}
+{{nextVersionDetails}}
+`}\n\n${oldChangelog}\n`;
+    resultObject.changelog = newChangelog;
 
-${commitMessages.join('\n\n')}
-`
-    })
-    resultObject.changelog = result2.message;
     return resultObject;
   }
 }

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: '',
           });

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/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