1.3.7

changelog.md

@@ -0,0 +1,54 @@
+# Changelog
+
+## 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,6 +1,6 @@
 {
   "name": "@git.zone/tsdoc",
-  "version": "1.1.35",
+  "version": "1.3.7",
   "private": false,
   "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
   "type": "module",
@@ -33,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
-        version: 3.0.4
+        specifier: ^3.1.0
+        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
-        version: 0.26.0(typescript@5.5.2)
+        specifier: ^0.26.1
+        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':
-    resolution: {integrity: sha512-6uYifD4rGjTp6KO8kdaVenXeef0uZOfQSTuLuG3+ubpMXwZNSp0iQWx+XgS5pQipzG0+3p4ddnQ7/R8gm7LWOg==}
+  '@push.rocks/smartgit@3.1.0':
+    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:
-    resolution: {integrity: sha512-IxGiaKBwAdcgBXwIcxJU6rHLk+NrzYaaPKXXQffcA0GW3IUrQXdUPDXDo+hkGVcYruuz/7JlGBiuaeTCgIgivQ==}
+  isomorphic-git@1.26.2:
+    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:
-    resolution: {integrity: sha512-OcYevjHsMN8DfpaL0dSBGAEBhOxuBB5Au8QVs9oz9iB0kRStPZwXLFWqh9gwbMUxNjW3yQuIM5GrVVauMJ2Akw==}
+  typedoc@0.26.1:
+    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

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.35',
+  version: '1.3.7',
   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
-  recommendedNextVersion: string; // the recommended next version of the project
-  message: string; // the commit message. use conventional commits format
-  changelog?: string; // the changelog
+  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 {
@@ -21,16 +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 diffString = await gitRepo.getUncommittedDiff();
+    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);
     let contextString = await projectContext.update();
     contextString = `
 ${contextString}
 
-Here is the diff:
-${diffString}
-    `
+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: `
@@ -44,12 +50,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
-  recommendedNextVersion: string; // the recommended next version of the project
-  message: string; // the commit message. use conventional commits format
+
+interface {
+  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
 }
 
+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
 
@@ -59,39 +70,60 @@ 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();
     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.
 
-You are given
-* the previous changelog file (if available)
+    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.
+
+A changelog entry should look like this:
+
+    ## 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.
-      `,
-      userMessage: `
-The previous changelog file is:
-${(!previousChangelog) ? 'No previous changelog file found' : previousChangelog.contents.toString()}
+${JSON.stringify(commitMessages, null, 2)}
+  `,
+      });
 
-Here are the commit messages so far:
+      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}`;
+    resultObject.changelog = newChangelog;
 
-${commitMessages.join('\n\n')}
-`
-    })
-    resultObject.changelog = result2.message;
     return resultObject;
   }
 }

ts/aidocs_classes/projectcontext.ts

@@ -47,9 +47,8 @@ export class ProjectContext {
   }
 
   public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
-    console.log(`Using the following files for the documentation:`);
     filesArg.map((fileArg) => {
-      console.log(`  -> ${fileArg.relative}`);
+      // console.log(`  -> ${fileArg.relative}`);
     });
     return filesArg
       .map((smartfile) => {

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({
-  logContext: {
-    company: 'Some Company',
-    companyunit: 'Some CompanyUnit',
-    containerName: 'Some Containername',
-    environment: 'local',
-    runtime: 'node',
-    zone: 'gitzone',
-  },
-  minimumLogLevel: 'silly',
-});
+export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
 
 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