@git.zone/tsdoc 1.2.2 → 1.3.1

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.
@@ -3,7 +3,7 @@
3
3
  */
4
4
  export const commitinfo = {
5
5
  name: '@git.zone/tsdoc',
6
- version: '1.2.2',
6
+ version: '1.3.1',
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=
@@ -3,6 +3,7 @@ export interface INextCommitObject {
3
3
  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE';
4
4
  recommendedNextVersionScope: string;
5
5
  recommendedNextVersionMessage: string;
6
+ recommendedNextVersionDetails: string[];
6
7
  recommendedNextVersion: string;
7
8
  changelog?: string;
8
9
  }
@@ -32,10 +32,12 @@ Important: Answer only in valid JSON.
32
32
  Your answer should be parseable with JSON.parse() without modifying anything.
33
33
 
34
34
  Here is the structure of the JSON you should return:
35
- {
35
+
36
+ interface {
36
37
  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
37
38
  recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
38
39
  recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
40
+ recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
39
41
  recommendedNextVersion: string; // the recommended next version of the project, x.x.x
40
42
  }
41
43
 
@@ -55,42 +57,39 @@ Also you are given a diff
55
57
  if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
56
58
  previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
57
59
  }
58
- let result2 = await this.aiDocsRef.openaiInstance.chat({
59
- messageHistory: [],
60
- systemMessage: `
61
- You are building a changelog file for the projext.
60
+ if (!previousChangelog) {
61
+ let result2 = await this.aiDocsRef.openaiInstance.chat({
62
+ messageHistory: [],
63
+ systemMessage: `
64
+ You are building a changelog.md file for the project.
62
65
  Omit commits and versions that lack relevant changes.
63
66
 
64
- You are given
65
- * the previous changelog file (if available)
66
- * the commit messages of the project
67
+ A changelog entry should look like this:
67
68
 
68
- Only return the changelog file, so it can be written directly to changelog.md
69
+ ## yyyy-mm-dd - x.x.x - scope here
70
+ main descriptiom here
71
+ - detailed bullet points follow
69
72
 
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.
73
- `,
74
- userMessage: `
75
- The previous changelog file is:
76
- ${!previousChangelog ? 'No previous changelog file found' : previousChangelog.contents.toString()}
73
+ You are given:
74
+ * the commit messages of the project
77
75
 
78
- Here are the commit messages so far:
76
+ Only return the changelog file, so it can be written directly to changelog.md`,
77
+ userMessage: `
78
+ Here are the commit messages:
79
79
 
80
- ${commitMessages.join('\n\n')}
81
- `,
82
- });
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;
80
+ ${commitMessages.join('\n')}
81
+ `,
82
+ });
83
+ previousChangelog = await plugins.smartfile.SmartFile.fromString(previousChangelogPath, result2.message, 'utf8');
92
84
  }
85
+ let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
86
+ let newDateString = new plugins.smarttime.ExtendedDate().exportToEuropeanDate();
87
+ let newChangelog = `# Changelog\n\n${`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
88
+ {{nextVersionMessage}}
89
+ {{nextVersionDetails}}
90
+ `}\n\n${oldChangelog}\n`;
91
+ resultObject.changelog = newChangelog;
93
92
  return resultObject;
94
93
  }
95
94
  }
