1.3.10

changelog.md

@@ -1,32 +1,70 @@
 # Changelog
 
+## 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
-## [1.2.4]
+## 2024-06-23 - 1.3.3 - fix(aidocs_classes)
-### Fixed
+Fix changelog formatting issue in commit class
-- Refactor logger initialization to use commitinfo data
 
-## 1.3.0
+## 2024-06-23 - 1.3.2 - fix(aidocs_classes)
-feat(core): Added smarttime dependency and improved changelog generation
+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
 ```
-
-## [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.3.0",
+  "version": "1.3.10",
   "private": false,
   "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
   "type": "module",
@@ -33,14 +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",
     "@push.rocks/smarttime": "^4.0.6",
-    "typedoc": "^0.26.0",
+    "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
@@ -51,8 +51,8 @@ importers:
         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
@@ -432,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==}
@@ -1927,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
 
@@ -3018,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:
@@ -3867,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
@@ -3875,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:
@@ -5801,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
@@ -7158,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

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tsdoc',
-  version: '1.3.0',
+  version: '1.3.10',
   description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
 }

ts/aidocs_classes/commit.ts

@@ -6,7 +6,7 @@ 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.
-  recommendedNextVersionDetauls: string[]; // detailed bullet points for 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
 }
@@ -27,7 +27,7 @@ export class Commit {
       smartgitInstance,
       this.projectDir
     );
-    const diffString = await gitRepo.getUncommittedDiff();
+    const diffStringArray = await gitRepo.getUncommittedDiff(['pnpm-lock.yaml', 'package-lock.json']);
     const projectContext = new ProjectContext(this.projectDir);
     let contextString = await projectContext.update();
     contextString = `
@@ -35,7 +35,7 @@ ${contextString}
 
 Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
 
-${diffString || 'No changes.'}
+${diffStringArray[0] ? diffStringArray.join('\n\n') : 'No changes.'}
     `;
 
     let result = await this.aiDocsRef.openaiInstance.chat({
@@ -59,6 +59,8 @@ interface {
   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
 
@@ -72,8 +74,6 @@ Also you are given a diff
       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)) {
@@ -81,16 +81,20 @@ Also you are given a diff
     }
 
     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.
+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:
@@ -100,20 +104,23 @@ Only return the changelog file, so it can be written directly to changelog.md`,
         userMessage: `
 Here are the commit messages:
 
-${commitMessages.join('\n')}
+${JSON.stringify(commitMessages, null, 2)}
   `,
       });
-    
+
-      previousChangelog = await plugins.smartfile.SmartFile.fromString(previousChangelogPath, result2.message, 'utf8');
+      previousChangelog = await plugins.smartfile.SmartFile.fromString(
+        previousChangelogPath,
+        result2.message.replaceAll('```markdown', '').replaceAll('```', ''),
+        'utf8'
+      );
     }
 
     let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
-    let newDateString = new plugins.smarttime.ExtendedDate().exportToEuropeanDate();
+    let newDateString = new plugins.smarttime.ExtendedDate().exportToHyphedSortableDate();
-    let newChangelog = `# Changelog\n\n${
+    let newChangelog = `# Changelog\n\n${`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
-`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
 {{nextVersionMessage}}
-{{nextVersionDetails}}
+
-`}\n\n${oldChangelog}\n`;
+{{nextVersionDetails}}`}\n${oldChangelog}`;
     resultObject.changelog = newChangelog;
 
     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) => {