@git.zone/tsdoc 1.3.1 → 1.3.4
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 +6 -5
- package/dist_ts/aidocs_classes/projectcontext.js +2 -2
- package/package.json +3 -3
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/aidocs_classes/commit.ts +12 -8
- package/ts/aidocs_classes/projectcontext.ts +1 -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.4',
|
|
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=
|
|
@@ -50,14 +50,14 @@ Also you are given a diff
|
|
|
50
50
|
});
|
|
51
51
|
// console.log(result.message);
|
|
52
52
|
const resultObject = JSON.parse(result.message.replace('```json', '').replace('```', ''));
|
|
53
|
-
// lets build the changelog based on that
|
|
54
|
-
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
55
53
|
const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
|
|
56
54
|
let previousChangelog;
|
|
57
55
|
if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
|
|
58
56
|
previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
|
|
59
57
|
}
|
|
60
58
|
if (!previousChangelog) {
|
|
59
|
+
// lets build the changelog based on that
|
|
60
|
+
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
61
61
|
let result2 = await this.aiDocsRef.openaiInstance.chat({
|
|
62
62
|
messageHistory: [],
|
|
63
63
|
systemMessage: `
|
|
@@ -77,19 +77,20 @@ Only return the changelog file, so it can be written directly to changelog.md`,
|
|
|
77
77
|
userMessage: `
|
|
78
78
|
Here are the commit messages:
|
|
79
79
|
|
|
80
|
-
${
|
|
80
|
+
${JSON.stringify(commitMessages, null, 2)}
|
|
81
81
|
`,
|
|
82
82
|
});
|
|
83
83
|
previousChangelog = await plugins.smartfile.SmartFile.fromString(previousChangelogPath, result2.message, 'utf8');
|
|
84
84
|
}
|
|
85
85
|
let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
|
|
86
|
-
let newDateString = new plugins.smarttime.ExtendedDate().
|
|
86
|
+
let newDateString = new plugins.smarttime.ExtendedDate().exportToHyphedSortableDate();
|
|
87
87
|
let newChangelog = `# Changelog\n\n${`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
|
|
88
88
|
{{nextVersionMessage}}
|
|
89
|
+
|
|
89
90
|
{{nextVersionDetails}}
|
|
90
91
|
`}\n\n${oldChangelog}\n`;
|
|
91
92
|
resultObject.changelog = newChangelog;
|
|
92
93
|
return resultObject;
|
|
93
94
|
}
|
|
94
95
|
}
|
|
95
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
96
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWl0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvY29tbWl0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFXckQsTUFBTSxPQUFPLE1BQU07SUFJakIsWUFBWSxTQUFnQixFQUFFLGFBQXFCO1FBQ2pELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELE1BQU0sZ0JBQWdCLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUIsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsQ0FDL0QsZ0JBQWdCLEVBQ2hCLElBQUksQ0FBQyxVQUFVLENBQ2hCLENBQUM7UUFDRixNQUFNLFVBQVUsR0FBRyxNQUFNLE9BQU8sQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO1FBQ3RELE1BQU0sY0FBYyxHQUFHLElBQUksY0FBYyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUMzRCxJQUFJLGFBQWEsR0FBRyxNQUFNLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNsRCxhQUFhLEdBQUc7RUFDbEIsYUFBYTs7OztFQUliLFVBQVUsSUFBSSxhQUFhO0tBQ3hCLENBQUM7UUFFRixJQUFJLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQztZQUNwRCxhQUFhLEVBQUU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0NBdUJwQjtZQUNLLGNBQWMsRUFBRSxFQUFFO1lBQ2xCLFdBQVcsRUFBRSxhQUFhO1NBQzNCLENBQUMsQ0FBQztRQUVILCtCQUErQjtRQUMvQixNQUFNLFlBQVksR0FBc0IsSUFBSSxDQUFDLEtBQUssQ0FDaEQsTUFBTSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsU0FBUyxFQUFFLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQ3pELENBQUM7UUFFRixNQUFNLHFCQUFxQixHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsY0FBYyxDQUFDLENBQUM7UUFDakYsSUFBSSxpQkFBOEMsQ0FBQztRQUNuRCxJQUFJLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLHFCQUFxQixDQUFDLEVBQUUsQ0FBQztZQUNqRSxpQkFBaUIsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLFlBQVksQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDO1FBQzVGLENBQUM7UUFFRCxJQUFJLENBQUMsaUJBQWlCLEVBQUUsQ0FBQztZQUN2Qix5Q0FBeUM7WUFDekMsTUFBTSxjQUFjLEdBQUcsTUFBTSxPQUFPLENBQUMsb0JBQW9CLEVBQUUsQ0FBQztZQUM1RCxJQUFJLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQztnQkFDckQsY0FBYyxFQUFFLEVBQUU7Z0JBQ2xCLGFBQWEsRUFBRTs7Ozs7Ozs7Ozs7Ozs4RUFhdUQ7Z0JBQ3RFLFdBQVcsRUFBRTs7O0VBR25CLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7R0FDdEM7YUFDSSxDQUFDLENBQUM7WUFFSCxpQkFBaUIsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLFVBQVUsQ0FDOUQscUJBQXFCLEVBQ3JCLE9BQU8sQ0FBQyxPQUFPLEVBQ2YsTUFBTSxDQUNQLENBQUM7UUFDSixDQUFDO1FBRUQsSUFBSSxZQUFZLEdBQUcsaUJBQWlCLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLE9BQU8sQ0FBQyxpQkFBaUIsRUFBRSxFQUFFLENBQUMsQ0FBQztRQUN4RixJQUFJLGFBQWEsR0FBRyxJQUFJLE9BQU8sQ0FBQyxTQUFTLENBQUMsWUFBWSxFQUFFLENBQUMsMEJBQTBCLEVBQUUsQ0FBQztRQUN0RixJQUFJLFlBQVksR0FBRyxrQkFBa0IsTUFBTSxhQUFhOzs7O0NBSTNELE9BQU8sWUFBWSxJQUFJLENBQUM7UUFDckIsWUFBWSxDQUFDLFNBQVMsR0FBRyxZQUFZLENBQUM7UUFFdEMsT0FBTyxZQUFZLENBQUM7SUFDdEIsQ0FBQztDQUNGIn0=
|
|
@@ -23,7 +23,7 @@ export class ProjectContext {
|
|
|
23
23
|
async convertFilesToContext(filesArg) {
|
|
24
24
|
console.log(`Using the following files for the documentation:`);
|
|
25
25
|
filesArg.map((fileArg) => {
|
|
26
|
-
console.log(` -> ${fileArg.relative}`);
|
|
26
|
+
// console.log(` -> ${fileArg.relative}`);
|
|
27
27
|
});
|
|
28
28
|
return filesArg
|
|
29
29
|
.map((smartfile) => {
|
|
@@ -55,4 +55,4 @@ ${smartfile.contents.toString()}
|
|
|
55
55
|
return result;
|
|
56
56
|
}
|
|
57
57
|
}
|
|
58
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
58
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGNvbnRleHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9haWRvY3NfY2xhc3Nlcy9wcm9qZWN0Y29udGV4dC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQztBQUV6QyxNQUFNLE9BQU8sY0FBYztJQUNsQixNQUFNLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFjLElBQUcsQ0FBQztJQUs5QyxZQUFZLGFBQXFCO1FBQy9CLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMsV0FBVztRQUN0QixNQUFNLG9CQUFvQixHQUFHLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUN6RSxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLGNBQWMsQ0FBQyxFQUNsRCxJQUFJLENBQUMsVUFBVSxDQUNoQixDQUFDO1FBQ0YsTUFBTSxnQkFBZ0IsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLFlBQVksQ0FDckUsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxXQUFXLENBQUMsRUFDL0MsSUFBSSxDQUFDLFVBQVUsQ0FDaEIsQ0FBQztRQUVGLE1BQU0scUJBQXFCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQzFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsaUJBQWlCLENBQUMsRUFDckQsSUFBSSxDQUFDLFVBQVUsQ0FDaEIsQ0FBQztRQUNGLE1BQU0sc0JBQXNCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQzNFLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsZUFBZSxDQUFDLEVBQ25ELElBQUksQ0FBQyxVQUFVLENBQ2hCLENBQUM7UUFDRixNQUFNLGFBQWEsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGdCQUFnQixDQUMvRCxJQUFJLENBQUMsVUFBVSxFQUNmLGFBQWEsQ0FDZCxDQUFDO1FBQ0YsTUFBTSxjQUFjLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FDaEUsSUFBSSxDQUFDLFVBQVUsRUFDZixjQUFjLENBQ2YsQ0FBQztRQUNGLE9BQU87WUFDTCxvQkFBb0I7WUFDcEIsZ0JBQWdCO1lBQ2hCLHFCQUFxQjtZQUNyQixzQkFBc0I7WUFDdEIsYUFBYTtZQUNiLGNBQWM7U0FDZixDQUFDO0lBQ0osQ0FBQztJQUVNLEtBQUssQ0FBQyxxQkFBcUIsQ0FBQyxRQUF1QztRQUN4RSxPQUFPLENBQUMsR0FBRyxDQUFDLGtEQUFrRCxDQUFDLENBQUM7UUFDaEUsUUFBUSxDQUFDLEdBQUcsQ0FBQyxDQUFDLE9BQU8sRUFBRSxFQUFFO1lBQ3ZCLDJDQUEyQztRQUM3QyxDQUFDLENBQUMsQ0FBQztRQUNILE9BQU8sUUFBUTthQUNaLEdBQUcsQ0FBQyxDQUFDLFNBQVMsRUFBRSxFQUFFO1lBQ2pCLE9BQU87dUJBQ1EsU0FBUyxDQUFDLFFBQVE7O0VBRXZDLFNBQVMsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFOztxQkFFVixTQUFTLENBQUMsUUFBUTtTQUM5QixDQUFDO1FBQ0osQ0FBQyxDQUFDO2FBQ0QsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ2hCLENBQUM7SUFFTyxLQUFLLENBQUMsWUFBWSxDQUFDLE1BQWM7UUFDdkMsTUFBTSxLQUFLLEdBQUcsTUFBTSxJQUFJLENBQUMsV0FBVyxFQUFFLENBQUM7UUFDdkMsSUFBSSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMscUJBQXFCLENBQUM7WUFDN0MsS0FBSyxDQUFDLG9CQUFvQjtZQUMxQixLQUFLLENBQUMsZ0JBQWdCO1lBQ3RCLEtBQUssQ0FBQyxxQkFBcUI7WUFDM0IsS0FBSyxDQUFDLHNCQUFzQjtZQUM1QixHQUFHLEtBQUssQ0FBQyxhQUFhO1lBQ3RCLEdBQUcsS0FBSyxDQUFDLGNBQWM7U0FDeEIsQ0FBQyxDQUFDO1FBQ0gsd0JBQXdCO1FBQ3hCLE9BQU8sT0FBTyxDQUFDO0lBQ2pCLENBQUM7SUFFTSxLQUFLLENBQUMsTUFBTTtRQUNqQixNQUFNLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ3hELE9BQU8sTUFBTSxDQUFDO0lBQ2hCLENBQUM7Q0FDRiJ9
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@git.zone/tsdoc",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.4",
|
|
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",
|
|
@@ -27,14 +27,14 @@
|
|
|
27
27
|
"@push.rocks/smartcli": "^4.0.11",
|
|
28
28
|
"@push.rocks/smartdelay": "^3.0.5",
|
|
29
29
|
"@push.rocks/smartfile": "^11.0.20",
|
|
30
|
-
"@push.rocks/smartgit": "^3.0
|
|
30
|
+
"@push.rocks/smartgit": "^3.1.0",
|
|
31
31
|
"@push.rocks/smartinteract": "^2.0.15",
|
|
32
32
|
"@push.rocks/smartlog": "^3.0.7",
|
|
33
33
|
"@push.rocks/smartlog-destination-local": "^9.0.2",
|
|
34
34
|
"@push.rocks/smartpath": "^5.0.18",
|
|
35
35
|
"@push.rocks/smartshell": "^3.0.5",
|
|
36
36
|
"@push.rocks/smarttime": "^4.0.6",
|
|
37
|
-
"typedoc": "^0.26.
|
|
37
|
+
"typedoc": "^0.26.1",
|
|
38
38
|
"typescript": "^5.5.2"
|
|
39
39
|
},
|
|
40
40
|
"files": [
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -72,8 +72,6 @@ Also you are given a diff
|
|
|
72
72
|
result.message.replace('```json', '').replace('```', '')
|
|
73
73
|
);
|
|
74
74
|
|
|
75
|
-
// lets build the changelog based on that
|
|
76
|
-
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
77
75
|
const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
|
|
78
76
|
let previousChangelog: plugins.smartfile.SmartFile;
|
|
79
77
|
if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
|
|
@@ -81,6 +79,8 @@ Also you are given a diff
|
|
|
81
79
|
}
|
|
82
80
|
|
|
83
81
|
if (!previousChangelog) {
|
|
82
|
+
// lets build the changelog based on that
|
|
83
|
+
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
84
84
|
let result2 = await this.aiDocsRef.openaiInstance.chat({
|
|
85
85
|
messageHistory: [],
|
|
86
86
|
systemMessage: `
|
|
@@ -100,18 +100,22 @@ Only return the changelog file, so it can be written directly to changelog.md`,
|
|
|
100
100
|
userMessage: `
|
|
101
101
|
Here are the commit messages:
|
|
102
102
|
|
|
103
|
-
${
|
|
103
|
+
${JSON.stringify(commitMessages, null, 2)}
|
|
104
104
|
`,
|
|
105
105
|
});
|
|
106
|
-
|
|
107
|
-
previousChangelog = await plugins.smartfile.SmartFile.fromString(
|
|
106
|
+
|
|
107
|
+
previousChangelog = await plugins.smartfile.SmartFile.fromString(
|
|
108
|
+
previousChangelogPath,
|
|
109
|
+
result2.message,
|
|
110
|
+
'utf8'
|
|
111
|
+
);
|
|
108
112
|
}
|
|
109
113
|
|
|
110
114
|
let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
|
|
111
|
-
let newDateString = new plugins.smarttime.ExtendedDate().
|
|
112
|
-
let newChangelog = `# Changelog\n\n${
|
|
113
|
-
`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
|
|
115
|
+
let newDateString = new plugins.smarttime.ExtendedDate().exportToHyphedSortableDate();
|
|
116
|
+
let newChangelog = `# Changelog\n\n${`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
|
|
114
117
|
{{nextVersionMessage}}
|
|
118
|
+
|
|
115
119
|
{{nextVersionDetails}}
|
|
116
120
|
`}\n\n${oldChangelog}\n`;
|
|
117
121
|
resultObject.changelog = newChangelog;
|
|
@@ -49,7 +49,7 @@ export class ProjectContext {
|
|
|
49
49
|
public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
|
|
50
50
|
console.log(`Using the following files for the documentation:`);
|
|
51
51
|
filesArg.map((fileArg) => {
|
|
52
|
-
console.log(` -> ${fileArg.relative}`);
|
|
52
|
+
// console.log(` -> ${fileArg.relative}`);
|
|
53
53
|
});
|
|
54
54
|
return filesArg
|
|
55
55
|
.map((smartfile) => {
|