96
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWl0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvY29tbWl0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFVckQsTUFBTSxPQUFPLE1BQU07SUFJakIsWUFBWSxTQUFnQixFQUFFLGFBQXFCO1FBQ2pELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELE1BQU0sZ0JBQWdCLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUIsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsQ0FDL0QsZ0JBQWdCLEVBQ2hCLElBQUksQ0FBQyxVQUFVLENBQ2hCLENBQUM7UUFDRixNQUFNLFVBQVUsR0FBRyxNQUFNLE9BQU8sQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO1FBQ3RELE1BQU0sY0FBYyxHQUFHLElBQUksY0FBYyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUMzRCxJQUFJLGFBQWEsR0FBRyxNQUFNLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNsRCxhQUFhLEdBQUc7RUFDbEIsYUFBYTs7OztFQUliLFVBQVUsSUFBSSxhQUFhO0tBQ3hCLENBQUM7UUFFRixJQUFJLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQztZQUNwRCxhQUFhLEVBQUU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztDQXFCcEI7WUFDSyxjQUFjLEVBQUUsRUFBRTtZQUNsQixXQUFXLEVBQUUsYUFBYTtTQUMzQixDQUFDLENBQUM7UUFFSCwrQkFBK0I7UUFDL0IsTUFBTSxZQUFZLEdBQXNCLElBQUksQ0FBQyxLQUFLLENBQ2hELE1BQU0sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLEVBQUUsQ0FBQyxDQUN6RCxDQUFDO1FBRUYseUNBQXlDO1FBQ3pDLE1BQU0sY0FBYyxHQUFHLE1BQU0sT0FBTyxDQUFDLG9CQUFvQixFQUFFLENBQUM7UUFDNUQsTUFBTSxxQkFBcUIsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLGNBQWMsQ0FBQyxDQUFDO1FBQ2pGLElBQUksaUJBQThDLENBQUM7UUFDbkQsSUFBSSxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxFQUFFLENBQUM7WUFDakUsaUJBQWlCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQUMscUJBQXFCLENBQUMsQ0FBQztRQUM1RixDQUFDO1FBQ0QsSUFBSSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUM7WUFDckQsY0FBYyxFQUFFLEVBQUU7WUFDbEIsYUFBYSxFQUFFOzs7Ozs7Ozs7Ozs7O09BYWQ7WUFDRCxXQUFXLEVBQUU7O0VBRWpCLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxDQUFDLGtDQUFrQyxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFOzs7O0VBSS9GLGNBQWMsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDO0NBQzVCO1NBQ0ksQ0FBQyxDQUFDO1FBQ0gsSUFBSSxpQkFBaUIsRUFBRSxDQUFDO1lBQ3RCLElBQUksWUFBWSxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUM7WUFDbkMsWUFBWSxHQUFHLFlBQVksQ0FBQyxPQUFPLENBQUMsaUJBQWlCLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDM0QsSUFBSSxZQUFZLEdBQUcsaUJBQWlCLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLE9BQU8sQ0FBQyxpQkFBaUIsRUFBRSxFQUFFLENBQUMsQ0FBQztZQUN4RixZQUFZLEdBQUcsa0JBQWtCLFlBQVksT0FBTyxZQUFZLEVBQUUsQ0FBQztZQUNuRSxZQUFZLENBQUMsU0FBUyxHQUFHLFlBQVksQ0FBQztRQUN4QyxDQUFDO2FBQU0sQ0FBQztZQUNOLFlBQVksQ0FBQyxTQUFTLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQztRQUMzQyxDQUFDO1FBQ0QsT0FBTyxZQUFZLENBQUM7SUFDdEIsQ0FBQztDQUNGIn0=
95
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWl0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvY29tbWl0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFXckQsTUFBTSxPQUFPLE1BQU07SUFJakIsWUFBWSxTQUFnQixFQUFFLGFBQXFCO1FBQ2pELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELE1BQU0sZ0JBQWdCLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUIsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsQ0FDL0QsZ0JBQWdCLEVBQ2hCLElBQUksQ0FBQyxVQUFVLENBQ2hCLENBQUM7UUFDRixNQUFNLFVBQVUsR0FBRyxNQUFNLE9BQU8sQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO1FBQ3RELE1BQU0sY0FBYyxHQUFHLElBQUksY0FBYyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUMzRCxJQUFJLGFBQWEsR0FBRyxNQUFNLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNsRCxhQUFhLEdBQUc7RUFDbEIsYUFBYTs7OztFQUliLFVBQVUsSUFBSSxhQUFhO0tBQ3hCLENBQUM7UUFFRixJQUFJLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQztZQUNwRCxhQUFhLEVBQUU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0NBdUJwQjtZQUNLLGNBQWMsRUFBRSxFQUFFO1lBQ2xCLFdBQVcsRUFBRSxhQUFhO1NBQzNCLENBQUMsQ0FBQztRQUVILCtCQUErQjtRQUMvQixNQUFNLFlBQVksR0FBc0IsSUFBSSxDQUFDLEtBQUssQ0FDaEQsTUFBTSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsU0FBUyxFQUFFLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQ3pELENBQUM7UUFFRix5Q0FBeUM7UUFDekMsTUFBTSxjQUFjLEdBQUcsTUFBTSxPQUFPLENBQUMsb0JBQW9CLEVBQUUsQ0FBQztRQUM1RCxNQUFNLHFCQUFxQixHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsY0FBYyxDQUFDLENBQUM7UUFDakYsSUFBSSxpQkFBOEMsQ0FBQztRQUNuRCxJQUFJLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLHFCQUFxQixDQUFDLEVBQUUsQ0FBQztZQUNqRSxpQkFBaUIsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLFlBQVksQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDO1FBQzVGLENBQUM7UUFFRCxJQUFJLENBQUMsaUJBQWlCLEVBQUUsQ0FBQztZQUN2QixJQUFJLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQztnQkFDckQsY0FBYyxFQUFFLEVBQUU7Z0JBQ2xCLGFBQWEsRUFBRTs7Ozs7Ozs7Ozs7Ozs4RUFhdUQ7Z0JBQ3RFLFdBQVcsRUFBRTs7O0VBR25CLGNBQWMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO0dBQ3hCO2FBQ0ksQ0FBQyxDQUFDO1lBRUgsaUJBQWlCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMscUJBQXFCLEVBQUUsT0FBTyxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsQ0FBQztRQUNuSCxDQUFDO1FBRUQsSUFBSSxZQUFZLEdBQUcsaUJBQWlCLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLE9BQU8sQ0FBQyxpQkFBaUIsRUFBRSxFQUFFLENBQUMsQ0FBQztRQUN4RixJQUFJLGFBQWEsR0FBRyxJQUFJLE9BQU8sQ0FBQyxTQUFTLENBQUMsWUFBWSxFQUFFLENBQUMsb0JBQW9CLEVBQUUsQ0FBQztRQUNoRixJQUFJLFlBQVksR0FBRyxrQkFDdkIsTUFBTSxhQUFhOzs7Q0FHbEIsT0FBTyxZQUFZLElBQUksQ0FBQztRQUNyQixZQUFZLENBQUMsU0FBUyxHQUFHLFlBQVksQ0FBQztRQUV0QyxPQUFPLFlBQVksQ0FBQztJQUN0QixDQUFDO0NBQ0YifQ==
@@ -1,14 +1,5 @@
1
+ import { commitinfo } from './00_commitinfo_data.js';
1
2
  import * as plugins from './plugins.js';
