@git.zone/tsdoc 1.1.40 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  /**
2
- * autocreated commitinfo by @pushrocks/commitinfo
2
+ * autocreated commitinfo by @push.rocks/commitinfo
3
3
  */
4
4
  export declare const commitinfo: {
5
5
  name: string;
@@ -1,9 +1,9 @@
1
1
  /**
2
- * autocreated commitinfo by @pushrocks/commitinfo
2
+ * autocreated commitinfo by @push.rocks/commitinfo
3
3
  */
4
4
  export const commitinfo = {
5
5
  name: '@git.zone/tsdoc',
6
- version: '1.1.40',
6
+ version: '1.2.2',
7
7
  description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
8
8
  };
9
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxpQkFBaUI7SUFDdkIsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLG1IQUFtSDtDQUNqSSxDQUFBIn0=
9
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxpQkFBaUI7SUFDdkIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLG1IQUFtSDtDQUNqSSxDQUFBIn0=
@@ -16,8 +16,9 @@ export class Commit {
16
16
  contextString = `
17
17
  ${contextString}
18
18
 
19
- Here is the diff:
20
- ${diffString}
19
+ Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
20
+
21
+ ${diffString || 'No changes.'}
21
22
  `;
22
23
  let result = await this.aiDocsRef.openaiInstance.chat({
23
24
  systemMessage: `
@@ -66,19 +67,30 @@ You are given
66
67
 
67
68
  Only return the changelog file, so it can be written directly to changelog.md
68
69
 
69
- For the latest version, that is not yet part of the commit messages, use {{nextVersion}} and {{nextVersionMessage}} placeholders.
70
+ For the latest version, that is not yet part of the commit messages, add a placeholder entry that uses {{nextVersion}} and {{nextVersionMessage}} as variables to filled later.
71
+ Only output newer versions and their changes compared to ones already mentioned. We take of appending your output later.
72
+ If there is no previous changelog file, generate a complete changelog from commit messages with heading and everything + the placeholder section mentioned above.
70
73
  `,
71
74
  userMessage: `
72
75
  The previous changelog file is:
73
- ${(!previousChangelog) ? 'No previous changelog file found' : previousChangelog.contents.toString()}
76
+ ${!previousChangelog ? 'No previous changelog file found' : previousChangelog.contents.toString()}
74
77
 
75
78
  Here are the commit messages so far:
76
79
 
77
80
  ${commitMessages.join('\n\n')}
78
- `
81
+ `,
79
82
  });
80
- resultObject.changelog = result2.message;
83
+ if (previousChangelog) {
84
+ let newChangelog = result2.message;
85
+ newChangelog = newChangelog.replace('# Changelog\n\n', '');
86
+ let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
87
+ newChangelog = `# Changelog\n\n${newChangelog}\n\n${oldChangelog}`;
88
+ resultObject.changelog = newChangelog;
89
+ }
90
+ else {
91
+ resultObject.changelog = result2.message;
92
+ }
81
93
  return resultObject;
82
94
  }
83
95
  }
84
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWl0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvY29tbWl0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFVckQsTUFBTSxPQUFPLE1BQU07SUFJakIsWUFBWSxTQUFnQixFQUFFLGFBQXFCO1FBQ2pELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELE1BQU0sZ0JBQWdCLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUIsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxnQkFBZ0IsRUFBRSxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDckcsTUFBTSxVQUFVLEdBQUcsTUFBTSxPQUFPLENBQUMsa0JBQWtCLEVBQUUsQ0FBQztRQUN0RCxNQUFNLGNBQWMsR0FBRyxJQUFJLGNBQWMsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDM0QsSUFBSSxhQUFhLEdBQUcsTUFBTSxjQUFjLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDbEQsYUFBYSxHQUFHO0VBQ2xCLGFBQWE7OztFQUdiLFVBQVU7S0FDUCxDQUFBO1FBRUQsSUFBSSxNQUFNLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUM7WUFDcEQsYUFBYSxFQUFFOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Q0FxQnBCO1lBQ0ssY0FBYyxFQUFFLEVBQUU7WUFDbEIsV0FBVyxFQUFFLGFBQWE7U0FDM0IsQ0FBQyxDQUFDO1FBRUgsK0JBQStCO1FBQy9CLE1BQU0sWUFBWSxHQUFzQixJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFFN0cseUNBQXlDO1FBQ3pDLE1BQU0sY0FBYyxHQUFHLE1BQU0sT0FBTyxDQUFDLG9CQUFvQixFQUFFLENBQUM7UUFDNUQsTUFBTSxxQkFBcUIsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLGNBQWMsQ0FBQyxDQUFDO1FBQ2pGLElBQUksaUJBQThDLENBQUM7UUFDbkQsSUFBSSxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxFQUFFLENBQUM7WUFDakUsaUJBQWlCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQUMscUJBQXFCLENBQUMsQ0FBQztRQUM1RixDQUFDO1FBQ0QsSUFBSSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUM7WUFDckQsY0FBYyxFQUFFLEVBQUU7WUFDbEIsYUFBYSxFQUFFOzs7Ozs7Ozs7OztPQVdkO1lBQ0QsV0FBVyxFQUFFOztFQUVqQixDQUFDLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxDQUFDLENBQUMsa0NBQWtDLENBQUMsQ0FBQyxDQUFDLGlCQUFpQixDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUU7Ozs7RUFJakcsY0FBYyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUM7Q0FDNUI7U0FDSSxDQUFDLENBQUE7UUFDRixZQUFZLENBQUMsU0FBUyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUM7UUFDekMsT0FBTyxZQUFZLENBQUM7SUFDdEIsQ0FBQztDQUNGIn0=
96
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWl0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvY29tbWl0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFVckQsTUFBTSxPQUFPLE1BQU07SUFJakIsWUFBWSxTQUFnQixFQUFFLGFBQXFCO1FBQ2pELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELE1BQU0sZ0JBQWdCLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUIsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsQ0FDL0QsZ0JBQWdCLEVBQ2hCLElBQUksQ0FBQyxVQUFVLENBQ2hCLENBQUM7UUFDRixNQUFNLFVBQVUsR0FBRyxNQUFNLE9BQU8sQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO1FBQ3RELE1BQU0sY0FBYyxHQUFHLElBQUksY0FBYyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUMzRCxJQUFJLGFBQWEsR0FBRyxNQUFNLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNsRCxhQUFhLEdBQUc7RUFDbEIsYUFBYTs7OztFQUliLFVBQVUsSUFBSSxhQUFhO0tBQ3hCLENBQUM7UUFFRixJQUFJLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQztZQUNwRCxhQUFhLEVBQUU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztDQXFCcEI7WUFDSyxjQUFjLEVBQUUsRUFBRTtZQUNsQixXQUFXLEVBQUUsYUFBYTtTQUMzQixDQUFDLENBQUM7UUFFSCwrQkFBK0I7UUFDL0IsTUFBTSxZQUFZLEdBQXNCLElBQUksQ0FBQyxLQUFLLENBQ2hELE1BQU0sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLEVBQUUsQ0FBQyxDQUN6RCxDQUFDO1FBRUYseUNBQXlDO1FBQ3pDLE1BQU0sY0FBYyxHQUFHLE1BQU0sT0FBTyxDQUFDLG9CQUFvQixFQUFFLENBQUM7UUFDNUQsTUFBTSxxQkFBcUIsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLGNBQWMsQ0FBQyxDQUFDO1FBQ2pGLElBQUksaUJBQThDLENBQUM7UUFDbkQsSUFBSSxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxFQUFFLENBQUM7WUFDakUsaUJBQWlCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQUMscUJBQXFCLENBQUMsQ0FBQztRQUM1RixDQUFDO1FBQ0QsSUFBSSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUM7WUFDckQsY0FBYyxFQUFFLEVBQUU7WUFDbEIsYUFBYSxFQUFFOzs7Ozs7Ozs7Ozs7O09BYWQ7WUFDRCxXQUFXLEVBQUU7O0VBRWpCLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxDQUFDLGtDQUFrQyxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFOzs7O0VBSS9GLGNBQWMsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDO0NBQzVCO1NBQ0ksQ0FBQyxDQUFDO1FBQ0gsSUFBSSxpQkFBaUIsRUFBRSxDQUFDO1lBQ3RCLElBQUksWUFBWSxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUM7WUFDbkMsWUFBWSxHQUFHLFlBQVksQ0FBQyxPQUFPLENBQUMsaUJBQWlCLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDM0QsSUFBSSxZQUFZLEdBQUcsaUJBQWlCLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLE9BQU8sQ0FBQyxpQkFBaUIsRUFBRSxFQUFFLENBQUMsQ0FBQztZQUN4RixZQUFZLEdBQUcsa0JBQWtCLFlBQVksT0FBTyxZQUFZLEVBQUUsQ0FBQztZQUNuRSxZQUFZLENBQUMsU0FBUyxHQUFHLFlBQVksQ0FBQztRQUN4QyxDQUFDO2FBQU0sQ0FBQztZQUNOLFlBQVksQ0FBQyxTQUFTLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQztRQUMzQyxDQUFDO1FBQ0QsT0FBTyxZQUFZLENBQUM7SUFDdEIsQ0FBQztDQUNGIn0=
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@git.zone/tsdoc",
3
- "version": "1.1.40",
3
+ "version": "1.2.2",
4
4
  "private": false,
5
5
  "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
6
6
  "type": "module",
@@ -1,8 +1,8 @@
1
1
  /**
2
- * autocreated commitinfo by @pushrocks/commitinfo
2
+ * autocreated commitinfo by @push.rocks/commitinfo
3
3
  */
4
4
  export const commitinfo = {
5
5
  name: '@git.zone/tsdoc',
6
- version: '1.1.40',
6
+ version: '1.2.2',
7
7
  description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
8
8
  }
@@ -22,16 +22,20 @@ export class Commit {
22
22
  public async buildNextCommitObject(): Promise<INextCommitObject> {
23
23
  const smartgitInstance = new plugins.smartgit.Smartgit();
24
24
  await smartgitInstance.init();
25
- const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(smartgitInstance, this.projectDir);
25
+ const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(
26
+ smartgitInstance,
27
+ this.projectDir
28
+ );
26
29
  const diffString = await gitRepo.getUncommittedDiff();
27
30
  const projectContext = new ProjectContext(this.projectDir);
28
31
  let contextString = await projectContext.update();
29
32
  contextString = `
30
33
  ${contextString}
31
34
 
32
- Here is the diff:
33
- ${diffString}
34
- `
35
+ Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
36
+
37
+ ${diffString || 'No changes.'}
38
+ `;
35
39
 
36
40
  let result = await this.aiDocsRef.openaiInstance.chat({
37
41
  systemMessage: `
@@ -61,7 +65,9 @@ Also you are given a diff
61
65
  });
62
66
 
63
67
  // console.log(result.message);
64
- const resultObject: INextCommitObject = JSON.parse(result.message.replace('```json', '').replace('```', ''));
68
+ const resultObject: INextCommitObject = JSON.parse(
69
+ result.message.replace('```json', '').replace('```', '')
70
+ );
65
71
 
66
72
  // lets build the changelog based on that
67
73
  const commitMessages = await gitRepo.getAllCommitMessages();
@@ -82,18 +88,28 @@ You are given
82
88
 
83
89
  Only return the changelog file, so it can be written directly to changelog.md
84
90
 
85
- For the latest version, that is not yet part of the commit messages, use {{nextVersion}} and {{nextVersionMessage}} placeholders.
91
+ For the latest version, that is not yet part of the commit messages, add a placeholder entry that uses {{nextVersion}} and {{nextVersionMessage}} as variables to filled later.
92
+ Only output newer versions and their changes compared to ones already mentioned. We take of appending your output later.
93
+ If there is no previous changelog file, generate a complete changelog from commit messages with heading and everything + the placeholder section mentioned above.
86
94
  `,
87
95
  userMessage: `
88
96
  The previous changelog file is:
89
- ${(!previousChangelog) ? 'No previous changelog file found' : previousChangelog.contents.toString()}
97
+ ${!previousChangelog ? 'No previous changelog file found' : previousChangelog.contents.toString()}
90
98
 
91
99
  Here are the commit messages so far:
92
100
 
93
101
  ${commitMessages.join('\n\n')}
94
- `
95
- })
96
- resultObject.changelog = result2.message;
102
+ `,
103
+ });
104
+ if (previousChangelog) {
105
+ let newChangelog = result2.message;
106
+ newChangelog = newChangelog.replace('# Changelog\n\n', '');
107
+ let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
108
+ newChangelog = `# Changelog\n\n${newChangelog}\n\n${oldChangelog}`;
109
+ resultObject.changelog = newChangelog;
110
+ } else {
111
+ resultObject.changelog = result2.message;
112
+ }
97
113
  return resultObject;
98
114
  }
99
115
  }