@git.zone/tsdoc 1.1.35 → 1.1.37
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.d.ts +2 -1
- package/dist_ts/aidocs_classes/commit.js +4 -3
- package/dist_ts/classes.aidoc.d.ts +1 -1
- package/dist_ts/classes.aidoc.js +4 -4
- package/package.json +1 -1
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/aidocs_classes/commit.ts +5 -3
- package/ts/classes.aidoc.ts +4 -4
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@git.zone/tsdoc',
|
|
6
|
-
version: '1.1.
|
|
6
|
+
version: '1.1.37',
|
|
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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxpQkFBaUI7SUFDdkIsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLG1IQUFtSDtDQUNqSSxDQUFBIn0=
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { AiDoc } from '../classes.aidoc.js';
|
|
2
2
|
export interface INextCommitObject {
|
|
3
|
-
recommendedNextVersionLevel: '
|
|
3
|
+
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE';
|
|
4
|
+
recommendedScope: string;
|
|
4
5
|
recommendedNextVersion: string;
|
|
5
6
|
message: string;
|
|
6
7
|
changelog?: string;
|
|
@@ -32,9 +32,10 @@ Your answer should be parseable with JSON.parse() without modifying anything.
|
|
|
32
32
|
|
|
33
33
|
Here is the structure of the JSON you should return:
|
|
34
34
|
{
|
|
35
|
-
recommendedNextVersionLevel: '
|
|
35
|
+
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
|
36
|
+
recommendedScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
|
36
37
|
recommendedNextVersion: string; // the recommended next version of the project
|
|
37
|
-
message: string; // the commit message.
|
|
38
|
+
message: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
|
|
38
39
|
}
|
|
39
40
|
|
|
40
41
|
You are being given the files of the project. You should use them to create the commit message.
|
|
@@ -80,4 +81,4 @@ ${commitMessages.join('\n\n')}
|
|
|
80
81
|
return resultObject;
|
|
81
82
|
}
|
|
82
83
|
}
|
|
83
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
84
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWl0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvY29tbWl0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFVckQsTUFBTSxPQUFPLE1BQU07SUFJakIsWUFBWSxTQUFnQixFQUFFLGFBQXFCO1FBQ2pELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELE1BQU0sZ0JBQWdCLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUIsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxnQkFBZ0IsRUFBRSxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDckcsTUFBTSxVQUFVLEdBQUcsTUFBTSxPQUFPLENBQUMsa0JBQWtCLEVBQUUsQ0FBQztRQUN0RCxNQUFNLGNBQWMsR0FBRyxJQUFJLGNBQWMsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDM0QsSUFBSSxhQUFhLEdBQUcsTUFBTSxjQUFjLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDbEQsYUFBYSxHQUFHO0VBQ2xCLGFBQWE7OztFQUdiLFVBQVU7S0FDUCxDQUFBO1FBRUQsSUFBSSxNQUFNLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUM7WUFDcEQsYUFBYSxFQUFFOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Q0FxQnBCO1lBQ0ssY0FBYyxFQUFFLEVBQUU7WUFDbEIsV0FBVyxFQUFFLGFBQWE7U0FDM0IsQ0FBQyxDQUFDO1FBRUgsK0JBQStCO1FBQy9CLE1BQU0sWUFBWSxHQUFzQixJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFFN0cseUNBQXlDO1FBQ3pDLE1BQU0sY0FBYyxHQUFHLE1BQU0sT0FBTyxDQUFDLG9CQUFvQixFQUFFLENBQUM7UUFDNUQsTUFBTSxxQkFBcUIsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLGNBQWMsQ0FBQyxDQUFDO1FBQ2pGLElBQUksaUJBQThDLENBQUM7UUFDbkQsSUFBSSxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxFQUFFLENBQUM7WUFDakUsaUJBQWlCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQUMscUJBQXFCLENBQUMsQ0FBQztRQUM1RixDQUFDO1FBQ0QsSUFBSSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUM7WUFDckQsY0FBYyxFQUFFLEVBQUU7WUFDbEIsYUFBYSxFQUFFOzs7Ozs7Ozs7OztPQVdkO1lBQ0QsV0FBVyxFQUFFOztFQUVqQixDQUFDLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxDQUFDLENBQUMsa0NBQWtDLENBQUMsQ0FBQyxDQUFDLGlCQUFpQixDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUU7Ozs7RUFJakcsY0FBYyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUM7Q0FDNUI7U0FDSSxDQUFDLENBQUE7UUFDRixZQUFZLENBQUMsU0FBUyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUM7UUFDekMsT0FBTyxZQUFZLENBQUM7SUFDdEIsQ0FBQztDQUNGIn0=
|
|
@@ -4,7 +4,7 @@ export declare class AiDoc {
|
|
|
4
4
|
private openaiToken;
|
|
5
5
|
npmextraKV: plugins.npmextra.KeyValueStore;
|
|
6
6
|
qenvInstance: plugins.qenv.Qenv;
|
|
7
|
-
|
|
7
|
+
aidocInteract: plugins.smartinteract.SmartInteract;
|
|
8
8
|
openaiInstance: plugins.smartai.OpenAiProvider;
|
|
9
9
|
argvArg: any;
|
|
10
10
|
constructor(argvArg?: any);
|
package/dist_ts/classes.aidoc.js
CHANGED
|
@@ -21,7 +21,7 @@ export class AiDoc {
|
|
|
21
21
|
}
|
|
22
22
|
async start() {
|
|
23
23
|
// lets care about prerequisites
|
|
24
|
-
this.
|
|
24
|
+
this.aidocInteract = new plugins.smartinteract.SmartInteract();
|
|
25
25
|
this.qenvInstance = new plugins.qenv.Qenv();
|
|
26
26
|
if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
|
|
27
27
|
this.npmextraKV = new plugins.npmextra.KeyValueStore({
|
|
@@ -39,9 +39,9 @@ export class AiDoc {
|
|
|
39
39
|
// lets try smartinteract
|
|
40
40
|
// wait for a second until OpenAI fixes punycode problem...
|
|
41
41
|
await plugins.smartdelay.delayFor(1000);
|
|
42
|
-
const answerObject = await this.
|
|
42
|
+
const answerObject = await this.aidocInteract.askQuestion({
|
|
43
43
|
type: 'input',
|
|
44
|
-
message: `Please provide your OpenAI token
|
|
44
|
+
message: `Please provide your OpenAI token. This will be persisted in your home directory.`,
|
|
45
45
|
name: 'OPENAI_TOKEN',
|
|
46
46
|
default: '',
|
|
47
47
|
});
|
|
@@ -77,4 +77,4 @@ export class AiDoc {
|
|
|
77
77
|
return await projectContextInstance.gatherFiles();
|
|
78
78
|
}
|
|
79
79
|
}
|
|
80
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
80
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy5haWRvYy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2NsYXNzZXMuYWlkb2MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxjQUFjLENBQUM7QUFFeEMsT0FBTyxLQUFLLGFBQWEsTUFBTSwyQkFBMkIsQ0FBQztBQUUzRCxNQUFNLE9BQU8sS0FBSztJQVVoQixZQUFZLE9BQWE7UUFDdkIsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUM7SUFDekIsQ0FBQztJQUVPLG1CQUFtQjtRQUN6QixpRkFBaUY7UUFDakYsSUFBSSxVQUFrQixDQUFDO1FBQ3ZCLElBQUksSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDaEMsbURBQW1EO1lBQ25ELE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsU0FBUyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztZQUMvQyxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQztZQUNwRSxVQUFVLEdBQUcsR0FBRyxLQUFLLE1BQU0sR0FBRyxFQUFFLENBQUM7UUFDbkMsQ0FBQzthQUFNLENBQUM7WUFDTixtREFBbUQ7WUFDbkQsVUFBVSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUM7UUFDaEMsQ0FBQztRQUNELE9BQU8sQ0FBQyxHQUFHLENBQUMsMkJBQTJCLFVBQVUsRUFBRSxDQUFDLENBQUM7SUFDdkQsQ0FBQztJQUVNLEtBQUssQ0FBQyxLQUFLO1FBQ2hCLGdDQUFnQztRQUNoQyxJQUFJLENBQUMsYUFBYSxHQUFHLElBQUksT0FBTyxDQUFDLGFBQWEsQ0FBQyxhQUFhLEVBQUUsQ0FBQztRQUMvRCxJQUFJLENBQUMsWUFBWSxHQUFHLElBQUksT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUM1QyxJQUFJLENBQUMsQ0FBQyxNQUFNLElBQUksQ0FBQyxZQUFZLENBQUMsaUJBQWlCLENBQUMsY0FBYyxDQUFDLENBQUMsRUFBRSxDQUFDO1lBQ2pFLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLGFBQWEsQ0FBQztnQkFDbkQsT0FBTyxFQUFFLGFBQWE7Z0JBQ3RCLFdBQVcsRUFBRSxPQUFPO2dCQUNwQixhQUFhLEVBQUUsQ0FBQyxjQUFjLENBQUM7YUFDaEMsQ0FBQyxDQUFDO1lBRUgsTUFBTSxXQUFXLEdBQUcsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLHVCQUF1QixFQUFFLENBQUM7WUFDcEUsSUFBSSxXQUFXLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRSxDQUFDO2dCQUMzQixnQkFBZ0I7Z0JBQ2hCLElBQUksSUFBSSxDQUFDLE9BQU8sRUFBRSxZQUFZLEVBQUUsQ0FBQztvQkFDL0IsSUFBSSxDQUFDLFdBQVcsR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQztnQkFDL0MsQ0FBQztxQkFBTSxDQUFDO29CQUNOLHlCQUF5QjtvQkFDekIsMkRBQTJEO29CQUMzRCxNQUFNLE9BQU8sQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO29CQUN4QyxNQUFNLFlBQVksR0FBRyxNQUFNLElBQUksQ0FBQyxhQUFhLENBQUMsV0FBVyxDQUFDO3dCQUN4RCxJQUFJLEVBQUUsT0FBTzt3QkFDYixPQUFPLEVBQUUsa0ZBQWtGO3dCQUMzRixJQUFJLEVBQUUsY0FBYzt3QkFDcEIsT0FBTyxFQUFFLEVBQUU7cUJBQ1osQ0FBQyxDQUFDO29CQUNILElBQUksQ0FBQyxXQUFXLEdBQUcsWUFBWSxDQUFDLEtBQUssQ0FBQztnQkFDeEMsQ0FBQztnQkFFRCxJQUFJLENBQUMsbUJBQW1CLEVBQUUsQ0FBQztnQkFDM0IsTUFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxjQUFjLEVBQUUsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDO1lBQ25FLENBQUM7UUFDSCxDQUFDO1FBQ0QsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFXLEVBQUUsQ0FBQztZQUN0QixJQUFJLENBQUMsV0FBVyxHQUFHLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsY0FBYyxDQUFDLENBQUM7UUFDbkUsQ0FBQztRQUVELDBDQUEwQztRQUMxQyxJQUFJLENBQUMsY0FBYyxHQUFHLElBQUksT0FBTyxDQUFDLE9BQU8sQ0FBQyxjQUFjLENBQUM7WUFDdkQsV0FBVyxFQUFFLElBQUksQ0FBQyxXQUFXO1NBQzlCLENBQUMsQ0FBQztRQUNILE1BQU0sSUFBSSxDQUFDLGNBQWMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUNwQyxDQUFDO0lBRU0sS0FBSyxDQUFDLFdBQVcsQ0FBQyxhQUFxQjtRQUM1QyxNQUFNLGNBQWMsR0FBRyxJQUFJLGFBQWEsQ0FBQyxNQUFNLENBQUMsSUFBSSxFQUFFLGFBQWEsQ0FBQyxDQUFDO1FBQ3JFLE9BQU8sTUFBTSxjQUFjLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDdEMsQ0FBQztJQUVNLEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxhQUFxQjtRQUNqRCxNQUFNLG1CQUFtQixHQUFHLElBQUksYUFBYSxDQUFDLFdBQVcsQ0FBQyxJQUFJLEVBQUUsYUFBYSxDQUFDLENBQUM7UUFDL0UsT0FBTyxNQUFNLG1CQUFtQixDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzNDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCLENBQUMsYUFBcUI7UUFDdEQsTUFBTSxjQUFjLEdBQUcsSUFBSSxhQUFhLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxhQUFhLENBQUMsQ0FBQztRQUNyRSxPQUFPLE1BQU0sY0FBYyxDQUFDLHFCQUFxQixFQUFFLENBQUM7SUFDdEQsQ0FBQztJQUVNLEtBQUssQ0FBQyxpQkFBaUIsQ0FBQyxhQUFxQjtRQUNsRCxNQUFNLHNCQUFzQixHQUFHLElBQUksYUFBYSxDQUFDLGNBQWMsQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUMvRSxPQUFPLE1BQU0sc0JBQXNCLENBQUMsV0FBVyxFQUFFLENBQUM7SUFDcEQsQ0FBQztDQUNGIn0=
|
package/package.json
CHANGED
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -3,7 +3,8 @@ import { AiDoc } from '../classes.aidoc.js';
|
|
|
3
3
|
import { ProjectContext } from './projectcontext.js';
|
|
4
4
|
|
|
5
5
|
export interface INextCommitObject {
|
|
6
|
-
recommendedNextVersionLevel: '
|
|
6
|
+
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
|
7
|
+
recommendedScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
|
7
8
|
recommendedNextVersion: string; // the recommended next version of the project
|
|
8
9
|
message: string; // the commit message. use conventional commits format
|
|
9
10
|
changelog?: string; // the changelog
|
|
@@ -45,9 +46,10 @@ Your answer should be parseable with JSON.parse() without modifying anything.
|
|
|
45
46
|
|
|
46
47
|
Here is the structure of the JSON you should return:
|
|
47
48
|
{
|
|
48
|
-
recommendedNextVersionLevel: '
|
|
49
|
+
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
|
50
|
+
recommendedScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
|
49
51
|
recommendedNextVersion: string; // the recommended next version of the project
|
|
50
|
-
message: string; // the commit message.
|
|
52
|
+
message: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
|
|
51
53
|
}
|
|
52
54
|
|
|
53
55
|
You are being given the files of the project. You should use them to create the commit message.
|
package/ts/classes.aidoc.ts
CHANGED
|
@@ -7,7 +7,7 @@ export class AiDoc {
|
|
|
7
7
|
|
|
8
8
|
public npmextraKV: plugins.npmextra.KeyValueStore;
|
|
9
9
|
public qenvInstance: plugins.qenv.Qenv;
|
|
10
|
-
public
|
|
10
|
+
public aidocInteract: plugins.smartinteract.SmartInteract;
|
|
11
11
|
public openaiInstance: plugins.smartai.OpenAiProvider;
|
|
12
12
|
|
|
13
13
|
argvArg: any;
|
|
@@ -33,7 +33,7 @@ export class AiDoc {
|
|
|
33
33
|
|
|
34
34
|
public async start() {
|
|
35
35
|
// lets care about prerequisites
|
|
36
|
-
this.
|
|
36
|
+
this.aidocInteract = new plugins.smartinteract.SmartInteract();
|
|
37
37
|
this.qenvInstance = new plugins.qenv.Qenv();
|
|
38
38
|
if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
|
|
39
39
|
this.npmextraKV = new plugins.npmextra.KeyValueStore({
|
|
@@ -51,9 +51,9 @@ export class AiDoc {
|
|
|
51
51
|
// lets try smartinteract
|
|
52
52
|
// wait for a second until OpenAI fixes punycode problem...
|
|
53
53
|
await plugins.smartdelay.delayFor(1000);
|
|
54
|
-
const answerObject = await this.
|
|
54
|
+
const answerObject = await this.aidocInteract.askQuestion({
|
|
55
55
|
type: 'input',
|
|
56
|
-
message: `Please provide your OpenAI token
|
|
56
|
+
message: `Please provide your OpenAI token. This will be persisted in your home directory.`,
|
|
57
57
|
name: 'OPENAI_TOKEN',
|
|
58
58
|
default: '',
|
|
59
59
|
});
|