2
- export const logger = new plugins.smartlog.Smartlog({
3
- logContext: {
4
- company: 'Some Company',
5
- companyunit: 'Some CompanyUnit',
6
- containerName: 'Some Containername',
7
- environment: 'local',
8
- runtime: 'node',
9
- zone: 'gitzone',
10
- },
11
- minimumLogLevel: 'silly',
12
- });
3
+ export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
13
4
  logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());
14
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nZ2luZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2xvZ2dpbmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxjQUFjLENBQUM7QUFFeEMsTUFBTSxDQUFDLE1BQU0sTUFBTSxHQUFHLElBQUksT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUM7SUFDbEQsVUFBVSxFQUFFO1FBQ1YsT0FBTyxFQUFFLGNBQWM7UUFDdkIsV0FBVyxFQUFFLGtCQUFrQjtRQUMvQixhQUFhLEVBQUUsb0JBQW9CO1FBQ25DLFdBQVcsRUFBRSxPQUFPO1FBQ3BCLE9BQU8sRUFBRSxNQUFNO1FBQ2YsSUFBSSxFQUFFLFNBQVM7S0FDaEI7SUFDRCxlQUFlLEVBQUUsT0FBTztDQUN6QixDQUFDLENBQUM7QUFFSCxNQUFNLENBQUMsaUJBQWlCLENBQUMsSUFBSSxPQUFPLENBQUMsd0JBQXdCLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQyxDQUFDIn0=
5
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nZ2luZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2xvZ2dpbmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBQ3JELE9BQU8sS0FBSyxPQUFPLE1BQU0sY0FBYyxDQUFDO0FBRXhDLE1BQU0sQ0FBQyxNQUFNLE1BQU0sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsQ0FBQyxtQkFBbUIsQ0FBQyxVQUFVLENBQUMsQ0FBQztBQUVoRixNQUFNLENBQUMsaUJBQWlCLENBQUMsSUFBSSxPQUFPLENBQUMsd0JBQXdCLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQyxDQUFDIn0=
@@ -13,6 +13,7 @@ import * as smartlog from '@push.rocks/smartlog';
13
13
  import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
14
14
  import * as smartpath from '@push.rocks/smartpath';
15
15
  import * as smartshell from '@push.rocks/smartshell';
16
- export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartgit, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell, };
16
+ import * as smarttime from '@push.rocks/smarttime';
17
+ export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartgit, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell, smarttime, };
17
18
  import * as typedoc from 'typedoc';
18
19
  export { typedoc };
@@ -14,8 +14,9 @@ import * as smartlog from '@push.rocks/smartlog';
14
14
  import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
