@git.zone/tsdoc 1.3.4 → 1.3.5
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.
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/aidocs_classes/commit.js +7 -3
- package/dist_ts/aidocs_classes/projectcontext.js +1 -2
- package/package.json +1 -1
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/aidocs_classes/commit.ts +6 -2
- package/ts/aidocs_classes/projectcontext.ts +0 -1
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@git.zone/tsdoc',
|
|
6
|
-
version: '1.3.
|
|
6
|
+
version: '1.3.5',
|
|
7
7
|
description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxpQkFBaUI7SUFDdkIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLG1IQUFtSDtDQUNqSSxDQUFBIn0=
|
|
@@ -41,6 +41,8 @@ interface {
|
|
|
41
41
|
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
|
|
42
42
|
}
|
|
43
43
|
|
|
44
|
+
For the recommendedNextVersionDetails, please only add a detail entries to the array if it has an obvious value to the reader.
|
|
45
|
+
|
|
44
46
|
You are being given the files of the project. You should use them to create the commit message.
|
|
45
47
|
Also you are given a diff
|
|
46
48
|
|
|
@@ -58,16 +60,18 @@ Also you are given a diff
|
|
|
58
60
|
if (!previousChangelog) {
|
|
59
61
|
// lets build the changelog based on that
|
|
60
62
|
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
63
|
+
console.log(JSON.stringify(commitMessages, null, 2));
|
|
61
64
|
let result2 = await this.aiDocsRef.openaiInstance.chat({
|
|
62
65
|
messageHistory: [],
|
|
63
66
|
systemMessage: `
|
|
64
67
|
You are building a changelog.md file for the project.
|
|
65
|
-
Omit commits and versions that lack relevant changes.
|
|
68
|
+
Omit commits and versions that lack relevant changes, but make sure to mention them as a range with a summarizing message instead.
|
|
66
69
|
|
|
67
70
|
A changelog entry should look like this:
|
|
68
71
|
|
|
69
72
|
## yyyy-mm-dd - x.x.x - scope here
|
|
70
73
|
main descriptiom here
|
|
74
|
+
|
|
71
75
|
- detailed bullet points follow
|
|
72
76
|
|
|
73
77
|
You are given:
|
|
@@ -88,9 +92,9 @@ ${JSON.stringify(commitMessages, null, 2)}
|
|
|
88
92
|
{{nextVersionMessage}}
|
|
89
93
|
|
|
90
94
|
{{nextVersionDetails}}
|
|
91
|
-
`}\n\n${oldChangelog}
|
|
95
|
+
`}\n\n${oldChangelog}`;
|
|
92
96
|
resultObject.changelog = newChangelog;
|
|
93
97
|
return resultObject;
|
|
94
98
|
}
|
|
95
99
|
}
|
|
96
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
100
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWl0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvY29tbWl0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFXckQsTUFBTSxPQUFPLE1BQU07SUFJakIsWUFBWSxTQUFnQixFQUFFLGFBQXFCO1FBQ2pELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELE1BQU0sZ0JBQWdCLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUIsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsQ0FDL0QsZ0JBQWdCLEVBQ2hCLElBQUksQ0FBQyxVQUFVLENBQ2hCLENBQUM7UUFDRixNQUFNLFVBQVUsR0FBRyxNQUFNLE9BQU8sQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO1FBQ3RELE1BQU0sY0FBYyxHQUFHLElBQUksY0FBYyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUMzRCxJQUFJLGFBQWEsR0FBRyxNQUFNLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNsRCxhQUFhLEdBQUc7RUFDbEIsYUFBYTs7OztFQUliLFVBQVUsSUFBSSxhQUFhO0tBQ3hCLENBQUM7UUFFRixJQUFJLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQztZQUNwRCxhQUFhLEVBQUU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Q0F5QnBCO1lBQ0ssY0FBYyxFQUFFLEVBQUU7WUFDbEIsV0FBVyxFQUFFLGFBQWE7U0FDM0IsQ0FBQyxDQUFDO1FBRUgsK0JBQStCO1FBQy9CLE1BQU0sWUFBWSxHQUFzQixJQUFJLENBQUMsS0FBSyxDQUNoRCxNQUFNLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FDekQsQ0FBQztRQUVGLE1BQU0scUJBQXFCLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxjQUFjLENBQUMsQ0FBQztRQUNqRixJQUFJLGlCQUE4QyxDQUFDO1FBQ25ELElBQUksTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMscUJBQXFCLENBQUMsRUFBRSxDQUFDO1lBQ2pFLGlCQUFpQixHQUFHLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUFDLHFCQUFxQixDQUFDLENBQUM7UUFDNUYsQ0FBQztRQUVELElBQUksQ0FBQyxpQkFBaUIsRUFBRSxDQUFDO1lBQ3ZCLHlDQUF5QztZQUN6QyxNQUFNLGNBQWMsR0FBRyxNQUFNLE9BQU8sQ0FBQyxvQkFBb0IsRUFBRSxDQUFDO1lBQzVELE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxjQUFjLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDckQsSUFBSSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUM7Z0JBQ3JELGNBQWMsRUFBRSxFQUFFO2dCQUNsQixhQUFhLEVBQUU7Ozs7Ozs7Ozs7Ozs7OzhFQWN1RDtnQkFDdEUsV0FBVyxFQUFFOzs7RUFHbkIsSUFBSSxDQUFDLFNBQVMsQ0FBQyxjQUFjLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztHQUN0QzthQUNJLENBQUMsQ0FBQztZQUVILGlCQUFpQixHQUFHLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUM5RCxxQkFBcUIsRUFDckIsT0FBTyxDQUFDLE9BQU8sRUFDZixNQUFNLENBQ1AsQ0FBQztRQUNKLENBQUM7UUFFRCxJQUFJLFlBQVksR0FBRyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLENBQUMsT0FBTyxDQUFDLGlCQUFpQixFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQ3hGLElBQUksYUFBYSxHQUFHLElBQUksT0FBTyxDQUFDLFNBQVMsQ0FBQyxZQUFZLEVBQUUsQ0FBQywwQkFBMEIsRUFBRSxDQUFDO1FBQ3RGLElBQUksWUFBWSxHQUFHLGtCQUFrQixNQUFNLGFBQWE7Ozs7Q0FJM0QsT0FBTyxZQUFZLEVBQUUsQ0FBQztRQUNuQixZQUFZLENBQUMsU0FBUyxHQUFHLFlBQVksQ0FBQztRQUV0QyxPQUFPLFlBQVksQ0FBQztJQUN0QixDQUFDO0NBQ0YifQ==
|
|
@@ -21,7 +21,6 @@ export class ProjectContext {
|
|
|
21
21
|
};
|
|
22
22
|
}
|
|
23
23
|
async convertFilesToContext(filesArg) {
|
|
24
|
-
console.log(`Using the following files for the documentation:`);
|
|
25
24
|
filesArg.map((fileArg) => {
|
|
26
25
|
// console.log(` -> ${fileArg.relative}`);
|
|
27
26
|
});
|
|
@@ -55,4 +54,4 @@ ${smartfile.contents.toString()}
|
|
|
55
54
|
return result;
|
|
56
55
|
}
|
|
57
56
|
}
|
|
58
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
57
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGNvbnRleHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9haWRvY3NfY2xhc3Nlcy9wcm9qZWN0Y29udGV4dC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQztBQUV6QyxNQUFNLE9BQU8sY0FBYztJQUNsQixNQUFNLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFjLElBQUcsQ0FBQztJQUs5QyxZQUFZLGFBQXFCO1FBQy9CLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMsV0FBVztRQUN0QixNQUFNLG9CQUFvQixHQUFHLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUN6RSxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLGNBQWMsQ0FBQyxFQUNsRCxJQUFJLENBQUMsVUFBVSxDQUNoQixDQUFDO1FBQ0YsTUFBTSxnQkFBZ0IsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLFlBQVksQ0FDckUsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxXQUFXLENBQUMsRUFDL0MsSUFBSSxDQUFDLFVBQVUsQ0FDaEIsQ0FBQztRQUVGLE1BQU0scUJBQXFCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQzFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsaUJBQWlCLENBQUMsRUFDckQsSUFBSSxDQUFDLFVBQVUsQ0FDaEIsQ0FBQztRQUNGLE1BQU0sc0JBQXNCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQzNFLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsZUFBZSxDQUFDLEVBQ25ELElBQUksQ0FBQyxVQUFVLENBQ2hCLENBQUM7UUFDRixNQUFNLGFBQWEsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGdCQUFnQixDQUMvRCxJQUFJLENBQUMsVUFBVSxFQUNmLGFBQWEsQ0FDZCxDQUFDO1FBQ0YsTUFBTSxjQUFjLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FDaEUsSUFBSSxDQUFDLFVBQVUsRUFDZixjQUFjLENBQ2YsQ0FBQztRQUNGLE9BQU87WUFDTCxvQkFBb0I7WUFDcEIsZ0JBQWdCO1lBQ2hCLHFCQUFxQjtZQUNyQixzQkFBc0I7WUFDdEIsYUFBYTtZQUNiLGNBQWM7U0FDZixDQUFDO0lBQ0osQ0FBQztJQUVNLEtBQUssQ0FBQyxxQkFBcUIsQ0FBQyxRQUF1QztRQUN4RSxRQUFRLENBQUMsR0FBRyxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUU7WUFDdkIsMkNBQTJDO1FBQzdDLENBQUMsQ0FBQyxDQUFDO1FBQ0gsT0FBTyxRQUFRO2FBQ1osR0FBRyxDQUFDLENBQUMsU0FBUyxFQUFFLEVBQUU7WUFDakIsT0FBTzt1QkFDUSxTQUFTLENBQUMsUUFBUTs7RUFFdkMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUU7O3FCQUVWLFNBQVMsQ0FBQyxRQUFRO1NBQzlCLENBQUM7UUFDSixDQUFDLENBQUM7YUFDRCxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDaEIsQ0FBQztJQUVPLEtBQUssQ0FBQyxZQUFZLENBQUMsTUFBYztRQUN2QyxNQUFNLEtBQUssR0FBRyxNQUFNLElBQUksQ0FBQyxXQUFXLEVBQUUsQ0FBQztRQUN2QyxJQUFJLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxxQkFBcUIsQ0FBQztZQUM3QyxLQUFLLENBQUMsb0JBQW9CO1lBQzFCLEtBQUssQ0FBQyxnQkFBZ0I7WUFDdEIsS0FBSyxDQUFDLHFCQUFxQjtZQUMzQixLQUFLLENBQUMsc0JBQXNCO1lBQzVCLEdBQUcsS0FBSyxDQUFDLGFBQWE7WUFDdEIsR0FBRyxLQUFLLENBQUMsY0FBYztTQUN4QixDQUFDLENBQUM7UUFDSCx3QkFBd0I7UUFDeEIsT0FBTyxPQUFPLENBQUM7SUFDakIsQ0FBQztJQUVNLEtBQUssQ0FBQyxNQUFNO1FBQ2pCLE1BQU0sTUFBTSxHQUFHLE1BQU0sSUFBSSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDeEQsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztDQUNGIn0=
|
package/package.json
CHANGED
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -59,6 +59,8 @@ interface {
|
|
|
59
59
|
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
|
|
60
60
|
}
|
|
61
61
|
|
|
62
|
+
For the recommendedNextVersionDetails, please only add a detail entries to the array if it has an obvious value to the reader.
|
|
63
|
+
|
|
62
64
|
You are being given the files of the project. You should use them to create the commit message.
|
|
63
65
|
Also you are given a diff
|
|
64
66
|
|
|
@@ -81,16 +83,18 @@ Also you are given a diff
|
|
|
81
83
|
if (!previousChangelog) {
|
|
82
84
|
// lets build the changelog based on that
|
|
83
85
|
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
86
|
+
console.log(JSON.stringify(commitMessages, null, 2));
|
|
84
87
|
let result2 = await this.aiDocsRef.openaiInstance.chat({
|
|
85
88
|
messageHistory: [],
|
|
86
89
|
systemMessage: `
|
|
87
90
|
You are building a changelog.md file for the project.
|
|
88
|
-
Omit commits and versions that lack relevant changes.
|
|
91
|
+
Omit commits and versions that lack relevant changes, but make sure to mention them as a range with a summarizing message instead.
|
|
89
92
|
|
|
90
93
|
A changelog entry should look like this:
|
|
91
94
|
|
|
92
95
|
## yyyy-mm-dd - x.x.x - scope here
|
|
93
96
|
main descriptiom here
|
|
97
|
+
|
|
94
98
|
- detailed bullet points follow
|
|
95
99
|
|
|
96
100
|
You are given:
|
|
@@ -117,7 +121,7 @@ ${JSON.stringify(commitMessages, null, 2)}
|
|
|
117
121
|
{{nextVersionMessage}}
|
|
118
122
|
|
|
119
123
|
{{nextVersionDetails}}
|
|
120
|
-
`}\n\n${oldChangelog}
|
|
124
|
+
`}\n\n${oldChangelog}`;
|
|
121
125
|
resultObject.changelog = newChangelog;
|
|
122
126
|
|
|
123
127
|
return resultObject;
|
|
@@ -47,7 +47,6 @@ export class ProjectContext {
|
|
|
47
47
|
}
|
|
48
48
|
|
|
49
49
|
public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
|
|
50
|
-
console.log(`Using the following files for the documentation:`);
|
|
51
50
|
filesArg.map((fileArg) => {
|
|
52
51
|
// console.log(` -> ${fileArg.relative}`);
|
|
53
52
|
});
|