15
15
  import * as smartpath from '@push.rocks/smartpath';
16
16
  import * as smartshell from '@push.rocks/smartshell';
17
- export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartgit, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell, };
17
+ import * as smarttime from '@push.rocks/smarttime';
18
+ export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartgit, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell, smarttime, };
18
19
  // third party scope
19
20
  import * as typedoc from 'typedoc';
20
21
  export { typedoc };
21
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3BsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYztBQUNkLE9BQU8sS0FBSyxJQUFJLE1BQU0sTUFBTSxDQUFDO0FBRTdCLE9BQU8sRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUVoQixrQkFBa0I7QUFDbEIsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssSUFBSSxNQUFNLGtCQUFrQixDQUFDO0FBQ3pDLE9BQU8sS0FBSyxPQUFPLE1BQU0scUJBQXFCLENBQUM7QUFDL0MsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssVUFBVSxNQUFNLHdCQUF3QixDQUFDO0FBQ3JELE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssYUFBYSxNQUFNLDJCQUEyQixDQUFDO0FBQzNELE9BQU8sS0FBSyxRQUFRLE1BQU0sc0JBQXNCLENBQUM7QUFDakQsT0FBTyxLQUFLLHdCQUF3QixNQUFNLHdDQUF3QyxDQUFDO0FBQ25GLE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFVBQVUsTUFBTSx3QkFBd0IsQ0FBQztBQUVyRCxPQUFPLEVBQ0wsUUFBUSxFQUNSLElBQUksRUFDSixPQUFPLEVBQ1AsUUFBUSxFQUNSLFVBQVUsRUFDVixTQUFTLEVBQ1QsUUFBUSxFQUNSLGFBQWEsRUFDYixRQUFRLEVBQ1Isd0JBQXdCLEVBQ3hCLFNBQVMsRUFDVCxVQUFVLEdBQ1gsQ0FBQztBQUVGLG9CQUFvQjtBQUNwQixPQUFPLEtBQUssT0FBTyxNQUFNLFNBQVMsQ0FBQztBQUVuQyxPQUFPLEVBQUUsT0FBTyxFQUFFLENBQUMifQ==
22
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3BsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYztBQUNkLE9BQU8sS0FBSyxJQUFJLE1BQU0sTUFBTSxDQUFDO0FBRTdCLE9BQU8sRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUVoQixrQkFBa0I7QUFDbEIsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssSUFBSSxNQUFNLGtCQUFrQixDQUFDO0FBQ3pDLE9BQU8sS0FBSyxPQUFPLE1BQU0scUJBQXFCLENBQUM7QUFDL0MsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssVUFBVSxNQUFNLHdCQUF3QixDQUFDO0FBQ3JELE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssYUFBYSxNQUFNLDJCQUEyQixDQUFDO0FBQzNELE9BQU8sS0FBSyxRQUFRLE1BQU0sc0JBQXNCLENBQUM7QUFDakQsT0FBTyxLQUFLLHdCQUF3QixNQUFNLHdDQUF3QyxDQUFDO0FBQ25GLE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFVBQVUsTUFBTSx3QkFBd0IsQ0FBQztBQUNyRCxPQUFPLEtBQUssU0FBUyxNQUFNLHVCQUF1QixDQUFDO0FBRW5ELE9BQU8sRUFDTCxRQUFRLEVBQ1IsSUFBSSxFQUNKLE9BQU8sRUFDUCxRQUFRLEVBQ1IsVUFBVSxFQUNWLFNBQVMsRUFDVCxRQUFRLEVBQ1IsYUFBYSxFQUNiLFFBQVEsRUFDUix3QkFBd0IsRUFDeEIsU0FBUyxFQUNULFVBQVUsRUFDVixTQUFTLEdBQ1YsQ0FBQztBQUVGLG9CQUFvQjtBQUNwQixPQUFPLEtBQUssT0FBTyxNQUFNLFNBQVMsQ0FBQztBQUVuQyxPQUFPLEVBQUUsT0FBTyxFQUFFLENBQUMifQ==
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@git.zone/tsdoc",
3
- "version": "1.2.2",
3
+ "version": "1.3.1",
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",
@@ -33,6 +33,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
+ "@push.rocks/smarttime": "^4.0.6",
36
37
  "typedoc": "^0.26.0",
37
38
  "typescript": "^5.5.2"
38
39
  },
@@ -3,6 +3,6 @@
3
3
  */
4
4
  export const commitinfo = {
5
5
  name: '@git.zone/tsdoc',
6
- version: '1.2.2',
6
+ version: '1.3.1',
7
7
  description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
8
8
  }
@@ -6,6 +6,7 @@ export interface INextCommitObject {
6
6
  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
7
7
  recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
8
8
  recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
9
+ recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
9
10
  recommendedNextVersion: string; // the recommended next version of the project, x.x.x
10
11
  changelog?: string; // the changelog for the next version
11
12
  }
@@ -49,10 +50,12 @@ Important: Answer only in valid JSON.
49
50
  Your answer should be parseable with JSON.parse() without modifying anything.
50
51
 
51
52
  Here is the structure of the JSON you should return:
52
- {
53
+
54
+ interface {
53
55
  recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
54
56
  recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
55
57
  recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
58
+ recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
56
59
  recommendedNextVersion: string; // the recommended next version of the project, x.x.x
57
60
  }
58
61
 
@@ -76,40 +79,43 @@ Also you are given a diff
76
79
  if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
77
80
  previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
78
81
  }
79
- let result2 = await this.aiDocsRef.openaiInstance.chat({
80
- messageHistory: [],
81
- systemMessage: `
82
- You are building a changelog file for the projext.
82
+
83
+ if (!previousChangelog) {
84
+ let result2 = await this.aiDocsRef.openaiInstance.chat({
85
+ messageHistory: [],
86
+ systemMessage: `
87
+ You are building a changelog.md file for the project.
83
88
  Omit commits and versions that lack relevant changes.
84
89
 
85
- You are given
86
- * the previous changelog file (if available)
87
- * the commit messages of the project
90
+ A changelog entry should look like this:
88
91
 
89
- Only return the changelog file, so it can be written directly to changelog.md
92
+ ## yyyy-mm-dd - x.x.x - scope here
93
+ main descriptiom here
94
+ - detailed bullet points follow
90
95
 
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.
94
- `,
95
- userMessage: `
96
- The previous changelog file is:
97
- ${!previousChangelog ? 'No previous changelog file found' : previousChangelog.contents.toString()}
96
+ You are given:
97
+ * the commit messages of the project
98
98
 
99
- Here are the commit messages so far:
99
+ Only return the changelog file, so it can be written directly to changelog.md`,
100
+ userMessage: `
101
+ Here are the commit messages:
100
102
 
101
- ${commitMessages.join('\n\n')}
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;
103
+ ${commitMessages.join('\n')}
104
+ `,
105
+ });
106
+
107
+ previousChangelog = await plugins.smartfile.SmartFile.fromString(previousChangelogPath, result2.message, 'utf8');
112
108
  }
109
+
110
+ let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
111
+ let newDateString = new plugins.smarttime.ExtendedDate().exportToEuropeanDate();
112
+ let newChangelog = `# Changelog\n\n${
113
+ `## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
114
+ {{nextVersionMessage}}
115
+ {{nextVersionDetails}}
116
+ `}\n\n${oldChangelog}\n`;
117
+ resultObject.changelog = newChangelog;
118
+
113
119
  return resultObject;
114
120
  }
115
121
  }
package/ts/logging.ts CHANGED
@@ -1,15 +1,6 @@
1
+ import { commitinfo } from './00_commitinfo_data.js';
1
2
  import * as plugins from './plugins.js';
2
3
 
3
- export const logger = new plugins.smartlog.Smartlog({
4
- logContext: {
5
- company: 'Some Company',
6
- companyunit: 'Some CompanyUnit',
7
- containerName: 'Some Containername',
8
- environment: 'local',
9
- runtime: 'node',
10
- zone: 'gitzone',
11
- },
12
- minimumLogLevel: 'silly',
13
- });
4
+ export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
14
5
 
15
6
  logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());
package/ts/plugins.ts CHANGED
@@ -16,6 +16,7 @@ import * as smartlog from '@push.rocks/smartlog';
16
16
  import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
17
17
  import * as smartpath from '@push.rocks/smartpath';
18
18
  import * as smartshell from '@push.rocks/smartshell';
19
+ import * as smarttime from '@push.rocks/smarttime';
19
20
 
20
21
  export {
21
22
  npmextra,
@@ -30,6 +31,7 @@ export {
30
31
  smartlogDestinationLocal,
31
32
  smartpath,
32
33
  smartshell,
34
+ smarttime,
33
35
  };
34
36
 
35
37
  // third party scope