@git.zone/tsdoc 1.1.29 → 1.1.33
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 +13 -0
- package/dist_ts/aidocs_classes/commit.js +84 -0
- package/dist_ts/aidocs_classes/index.d.ts +1 -0
- package/dist_ts/aidocs_classes/index.js +2 -1
- package/dist_ts/aidocs_classes/projectcontext.js +2 -2
- package/dist_ts/aidocs_classes/readme.js +2 -2
- package/dist_ts/classes.aidoc.d.ts +10 -0
- package/dist_ts/classes.aidoc.js +9 -1
- package/dist_ts/classes.typedoc.js +10 -10
- package/dist_ts/cli.js +1 -1
- package/dist_ts/paths.js +1 -1
- package/dist_ts/plugins.d.ts +2 -1
- package/dist_ts/plugins.js +3 -2
- package/package.json +20 -10
- package/readme.md +9 -8
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/aidocs_classes/commit.ts +98 -0
- package/ts/aidocs_classes/description.ts +1 -1
- package/ts/aidocs_classes/index.ts +1 -0
- package/ts/aidocs_classes/projectcontext.ts +9 -9
- package/ts/aidocs_classes/readme.ts +5 -7
- package/ts/classes.aidoc.ts +10 -0
- package/ts/classes.typedoc.ts +10 -10
- package/ts/cli.ts +1 -1
- package/ts/paths.ts +4 -1
- package/ts/plugins.ts +15 -1
|
@@ -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.33',
|
|
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=
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { AiDoc } from '../classes.aidoc.js';
|
|
2
|
+
export interface INextCommitObject {
|
|
3
|
+
recommendedNextVersionLevel: 'patch' | 'minor' | 'major';
|
|
4
|
+
recommendedNextVersion: string;
|
|
5
|
+
message: string;
|
|
6
|
+
changelog?: string;
|
|
7
|
+
}
|
|
8
|
+
export declare class Commit {
|
|
9
|
+
private aiDocsRef;
|
|
10
|
+
private projectDir;
|
|
11
|
+
constructor(aiDocsRef: AiDoc, projectDirArg: string);
|
|
12
|
+
buildNextCommitObject(): Promise<INextCommitObject>;
|
|
13
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import { AiDoc } from '../classes.aidoc.js';
|
|
3
|
+
import { ProjectContext } from './projectcontext.js';
|
|
4
|
+
export class Commit {
|
|
5
|
+
constructor(aiDocsRef, projectDirArg) {
|
|
6
|
+
this.aiDocsRef = aiDocsRef;
|
|
7
|
+
this.projectDir = projectDirArg;
|
|
8
|
+
}
|
|
9
|
+
async buildNextCommitObject() {
|
|
10
|
+
const smartgitInstance = new plugins.smartgit.Smartgit();
|
|
11
|
+
await smartgitInstance.init();
|
|
12
|
+
const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(smartgitInstance, this.projectDir);
|
|
13
|
+
const diffString = await gitRepo.getUncommittedDiff();
|
|
14
|
+
console.log(diffString);
|
|
15
|
+
const projectContext = new ProjectContext(this.projectDir);
|
|
16
|
+
let contextString = await projectContext.update();
|
|
17
|
+
contextString = `
|
|
18
|
+
${contextString}
|
|
19
|
+
|
|
20
|
+
Here is the diff:
|
|
21
|
+
${diffString}
|
|
22
|
+
`;
|
|
23
|
+
let result = await this.aiDocsRef.openaiInstance.chat({
|
|
24
|
+
systemMessage: `
|
|
25
|
+
You create a commit message for a git commit.
|
|
26
|
+
The commit message should be based on the files in the project.
|
|
27
|
+
You should not include any licensing information.
|
|
28
|
+
You should not include any personal information.
|
|
29
|
+
|
|
30
|
+
Important: Answer only in valid JSON.
|
|
31
|
+
|
|
32
|
+
Your answer should be parseable with JSON.parse() without modifying anything.
|
|
33
|
+
|
|
34
|
+
Here is the structure of the JSON you should return:
|
|
35
|
+
{
|
|
36
|
+
recommendedNextVersionLevel: 'patch' | 'minor' | 'major'; // the recommended next version level of the project
|
|
37
|
+
recommendedNextVersion: string; // the recommended next version of the project
|
|
38
|
+
message: string; // the commit message. use conventional commits format
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
You are being given the files of the project. You should use them to create the commit message.
|
|
42
|
+
Also you are given a diff
|
|
43
|
+
|
|
44
|
+
`,
|
|
45
|
+
messageHistory: [],
|
|
46
|
+
userMessage: contextString,
|
|
47
|
+
});
|
|
48
|
+
// console.log(result.message);
|
|
49
|
+
const resultObject = JSON.parse(result.message.replace('```json', '').replace('```', ''));
|
|
50
|
+
// lets build the changelog based on that
|
|
51
|
+
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
52
|
+
const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
|
|
53
|
+
let previousChangelog;
|
|
54
|
+
if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
|
|
55
|
+
previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
|
|
56
|
+
}
|
|
57
|
+
let result2 = await this.aiDocsRef.openaiInstance.chat({
|
|
58
|
+
messageHistory: [],
|
|
59
|
+
systemMessage: `
|
|
60
|
+
You are building a changelog file for the projext.
|
|
61
|
+
Omit commits and versions that lack relevant changes.
|
|
62
|
+
|
|
63
|
+
You are given
|
|
64
|
+
* the previous changelog file (if available)
|
|
65
|
+
* the commit messages of the project
|
|
66
|
+
|
|
67
|
+
Only return the changelog file, so it can be written directly to changelog.md
|
|
68
|
+
|
|
69
|
+
For the latest version, that is not yet part of the commit messages, use {{nextVersion}} and {{nextDescription}} placeholders.
|
|
70
|
+
`,
|
|
71
|
+
userMessage: `
|
|
72
|
+
The previous changelog file is:
|
|
73
|
+
${(!previousChangelog) ? 'No previous changelog file found' : previousChangelog.contents.toString()}
|
|
74
|
+
|
|
75
|
+
Here are the commit messages so far:
|
|
76
|
+
|
|
77
|
+
${commitMessages.join('\n\n')}
|
|
78
|
+
`
|
|
79
|
+
});
|
|
80
|
+
resultObject.changelog = result2.message;
|
|
81
|
+
return resultObject;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWl0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvY29tbWl0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFTckQsTUFBTSxPQUFPLE1BQU07SUFJakIsWUFBWSxTQUFnQixFQUFFLGFBQXFCO1FBQ2pELElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMscUJBQXFCO1FBQ2hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pELE1BQU0sZ0JBQWdCLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDOUIsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxnQkFBZ0IsRUFBRSxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDckcsTUFBTSxVQUFVLEdBQUcsTUFBTSxPQUFPLENBQUMsa0JBQWtCLEVBQUUsQ0FBQztRQUN0RCxPQUFPLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ3hCLE1BQU0sY0FBYyxHQUFHLElBQUksY0FBYyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUMzRCxJQUFJLGFBQWEsR0FBRyxNQUFNLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUNsRCxhQUFhLEdBQUc7RUFDbEIsYUFBYTs7O0VBR2IsVUFBVTtLQUNQLENBQUE7UUFFRCxJQUFJLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQztZQUNwRCxhQUFhLEVBQUU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0NBb0JwQjtZQUNLLGNBQWMsRUFBRSxFQUFFO1lBQ2xCLFdBQVcsRUFBRSxhQUFhO1NBQzNCLENBQUMsQ0FBQztRQUVILCtCQUErQjtRQUMvQixNQUFNLFlBQVksR0FBc0IsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBRTdHLHlDQUF5QztRQUN6QyxNQUFNLGNBQWMsR0FBRyxNQUFNLE9BQU8sQ0FBQyxvQkFBb0IsRUFBRSxDQUFDO1FBQzVELE1BQU0scUJBQXFCLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxjQUFjLENBQUMsQ0FBQztRQUNqRixJQUFJLGlCQUE4QyxDQUFDO1FBQ25ELElBQUksTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMscUJBQXFCLENBQUMsRUFBRSxDQUFDO1lBQ2pFLGlCQUFpQixHQUFHLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUFDLHFCQUFxQixDQUFDLENBQUM7UUFDNUYsQ0FBQztRQUNELElBQUksT0FBTyxHQUFHLE1BQU0sSUFBSSxDQUFDLFNBQVMsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDO1lBQ3JELGNBQWMsRUFBRSxFQUFFO1lBQ2xCLGFBQWEsRUFBRTs7Ozs7Ozs7Ozs7T0FXZDtZQUNELFdBQVcsRUFBRTs7RUFFakIsQ0FBQyxDQUFDLGlCQUFpQixDQUFDLENBQUMsQ0FBQyxDQUFDLGtDQUFrQyxDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFOzs7O0VBSWpHLGNBQWMsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDO0NBQzVCO1NBQ0ksQ0FBQyxDQUFBO1FBQ0YsWUFBWSxDQUFDLFNBQVMsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDO1FBQ3pDLE9BQU8sWUFBWSxDQUFDO0lBQ3RCLENBQUM7Q0FDRiJ9
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
+
export * from './commit.js';
|
|
1
2
|
export * from './description.js';
|
|
2
3
|
export * from './projectcontext.js';
|
|
3
4
|
export * from './readme.js';
|
|
4
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
5
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9haWRvY3NfY2xhc3Nlcy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLGFBQWEsQ0FBQztBQUM1QixjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMscUJBQXFCLENBQUM7QUFDcEMsY0FBYyxhQUFhLENBQUMifQ==
|
|
@@ -22,7 +22,7 @@ export class ProjectContext {
|
|
|
22
22
|
}
|
|
23
23
|
async convertFilesToContext(filesArg) {
|
|
24
24
|
console.log(`Using the following files for the documentation:`);
|
|
25
|
-
filesArg.map(fileArg => {
|
|
25
|
+
filesArg.map((fileArg) => {
|
|
26
26
|
console.log(` -> ${fileArg.relative}`);
|
|
27
27
|
});
|
|
28
28
|
return filesArg
|
|
@@ -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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGNvbnRleHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9haWRvY3NfY2xhc3Nlcy9wcm9qZWN0Y29udGV4dC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGVBQWUsQ0FBQztBQUV6QyxNQUFNLE9BQU8sY0FBYztJQUNsQixNQUFNLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFjLElBQUcsQ0FBQztJQUs5QyxZQUFZLGFBQXFCO1FBQy9CLElBQUksQ0FBQyxVQUFVLEdBQUcsYUFBYSxDQUFDO0lBQ2xDLENBQUM7SUFFTSxLQUFLLENBQUMsV0FBVztRQUN0QixNQUFNLG9CQUFvQixHQUFHLE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUN6RSxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLGNBQWMsQ0FBQyxFQUNsRCxJQUFJLENBQUMsVUFBVSxDQUNoQixDQUFDO1FBQ0YsTUFBTSxnQkFBZ0IsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLFlBQVksQ0FDckUsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxXQUFXLENBQUMsRUFDL0MsSUFBSSxDQUFDLFVBQVUsQ0FDaEIsQ0FBQztRQUVGLE1BQU0scUJBQXFCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQzFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsaUJBQWlCLENBQUMsRUFDckQsSUFBSSxDQUFDLFVBQVUsQ0FDaEIsQ0FBQztRQUNGLE1BQU0sc0JBQXNCLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQzNFLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsZUFBZSxDQUFDLEVBQ25ELElBQUksQ0FBQyxVQUFVLENBQ2hCLENBQUM7UUFDRixNQUFNLGFBQWEsR0FBRyxNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGdCQUFnQixDQUMvRCxJQUFJLENBQUMsVUFBVSxFQUNmLGFBQWEsQ0FDZCxDQUFDO1FBQ0YsTUFBTSxjQUFjLEdBQUcsTUFBTSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FDaEUsSUFBSSxDQUFDLFVBQVUsRUFDZixjQUFjLENBQ2YsQ0FBQztRQUNGLE9BQU87WUFDTCxvQkFBb0I7WUFDcEIsZ0JBQWdCO1lBQ2hCLHFCQUFxQjtZQUNyQixzQkFBc0I7WUFDdEIsYUFBYTtZQUNiLGNBQWM7U0FDZixDQUFDO0lBQ0osQ0FBQztJQUVNLEtBQUssQ0FBQyxxQkFBcUIsQ0FBQyxRQUF1QztRQUN4RSxPQUFPLENBQUMsR0FBRyxDQUFDLGtEQUFrRCxDQUFDLENBQUM7UUFDaEUsUUFBUSxDQUFDLEdBQUcsQ0FBQyxDQUFDLE9BQU8sRUFBRSxFQUFFO1lBQ3ZCLE9BQU8sQ0FBQyxHQUFHLENBQUMsUUFBUSxPQUFPLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztRQUMxQyxDQUFDLENBQUMsQ0FBQztRQUNILE9BQU8sUUFBUTthQUNaLEdBQUcsQ0FBQyxDQUFDLFNBQVMsRUFBRSxFQUFFO1lBQ2pCLE9BQU87dUJBQ1EsU0FBUyxDQUFDLFFBQVE7O0VBRXZDLFNBQVMsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFOztxQkFFVixTQUFTLENBQUMsUUFBUTtTQUM5QixDQUFDO1FBQ0osQ0FBQyxDQUFDO2FBQ0QsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ2hCLENBQUM7SUFFTyxLQUFLLENBQUMsWUFBWSxDQUFDLE1BQWM7UUFDdkMsTUFBTSxLQUFLLEdBQUcsTUFBTSxJQUFJLENBQUMsV0FBVyxFQUFFLENBQUM7UUFDdkMsSUFBSSxPQUFPLEdBQUcsTUFBTSxJQUFJLENBQUMscUJBQXFCLENBQUM7WUFDN0MsS0FBSyxDQUFDLG9CQUFvQjtZQUMxQixLQUFLLENBQUMsZ0JBQWdCO1lBQ3RCLEtBQUssQ0FBQyxxQkFBcUI7WUFDM0IsS0FBSyxDQUFDLHNCQUFzQjtZQUM1QixHQUFHLEtBQUssQ0FBQyxhQUFhO1lBQ3RCLEdBQUcsS0FBSyxDQUFDLGNBQWM7U0FDeEIsQ0FBQyxDQUFDO1FBQ0gsd0JBQXdCO1FBQ3hCLE9BQU8sT0FBTyxDQUFDO0lBQ2pCLENBQUM7SUFFTSxLQUFLLENBQUMsTUFBTTtRQUNqQixNQUFNLE1BQU0sR0FBRyxNQUFNLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ3hELE9BQU8sTUFBTSxDQUFDO0lBQ2hCLENBQUM7Q0FDRiJ9
|
|
@@ -11,7 +11,7 @@ export class Readme {
|
|
|
11
11
|
const projectContext = new ProjectContext(this.projectDir);
|
|
12
12
|
const contextString = await projectContext.update();
|
|
13
13
|
// lets first check legal before introducung any cost
|
|
14
|
-
const npmExtraJson = JSON.parse((
|
|
14
|
+
const npmExtraJson = JSON.parse((await projectContext.gatherFiles()).smartfilesNpmextraJSON.contents.toString());
|
|
15
15
|
const legalInfo = npmExtraJson?.tsdoc?.legal;
|
|
16
16
|
if (!legalInfo) {
|
|
17
17
|
const error = new Error(`No legal information found in npmextra.json`);
|
|
@@ -66,4 +66,4 @@ The Readme should follow the following template:
|
|
|
66
66
|
return result.message;
|
|
67
67
|
}
|
|
68
68
|
}
|
|
69
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
69
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVhZG1lLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvYWlkb2NzX2NsYXNzZXMvcmVhZG1lLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sS0FBSyxPQUFPLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sRUFBRSxjQUFjLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUVyRCxNQUFNLE9BQU8sTUFBTTtJQUtqQixZQUFZLFNBQWdCLEVBQUUsYUFBcUI7UUFDakQsSUFBSSxDQUFDLFNBQVMsR0FBRyxTQUFTLENBQUM7UUFDM0IsSUFBSSxDQUFDLFVBQVUsR0FBRyxhQUFhLENBQUM7SUFDbEMsQ0FBQztJQUVNLEtBQUssQ0FBQyxLQUFLO1FBQ2hCLElBQUksaUJBQWlCLEdBQUcsRUFBRSxDQUFDO1FBRTNCLCtDQUErQztRQUMvQyxNQUFNLGNBQWMsR0FBRyxJQUFJLGNBQWMsQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDM0QsTUFBTSxhQUFhLEdBQUcsTUFBTSxjQUFjLENBQUMsTUFBTSxFQUFFLENBQUM7UUFFcEQscURBQXFEO1FBQ3JELE1BQU0sWUFBWSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQzdCLENBQUMsTUFBTSxjQUFjLENBQUMsV0FBVyxFQUFFLENBQUMsQ0FBQyxzQkFBc0IsQ0FBQyxRQUFRLENBQUMsUUFBUSxFQUFFLENBQ2hGLENBQUM7UUFDRixNQUFNLFNBQVMsR0FBRyxZQUFZLEVBQUUsS0FBSyxFQUFFLEtBQUssQ0FBQztRQUM3QyxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUM7WUFDZixNQUFNLEtBQUssR0FBRyxJQUFJLEtBQUssQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFDO1lBQ3ZFLE9BQU8sQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDckIsQ0FBQztRQUVELElBQUksTUFBTSxHQUFHLE1BQU0sSUFBSSxDQUFDLFNBQVMsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDO1lBQ3BELGFBQWEsRUFBRTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OzthQWtDUjtZQUNQLGNBQWMsRUFBRSxFQUFFO1lBQ2xCLFdBQVcsRUFBRSxhQUFhO1NBQzNCLENBQUMsQ0FBQztRQUVILGlCQUFpQixJQUFJLE1BQU0sQ0FBQyxPQUFPLEdBQUcsSUFBSSxHQUFHLFNBQVMsQ0FBQztRQUV2RCxPQUFPLENBQUMsR0FBRyxDQUFDLDRCQUE0QixDQUFDLENBQUM7UUFDMUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDNUIsT0FBTyxDQUFDLEdBQUcsQ0FBQyw0QkFBNEIsQ0FBQyxDQUFDO1FBRTFDLE1BQU0sTUFBTSxHQUFHLENBQUMsTUFBTSxjQUFjLENBQUMsV0FBVyxFQUFFLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQztRQUNyRSxNQUFNLENBQUMsUUFBUSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQztRQUNqRCxNQUFNLE1BQU0sQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUVyQixPQUFPLE1BQU0sQ0FBQyxPQUFPLENBQUM7SUFDeEIsQ0FBQztDQUNGIn0=
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import * as plugins from './plugins.js';
|
|
2
|
+
import * as aiDocsClasses from './aidocs_classes/index.js';
|
|
2
3
|
export declare class AiDoc {
|
|
3
4
|
private openaiToken;
|
|
4
5
|
npmextraKV: plugins.npmextra.KeyValueStore;
|
|
@@ -11,4 +12,13 @@ export declare class AiDoc {
|
|
|
11
12
|
start(): Promise<void>;
|
|
12
13
|
buildReadme(projectDirArg: string): Promise<string>;
|
|
13
14
|
buildDescription(projectDirArg: string): Promise<string>;
|
|
15
|
+
buildNextCommitObject(projectDirArg: string): Promise<aiDocsClasses.INextCommitObject>;
|
|
16
|
+
getProjectContext(projectDirArg: string): Promise<{
|
|
17
|
+
smartfilePackageJSON: plugins.smartfile.SmartFile;
|
|
18
|
+
smartfilesReadme: plugins.smartfile.SmartFile;
|
|
19
|
+
smartfilesReadmeHints: plugins.smartfile.SmartFile;
|
|
20
|
+
smartfilesNpmextraJSON: plugins.smartfile.SmartFile;
|
|
21
|
+
smartfilesMod: plugins.smartfile.SmartFile[];
|
|
22
|
+
smartfilesTest: plugins.smartfile.SmartFile[];
|
|
23
|
+
}>;
|
|
14
24
|
}
|
package/dist_ts/classes.aidoc.js
CHANGED
|
@@ -68,5 +68,13 @@ export class AiDoc {
|
|
|
68
68
|
const descriptionInstance = new aiDocsClasses.Description(this, projectDirArg);
|
|
69
69
|
return await descriptionInstance.build();
|
|
70
70
|
}
|
|
71
|
+
async buildNextCommitObject(projectDirArg) {
|
|
72
|
+
const commitInstance = new aiDocsClasses.Commit(this, projectDirArg);
|
|
73
|
+
return await commitInstance.buildNextCommitObject();
|
|
74
|
+
}
|
|
75
|
+
async getProjectContext(projectDirArg) {
|
|
76
|
+
const projectContextInstance = new aiDocsClasses.ProjectContext(projectDirArg);
|
|
77
|
+
return await projectContextInstance.gatherFiles();
|
|
78
|
+
}
|
|
71
79
|
}
|
|
72
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
80
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy5haWRvYy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2NsYXNzZXMuYWlkb2MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSxjQUFjLENBQUM7QUFFeEMsT0FBTyxLQUFLLGFBQWEsTUFBTSwyQkFBMkIsQ0FBQztBQUUzRCxNQUFNLE9BQU8sS0FBSztJQVVoQixZQUFZLE9BQWE7UUFDdkIsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUM7SUFDekIsQ0FBQztJQUVPLG1CQUFtQjtRQUN6QixpRkFBaUY7UUFDakYsSUFBSSxVQUFrQixDQUFDO1FBQ3ZCLElBQUksSUFBSSxDQUFDLFdBQVcsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDaEMsbURBQW1EO1lBQ25ELE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsU0FBUyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztZQUMvQyxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQztZQUNwRSxVQUFVLEdBQUcsR0FBRyxLQUFLLE1BQU0sR0FBRyxFQUFFLENBQUM7UUFDbkMsQ0FBQzthQUFNLENBQUM7WUFDTixtREFBbUQ7WUFDbkQsVUFBVSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUM7UUFDaEMsQ0FBQztRQUNELE9BQU8sQ0FBQyxHQUFHLENBQUMsMkJBQTJCLFVBQVUsRUFBRSxDQUFDLENBQUM7SUFDdkQsQ0FBQztJQUVNLEtBQUssQ0FBQyxLQUFLO1FBQ2hCLGdDQUFnQztRQUNoQyxJQUFJLENBQUMscUJBQXFCLEdBQUcsSUFBSSxPQUFPLENBQUMsYUFBYSxDQUFDLGFBQWEsRUFBRSxDQUFDO1FBQ3ZFLElBQUksQ0FBQyxZQUFZLEdBQUcsSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO1FBQzVDLElBQUksQ0FBQyxDQUFDLE1BQU0sSUFBSSxDQUFDLFlBQVksQ0FBQyxpQkFBaUIsQ0FBQyxjQUFjLENBQUMsQ0FBQyxFQUFFLENBQUM7WUFDakUsSUFBSSxDQUFDLFVBQVUsR0FBRyxJQUFJLE9BQU8sQ0FBQyxRQUFRLENBQUMsYUFBYSxDQUFDO2dCQUNuRCxPQUFPLEVBQUUsYUFBYTtnQkFDdEIsV0FBVyxFQUFFLE9BQU87Z0JBQ3BCLGFBQWEsRUFBRSxDQUFDLGNBQWMsQ0FBQzthQUNoQyxDQUFDLENBQUM7WUFFSCxNQUFNLFdBQVcsR0FBRyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsdUJBQXVCLEVBQUUsQ0FBQztZQUNwRSxJQUFJLFdBQVcsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7Z0JBQzNCLGdCQUFnQjtnQkFDaEIsSUFBSSxJQUFJLENBQUMsT0FBTyxFQUFFLFlBQVksRUFBRSxDQUFDO29CQUMvQixJQUFJLENBQUMsV0FBVyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDO2dCQUMvQyxDQUFDO3FCQUFNLENBQUM7b0JBQ04seUJBQXlCO29CQUN6QiwyREFBMkQ7b0JBQzNELE1BQU0sT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUM7b0JBQ3hDLE1BQU0sWUFBWSxHQUFHLE1BQU0sSUFBSSxDQUFDLHFCQUFxQixDQUFDLFdBQVcsQ0FBQzt3QkFDaEUsSUFBSSxFQUFFLE9BQU87d0JBQ2IsT0FBTyxFQUFFLGtDQUFrQzt3QkFDM0MsSUFBSSxFQUFFLGNBQWM7d0JBQ3BCLE9BQU8sRUFBRSxFQUFFO3FCQUNaLENBQUMsQ0FBQztvQkFDSCxJQUFJLENBQUMsV0FBVyxHQUFHLFlBQVksQ0FBQyxLQUFLLENBQUM7Z0JBQ3hDLENBQUM7Z0JBRUQsSUFBSSxDQUFDLG1CQUFtQixFQUFFLENBQUM7Z0JBQzNCLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsY0FBYyxFQUFFLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQztZQUNuRSxDQUFDO1FBQ0gsQ0FBQztRQUNELElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLENBQUM7WUFDdEIsSUFBSSxDQUFDLFdBQVcsR0FBRyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxDQUFDO1FBQ25FLENBQUM7UUFFRCwwQ0FBMEM7UUFDMUMsSUFBSSxDQUFDLGNBQWMsR0FBRyxJQUFJLE9BQU8sQ0FBQyxPQUFPLENBQUMsY0FBYyxDQUFDO1lBQ3ZELFdBQVcsRUFBRSxJQUFJLENBQUMsV0FBVztTQUM5QixDQUFDLENBQUM7UUFDSCxNQUFNLElBQUksQ0FBQyxjQUFjLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDcEMsQ0FBQztJQUVNLEtBQUssQ0FBQyxXQUFXLENBQUMsYUFBcUI7UUFDNUMsTUFBTSxjQUFjLEdBQUcsSUFBSSxhQUFhLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxhQUFhLENBQUMsQ0FBQztRQUNyRSxPQUFPLE1BQU0sY0FBYyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQ3RDLENBQUM7SUFFTSxLQUFLLENBQUMsZ0JBQWdCLENBQUMsYUFBcUI7UUFDakQsTUFBTSxtQkFBbUIsR0FBRyxJQUFJLGFBQWEsQ0FBQyxXQUFXLENBQUMsSUFBSSxFQUFFLGFBQWEsQ0FBQyxDQUFDO1FBQy9FLE9BQU8sTUFBTSxtQkFBbUIsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUMzQyxDQUFDO0lBRU0sS0FBSyxDQUFDLHFCQUFxQixDQUFDLGFBQXFCO1FBQ3RELE1BQU0sY0FBYyxHQUFHLElBQUksYUFBYSxDQUFDLE1BQU0sQ0FBQyxJQUFJLEVBQUUsYUFBYSxDQUFDLENBQUM7UUFDckUsT0FBTyxNQUFNLGNBQWMsQ0FBQyxxQkFBcUIsRUFBRSxDQUFDO0lBQ3RELENBQUM7SUFFTSxLQUFLLENBQUMsaUJBQWlCLENBQUMsYUFBcUI7UUFDbEQsTUFBTSxzQkFBc0IsR0FBRyxJQUFJLGFBQWEsQ0FBQyxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDL0UsT0FBTyxNQUFNLHNCQUFzQixDQUFDLFdBQVcsRUFBRSxDQUFDO0lBQ3BELENBQUM7Q0FDRiJ9
|
|
@@ -14,15 +14,15 @@ export class TypeDoc {
|
|
|
14
14
|
}
|
|
15
15
|
async compile(options) {
|
|
16
16
|
const data = {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
17
|
+
compilerOptions: {
|
|
18
|
+
experimentalDecorators: true,
|
|
19
|
+
useDefineForClassFields: false,
|
|
20
|
+
target: 'ES2022',
|
|
21
|
+
module: 'NodeNext',
|
|
22
|
+
moduleResolution: 'NodeNext',
|
|
23
|
+
esModuleInterop: true,
|
|
24
|
+
verbatimModuleSyntax: true,
|
|
25
|
+
skipLibCheck: true,
|
|
26
26
|
},
|
|
27
27
|
include: [],
|
|
28
28
|
};
|
|
@@ -46,4 +46,4 @@ export class TypeDoc {
|
|
|
46
46
|
plugins.smartfile.fs.remove(paths.tsconfigFile);
|
|
47
47
|
}
|
|
48
48
|
}
|
|
49
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
49
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xhc3Nlcy50eXBlZG9jLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvY2xhc3Nlcy50eXBlZG9jLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sY0FBYyxDQUFDO0FBQ3hDLE9BQU8sS0FBSyxLQUFLLE1BQU0sWUFBWSxDQUFDO0FBRXBDLE1BQU0sT0FBTyxPQUFPO0lBTWxCLFNBQVM7SUFDRixNQUFNLENBQUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxVQUFrQjtRQUNqRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFJRCxZQUFZLFVBQVU7UUFaZix1QkFBa0IsR0FBRyxJQUFJLE9BQU8sQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDO1lBQzVELFFBQVEsRUFBRSxNQUFNO1lBQ2hCLGVBQWUsRUFBRSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUM7U0FDaEMsQ0FBQyxDQUFDO1FBVUQsSUFBSSxDQUFDLGdCQUFnQixHQUFHLFVBQVUsQ0FBQztJQUNyQyxDQUFDO0lBRU0sS0FBSyxDQUFDLE9BQU8sQ0FBQyxPQUFtQztRQUN0RCxNQUFNLElBQUksR0FBRztZQUNYLGVBQWUsRUFBRTtnQkFDZixzQkFBc0IsRUFBRSxJQUFJO2dCQUM1Qix1QkFBdUIsRUFBRSxLQUFLO2dCQUM5QixNQUFNLEVBQUUsUUFBUTtnQkFDaEIsTUFBTSxFQUFFLFVBQVU7Z0JBQ2xCLGdCQUFnQixFQUFFLFVBQVU7Z0JBQzVCLGVBQWUsRUFBRSxJQUFJO2dCQUNyQixvQkFBb0IsRUFBRSxJQUFJO2dCQUMxQixZQUFZLEVBQUUsSUFBSTthQUNuQjtZQUNELE9BQU8sRUFBRSxFQUFFO1NBQ1osQ0FBQztRQUNGLElBQUksY0FBYyxHQUFHLEVBQUUsQ0FBQztRQUN4QixJQUFJLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxFQUFFLE1BQU0sQ0FBQyxDQUFDLEVBQUUsQ0FBQztZQUMzRSxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxFQUFFLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDN0QsY0FBYyxHQUFHLElBQUksQ0FBQztRQUN4QixDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQUMsQ0FBQyxFQUFFLENBQUM7WUFDL0UsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsRUFBRSxlQUFlLENBQUMsQ0FBQyxDQUFDO1lBQ2pFLElBQUksQ0FBQyxjQUFjLEVBQUUsQ0FBQztnQkFDcEIsY0FBYyxHQUFHLFFBQVEsQ0FBQztZQUM1QixDQUFDO1FBQ0gsQ0FBQztRQUVELE1BQU0sT0FBTyxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLEVBQUUsS0FBSyxDQUFDLFlBQVksQ0FBQyxDQUFDO1FBQzlFLElBQUksU0FBUyxHQUFHLEtBQUssQ0FBQyxTQUFTLENBQUM7UUFDaEMsSUFBSSxPQUFPLEVBQUUsWUFBWSxFQUFFLENBQUM7WUFDMUIsU0FBUyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDakUsQ0FBQztRQUNELE1BQU0sSUFBSSxDQUFDLGtCQUFrQixDQUFDLElBQUksQ0FDaEMsc0JBQXNCLEtBQUssQ0FBQyxZQUFZLFVBQVUsU0FBUyxJQUFJLGNBQWMsV0FBVyxDQUN6RixDQUFDO1FBQ0YsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsQ0FBQztJQUNsRCxDQUFDO0NBQ0YifQ==
|
package/dist_ts/cli.js
CHANGED
|
@@ -40,4 +40,4 @@ export const run = async () => {
|
|
|
40
40
|
});
|
|
41
41
|
tsdocCli.startParse();
|
|
42
42
|
};
|
|
43
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
43
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvY2xpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0sY0FBYyxDQUFDO0FBQ3hDLE9BQU8sS0FBSyxLQUFLLE1BQU0sWUFBWSxDQUFDO0FBQ3BDLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxjQUFjLENBQUM7QUFFdEMsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLHNCQUFzQixDQUFDO0FBQy9DLE9BQU8sRUFBRSxLQUFLLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUUzQyxNQUFNLENBQUMsTUFBTSxHQUFHLEdBQUcsS0FBSyxJQUFJLEVBQUU7SUFDNUIsTUFBTSxRQUFRLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO0lBRWpELFFBQVEsQ0FBQyxlQUFlLEVBQUUsQ0FBQyxTQUFTLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxFQUFFO1FBQ3JELE1BQU0sQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLDZCQUE2QixDQUFDLENBQUM7UUFDbEQsUUFBUSxJQUFJLEVBQUUsQ0FBQztZQUNiLEtBQUssTUFBTSxPQUFPLENBQUMsWUFBWSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUM7Z0JBQ3hDLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLDJDQUEyQyxLQUFLLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztnQkFDekUsUUFBUSxDQUFDLGNBQWMsQ0FBQyxTQUFTLEVBQUUsT0FBTyxDQUFDLENBQUM7Z0JBQzVDLE1BQU07WUFDUjtnQkFDRSxNQUFNLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxtQ0FBbUMsS0FBSyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDeEUsQ0FBQztJQUNILENBQUMsQ0FBQyxDQUFDO0lBRUgsUUFBUSxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsQ0FBQyxTQUFTLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxFQUFFO1FBQ3pELE1BQU0sZUFBZSxHQUFHLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUMvQyxNQUFNLGVBQWUsQ0FBQyxPQUFPLENBQUM7WUFDNUIsWUFBWSxFQUFFLE9BQU8sQ0FBQyxZQUFZO1NBQ25DLENBQUMsQ0FBQztJQUNMLENBQUMsQ0FBQyxDQUFDO0lBRUgsUUFBUSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsQ0FBQyxTQUFTLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxFQUFFO1FBQ3ZELE1BQU0sQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLDBCQUEwQixDQUFDLENBQUM7UUFDL0MsTUFBTSxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsNEJBQTRCLENBQUMsQ0FBQztRQUNqRCxNQUFNLGFBQWEsR0FBRyxJQUFJLEtBQUssRUFBRSxDQUFDO1FBQ2xDLE1BQU0sYUFBYSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQzVCLGFBQWEsQ0FBQyxXQUFXLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ3JDLE1BQU0sQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLDRCQUE0QixDQUFDLENBQUM7UUFDakQsTUFBTSxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsNEJBQTRCLENBQUMsQ0FBQztRQUNqRCxhQUFhLENBQUMsZ0JBQWdCLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzVDLENBQUMsQ0FBQyxDQUFDO0lBRUgsUUFBUSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxPQUFPLEVBQUUsRUFBRTtRQUNoRCxRQUFRLENBQUMsY0FBYyxDQUFDLFNBQVMsRUFBRSxPQUFPLENBQUMsQ0FBQztRQUM1QyxPQUFPLENBQUMsRUFBRSxDQUFDLE1BQU0sRUFBRSxLQUFLLElBQUksRUFBRTtZQUM1QixNQUFNLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDckQsQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDLENBQUMsQ0FBQztJQUVILFFBQVEsQ0FBQyxVQUFVLEVBQUUsQ0FBQztBQUN4QixDQUFDLENBQUMifQ==
|
package/dist_ts/paths.js
CHANGED
|
@@ -9,4 +9,4 @@ export const tsDir = plugins.path.join(cwd, './ts');
|
|
|
9
9
|
// files
|
|
10
10
|
export const tsconfigFile = plugins.path.join(assetsDir, './tsconfig.json');
|
|
11
11
|
export const typedocOptionsFile = plugins.path.join(assetsDir, './typedoc.json');
|
|
12
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
12
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGF0aHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wYXRocy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssT0FBTyxNQUFNLGNBQWMsQ0FBQztBQUV4QyxPQUFPO0FBQ1AsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUN6QyxPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyx3QkFBd0IsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUMvRCxLQUFLLENBQ04sQ0FBQztBQUNGLE1BQU0sQ0FBQyxNQUFNLEdBQUcsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUM7QUFDakMsTUFBTSxDQUFDLE1BQU0sTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRSxxQkFBcUIsQ0FBQyxDQUFDO0FBQzNFLE1BQU0sQ0FBQyxNQUFNLFNBQVMsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLEVBQUUsVUFBVSxDQUFDLENBQUM7QUFDbkUsTUFBTSxDQUFDLE1BQU0sU0FBUyxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQUMsQ0FBQztBQUM1RCxNQUFNLENBQUMsTUFBTSxLQUFLLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0FBRXBELFFBQVE7QUFDUixNQUFNLENBQUMsTUFBTSxZQUFZLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFLGlCQUFpQixDQUFDLENBQUM7QUFDNUUsTUFBTSxDQUFDLE1BQU0sa0JBQWtCLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFLGdCQUFnQixDQUFDLENBQUMifQ==
|
package/dist_ts/plugins.d.ts
CHANGED
|
@@ -7,11 +7,12 @@ import * as smartai from '@push.rocks/smartai';
|
|
|
7
7
|
import * as smartcli from '@push.rocks/smartcli';
|
|
8
8
|
import * as smartdelay from '@push.rocks/smartdelay';
|
|
9
9
|
import * as smartfile from '@push.rocks/smartfile';
|
|
10
|
+
import * as smartgit from '@push.rocks/smartgit';
|
|
10
11
|
import * as smartinteract from '@push.rocks/smartinteract';
|
|
11
12
|
import * as smartlog from '@push.rocks/smartlog';
|
|
12
13
|
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
|
|
13
14
|
import * as smartpath from '@push.rocks/smartpath';
|
|
14
15
|
import * as smartshell from '@push.rocks/smartshell';
|
|
15
|
-
export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
|
|
16
|
+
export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartgit, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell, };
|
|
16
17
|
import * as typedoc from 'typedoc';
|
|
17
18
|
export { typedoc };
|
package/dist_ts/plugins.js
CHANGED
|
@@ -8,13 +8,14 @@ import * as smartai from '@push.rocks/smartai';
|
|
|
8
8
|
import * as smartcli from '@push.rocks/smartcli';
|
|
9
9
|
import * as smartdelay from '@push.rocks/smartdelay';
|
|
10
10
|
import * as smartfile from '@push.rocks/smartfile';
|
|
11
|
+
import * as smartgit from '@push.rocks/smartgit';
|
|
11
12
|
import * as smartinteract from '@push.rocks/smartinteract';
|
|
12
13
|
import * as smartlog from '@push.rocks/smartlog';
|
|
13
14
|
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
|
|
14
15
|
import * as smartpath from '@push.rocks/smartpath';
|
|
15
16
|
import * as smartshell from '@push.rocks/smartshell';
|
|
16
|
-
export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell };
|
|
17
|
+
export { npmextra, qenv, smartai, smartcli, smartdelay, smartfile, smartgit, smartinteract, smartlog, smartlogDestinationLocal, smartpath, smartshell, };
|
|
17
18
|
// third party scope
|
|
18
19
|
import * as typedoc from 'typedoc';
|
|
19
20
|
export { typedoc };
|
|
20
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
21
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3BsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYztBQUNkLE9BQU8sS0FBSyxJQUFJLE1BQU0sTUFBTSxDQUFDO0FBRTdCLE9BQU8sRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUVoQixrQkFBa0I7QUFDbEIsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssSUFBSSxNQUFNLGtCQUFrQixDQUFDO0FBQ3pDLE9BQU8sS0FBSyxPQUFPLE1BQU0scUJBQXFCLENBQUM7QUFDL0MsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssVUFBVSxNQUFNLHdCQUF3QixDQUFDO0FBQ3JELE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUNqRCxPQUFPLEtBQUssYUFBYSxNQUFNLDJCQUEyQixDQUFDO0FBQzNELE9BQU8sS0FBSyxRQUFRLE1BQU0sc0JBQXNCLENBQUM7QUFDakQsT0FBTyxLQUFLLHdCQUF3QixNQUFNLHdDQUF3QyxDQUFDO0FBQ25GLE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFVBQVUsTUFBTSx3QkFBd0IsQ0FBQztBQUVyRCxPQUFPLEVBQ0wsUUFBUSxFQUNSLElBQUksRUFDSixPQUFPLEVBQ1AsUUFBUSxFQUNSLFVBQVUsRUFDVixTQUFTLEVBQ1QsUUFBUSxFQUNSLGFBQWEsRUFDYixRQUFRLEVBQ1Isd0JBQXdCLEVBQ3hCLFNBQVMsRUFDVCxVQUFVLEdBQ1gsQ0FBQztBQUVGLG9CQUFvQjtBQUNwQixPQUFPLEtBQUssT0FBTyxNQUFNLFNBQVMsQ0FBQztBQUVuQyxPQUFPLEVBQUUsT0FBTyxFQUFFLENBQUMifQ==
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@git.zone/tsdoc",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.33",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
|
|
6
6
|
"main": "dist_ts/index.js",
|
|
@@ -12,27 +12,28 @@
|
|
|
12
12
|
"tsdoc": "cli.js"
|
|
13
13
|
},
|
|
14
14
|
"devDependencies": {
|
|
15
|
-
"@git.zone/tsbuild": "^2.1.
|
|
15
|
+
"@git.zone/tsbuild": "^2.1.80",
|
|
16
16
|
"@git.zone/tsrun": "^1.2.46",
|
|
17
17
|
"@git.zone/tstest": "^1.0.90",
|
|
18
18
|
"@push.rocks/tapbundle": "^5.0.23",
|
|
19
|
-
"@types/node": "^20.
|
|
19
|
+
"@types/node": "^20.14.8"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@push.rocks/early": "^4.0.3",
|
|
23
|
-
"@push.rocks/npmextra": "^5.0.
|
|
23
|
+
"@push.rocks/npmextra": "^5.0.23",
|
|
24
24
|
"@push.rocks/qenv": "^6.0.5",
|
|
25
25
|
"@push.rocks/smartai": "^0.0.17",
|
|
26
|
-
"@push.rocks/smartcli": "^4.0.
|
|
26
|
+
"@push.rocks/smartcli": "^4.0.11",
|
|
27
27
|
"@push.rocks/smartdelay": "^3.0.5",
|
|
28
|
-
"@push.rocks/smartfile": "^11.0.
|
|
28
|
+
"@push.rocks/smartfile": "^11.0.20",
|
|
29
|
+
"@push.rocks/smartgit": "^3.0.4",
|
|
29
30
|
"@push.rocks/smartinteract": "^2.0.15",
|
|
30
|
-
"@push.rocks/smartlog": "^3.0.
|
|
31
|
+
"@push.rocks/smartlog": "^3.0.7",
|
|
31
32
|
"@push.rocks/smartlog-destination-local": "^9.0.2",
|
|
32
33
|
"@push.rocks/smartpath": "^5.0.18",
|
|
33
34
|
"@push.rocks/smartshell": "^3.0.5",
|
|
34
|
-
"typedoc": "^0.
|
|
35
|
-
"typescript": "^5.
|
|
35
|
+
"typedoc": "^0.26.0",
|
|
36
|
+
"typescript": "^5.5.2"
|
|
36
37
|
},
|
|
37
38
|
"files": [
|
|
38
39
|
"ts/**/*",
|
|
@@ -61,9 +62,18 @@
|
|
|
61
62
|
"technical writing",
|
|
62
63
|
"code quality improvement"
|
|
63
64
|
],
|
|
65
|
+
"repository": {
|
|
66
|
+
"type": "git",
|
|
67
|
+
"url": "git+https://gitlab.com/gitzone/tsdoc.git"
|
|
68
|
+
},
|
|
69
|
+
"bugs": {
|
|
70
|
+
"url": "https://gitlab.com/gitzone/tsdoc/issues"
|
|
71
|
+
},
|
|
72
|
+
"homepage": "https://gitlab.com/gitzone/tsdoc#readme",
|
|
64
73
|
"scripts": {
|
|
65
74
|
"test": "(tstest test/) && npm run testCli",
|
|
66
75
|
"testCli": "(node ./cli.ts.js) && (node ./cli.ts.js aidocs)",
|
|
67
|
-
"build": "(tsbuild --web --allowimplicitany)"
|
|
76
|
+
"build": "(tsbuild --web --allowimplicitany)",
|
|
77
|
+
"buildDocs": "tsdoc"
|
|
68
78
|
}
|
|
69
79
|
}
|
package/readme.md
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
# @git.zone/tsdoc
|
|
2
|
+
|
|
2
3
|
An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
|
|
3
4
|
|
|
4
5
|
## Install
|
|
@@ -50,7 +51,7 @@ tsdoc
|
|
|
50
51
|
The `typedoc` command will generate documentation compliant with the TypeDoc format.
|
|
51
52
|
|
|
52
53
|
```bash
|
|
53
|
-
tsdoc typedoc --publicSubdir docs
|
|
54
|
+
tsdoc typedoc --publicSubdir docs
|
|
54
55
|
```
|
|
55
56
|
|
|
56
57
|
### Example
|
|
@@ -62,7 +63,7 @@ const tsconfigPath = plugins.path.join(__dirname, 'tsconfig.json');
|
|
|
62
63
|
const outputPath = plugins.path.join(__dirname, 'docs');
|
|
63
64
|
|
|
64
65
|
await plugins.smartshellInstance.exec(
|
|
65
|
-
`typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts
|
|
66
|
+
`typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`,
|
|
66
67
|
);
|
|
67
68
|
```
|
|
68
69
|
|
|
@@ -243,7 +244,7 @@ import * as plugins from './plugins';
|
|
|
243
244
|
|
|
244
245
|
export const packageDir = plugins.path.join(
|
|
245
246
|
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
|
246
|
-
'../'
|
|
247
|
+
'../',
|
|
247
248
|
);
|
|
248
249
|
export const cwd = process.cwd();
|
|
249
250
|
export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
|
|
@@ -273,7 +274,7 @@ import { AiDoc } from './classes.aidoc';
|
|
|
273
274
|
export const run = async () => {
|
|
274
275
|
const tsdocCli = new plugins.smartcli.Smartcli();
|
|
275
276
|
|
|
276
|
-
tsdocCli.standardCommand().subscribe(async argvArg => {
|
|
277
|
+
tsdocCli.standardCommand().subscribe(async (argvArg) => {
|
|
277
278
|
switch (true) {
|
|
278
279
|
case await TypeDoc.isTypeDocDir(paths.cwd):
|
|
279
280
|
tsdocCli.triggerCommand('typedoc', argvArg);
|
|
@@ -283,14 +284,14 @@ export const run = async () => {
|
|
|
283
284
|
}
|
|
284
285
|
});
|
|
285
286
|
|
|
286
|
-
tsdocCli.addCommand('typedoc').subscribe(async argvArg => {
|
|
287
|
+
tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
|
|
287
288
|
const typeDocInstance = new TypeDoc(paths.cwd);
|
|
288
289
|
await typeDocInstance.compile({
|
|
289
|
-
publicSubdir: argvArg.publicSubdir
|
|
290
|
+
publicSubdir: argvArg.publicSubdir,
|
|
290
291
|
});
|
|
291
292
|
});
|
|
292
293
|
|
|
293
|
-
tsdocCli.addCommand('aidoc').subscribe(async argvArg => {
|
|
294
|
+
tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
|
|
294
295
|
const aidocInstance = new AiDoc(argvArg);
|
|
295
296
|
await aidocInstance.start();
|
|
296
297
|
await aidocInstance.buildReadme(paths.cwd);
|
|
@@ -309,7 +310,7 @@ The `@git.zone/tsdoc` tool is designed to be extensible. Explore the source file
|
|
|
309
310
|
|
|
310
311
|
## License and Legal Information
|
|
311
312
|
|
|
312
|
-
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
|
313
|
+
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
|
313
314
|
|
|
314
315
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
315
316
|
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import { AiDoc } from '../classes.aidoc.js';
|
|
3
|
+
import { ProjectContext } from './projectcontext.js';
|
|
4
|
+
|
|
5
|
+
export interface INextCommitObject {
|
|
6
|
+
recommendedNextVersionLevel: 'patch' | 'minor' | 'major'; // the recommended next version level of the project
|
|
7
|
+
recommendedNextVersion: string; // the recommended next version of the project
|
|
8
|
+
message: string; // the commit message. use conventional commits format
|
|
9
|
+
changelog?: string; // the changelog
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export class Commit {
|
|
13
|
+
private aiDocsRef: AiDoc;
|
|
14
|
+
private projectDir: string;
|
|
15
|
+
|
|
16
|
+
constructor(aiDocsRef: AiDoc, projectDirArg: string) {
|
|
17
|
+
this.aiDocsRef = aiDocsRef;
|
|
18
|
+
this.projectDir = projectDirArg;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
public async buildNextCommitObject(): Promise<INextCommitObject> {
|
|
22
|
+
const smartgitInstance = new plugins.smartgit.Smartgit();
|
|
23
|
+
await smartgitInstance.init();
|
|
24
|
+
const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(smartgitInstance, this.projectDir);
|
|
25
|
+
const diffString = await gitRepo.getUncommittedDiff();
|
|
26
|
+
console.log(diffString);
|
|
27
|
+
const projectContext = new ProjectContext(this.projectDir);
|
|
28
|
+
let contextString = await projectContext.update();
|
|
29
|
+
contextString = `
|
|
30
|
+
${contextString}
|
|
31
|
+
|
|
32
|
+
Here is the diff:
|
|
33
|
+
${diffString}
|
|
34
|
+
`
|
|
35
|
+
|
|
36
|
+
let result = await this.aiDocsRef.openaiInstance.chat({
|
|
37
|
+
systemMessage: `
|
|
38
|
+
You create a commit message for a git commit.
|
|
39
|
+
The commit message should be based on the files in the project.
|
|
40
|
+
You should not include any licensing information.
|
|
41
|
+
You should not include any personal information.
|
|
42
|
+
|
|
43
|
+
Important: Answer only in valid JSON.
|
|
44
|
+
|
|
45
|
+
Your answer should be parseable with JSON.parse() without modifying anything.
|
|
46
|
+
|
|
47
|
+
Here is the structure of the JSON you should return:
|
|
48
|
+
{
|
|
49
|
+
recommendedNextVersionLevel: 'patch' | 'minor' | 'major'; // the recommended next version level of the project
|
|
50
|
+
recommendedNextVersion: string; // the recommended next version of the project
|
|
51
|
+
message: string; // the commit message. use conventional commits format
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
You are being given the files of the project. You should use them to create the commit message.
|
|
55
|
+
Also you are given a diff
|
|
56
|
+
|
|
57
|
+
`,
|
|
58
|
+
messageHistory: [],
|
|
59
|
+
userMessage: contextString,
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
// console.log(result.message);
|
|
63
|
+
const resultObject: INextCommitObject = JSON.parse(result.message.replace('```json', '').replace('```', ''));
|
|
64
|
+
|
|
65
|
+
// lets build the changelog based on that
|
|
66
|
+
const commitMessages = await gitRepo.getAllCommitMessages();
|
|
67
|
+
const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
|
|
68
|
+
let previousChangelog: plugins.smartfile.SmartFile;
|
|
69
|
+
if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
|
|
70
|
+
previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
|
|
71
|
+
}
|
|
72
|
+
let result2 = await this.aiDocsRef.openaiInstance.chat({
|
|
73
|
+
messageHistory: [],
|
|
74
|
+
systemMessage: `
|
|
75
|
+
You are building a changelog file for the projext.
|
|
76
|
+
Omit commits and versions that lack relevant changes.
|
|
77
|
+
|
|
78
|
+
You are given
|
|
79
|
+
* the previous changelog file (if available)
|
|
80
|
+
* the commit messages of the project
|
|
81
|
+
|
|
82
|
+
Only return the changelog file, so it can be written directly to changelog.md
|
|
83
|
+
|
|
84
|
+
For the latest version, that is not yet part of the commit messages, use {{nextVersion}} and {{nextDescription}} placeholders.
|
|
85
|
+
`,
|
|
86
|
+
userMessage: `
|
|
87
|
+
The previous changelog file is:
|
|
88
|
+
${(!previousChangelog) ? 'No previous changelog file found' : previousChangelog.contents.toString()}
|
|
89
|
+
|
|
90
|
+
Here are the commit messages so far:
|
|
91
|
+
|
|
92
|
+
${commitMessages.join('\n\n')}
|
|
93
|
+
`
|
|
94
|
+
})
|
|
95
|
+
resultObject.changelog = result2.message;
|
|
96
|
+
return resultObject;
|
|
97
|
+
}
|
|
98
|
+
}
|
|
@@ -45,7 +45,7 @@ Don't wrap the JSON in three ticks json!!!
|
|
|
45
45
|
|
|
46
46
|
console.log(result.message);
|
|
47
47
|
const resultObject: IDescriptionInterface = JSON.parse(
|
|
48
|
-
result.message.replace('```json', '').replace('```', '')
|
|
48
|
+
result.message.replace('```json', '').replace('```', ''),
|
|
49
49
|
);
|
|
50
50
|
|
|
51
51
|
const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;
|
|
@@ -13,28 +13,28 @@ export class ProjectContext {
|
|
|
13
13
|
public async gatherFiles() {
|
|
14
14
|
const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath(
|
|
15
15
|
plugins.path.join(this.projectDir, 'package.json'),
|
|
16
|
-
this.projectDir
|
|
16
|
+
this.projectDir,
|
|
17
17
|
);
|
|
18
18
|
const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath(
|
|
19
19
|
plugins.path.join(this.projectDir, 'readme.md'),
|
|
20
|
-
this.projectDir
|
|
20
|
+
this.projectDir,
|
|
21
21
|
);
|
|
22
22
|
|
|
23
23
|
const smartfilesReadmeHints = await plugins.smartfile.SmartFile.fromFilePath(
|
|
24
24
|
plugins.path.join(this.projectDir, 'readme.hints.md'),
|
|
25
|
-
this.projectDir
|
|
25
|
+
this.projectDir,
|
|
26
26
|
);
|
|
27
27
|
const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath(
|
|
28
28
|
plugins.path.join(this.projectDir, 'npmextra.json'),
|
|
29
|
-
this.projectDir
|
|
29
|
+
this.projectDir,
|
|
30
30
|
);
|
|
31
31
|
const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject(
|
|
32
32
|
this.projectDir,
|
|
33
|
-
'ts*/**/*.ts'
|
|
33
|
+
'ts*/**/*.ts',
|
|
34
34
|
);
|
|
35
35
|
const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject(
|
|
36
36
|
this.projectDir,
|
|
37
|
-
'test/**/*.ts'
|
|
37
|
+
'test/**/*.ts',
|
|
38
38
|
);
|
|
39
39
|
return {
|
|
40
40
|
smartfilePackageJSON,
|
|
@@ -47,10 +47,10 @@ 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
|
-
filesArg.map(fileArg => {
|
|
50
|
+
console.log(`Using the following files for the documentation:`);
|
|
51
|
+
filesArg.map((fileArg) => {
|
|
52
52
|
console.log(` -> ${fileArg.relative}`);
|
|
53
|
-
})
|
|
53
|
+
});
|
|
54
54
|
return filesArg
|
|
55
55
|
.map((smartfile) => {
|
|
56
56
|
return `
|
|
@@ -3,7 +3,6 @@ import * as plugins from '../plugins.js';
|
|
|
3
3
|
import { ProjectContext } from './projectcontext.js';
|
|
4
4
|
|
|
5
5
|
export class Readme {
|
|
6
|
-
|
|
7
6
|
// INSTANCE
|
|
8
7
|
private aiDocsRef: AiDoc;
|
|
9
8
|
private projectDir: string;
|
|
@@ -21,8 +20,10 @@ export class Readme {
|
|
|
21
20
|
const contextString = await projectContext.update();
|
|
22
21
|
|
|
23
22
|
// lets first check legal before introducung any cost
|
|
24
|
-
const npmExtraJson = JSON.parse(
|
|
25
|
-
|
|
23
|
+
const npmExtraJson = JSON.parse(
|
|
24
|
+
(await projectContext.gatherFiles()).smartfilesNpmextraJSON.contents.toString(),
|
|
25
|
+
);
|
|
26
|
+
const legalInfo = npmExtraJson?.tsdoc?.legal;
|
|
26
27
|
if (!legalInfo) {
|
|
27
28
|
const error = new Error(`No legal information found in npmextra.json`);
|
|
28
29
|
console.log(error);
|
|
@@ -67,12 +68,9 @@ The Readme should follow the following template:
|
|
|
67
68
|
messageHistory: [],
|
|
68
69
|
userMessage: contextString,
|
|
69
70
|
});
|
|
70
|
-
|
|
71
71
|
|
|
72
72
|
finalReadmeString += result.message + '\n' + legalInfo;
|
|
73
73
|
|
|
74
|
-
|
|
75
|
-
|
|
76
74
|
console.log(`\n======================\n`);
|
|
77
75
|
console.log(result.message);
|
|
78
76
|
console.log(`\n======================\n`);
|
|
@@ -83,4 +81,4 @@ The Readme should follow the following template:
|
|
|
83
81
|
|
|
84
82
|
return result.message;
|
|
85
83
|
}
|
|
86
|
-
}
|
|
84
|
+
}
|
package/ts/classes.aidoc.ts
CHANGED
|
@@ -84,4 +84,14 @@ export class AiDoc {
|
|
|
84
84
|
const descriptionInstance = new aiDocsClasses.Description(this, projectDirArg);
|
|
85
85
|
return await descriptionInstance.build();
|
|
86
86
|
}
|
|
87
|
+
|
|
88
|
+
public async buildNextCommitObject(projectDirArg: string) {
|
|
89
|
+
const commitInstance = new aiDocsClasses.Commit(this, projectDirArg);
|
|
90
|
+
return await commitInstance.buildNextCommitObject();
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
public async getProjectContext(projectDirArg: string) {
|
|
94
|
+
const projectContextInstance = new aiDocsClasses.ProjectContext(projectDirArg);
|
|
95
|
+
return await projectContextInstance.gatherFiles();
|
|
96
|
+
}
|
|
87
97
|
}
|
package/ts/classes.typedoc.ts
CHANGED
|
@@ -20,15 +20,15 @@ export class TypeDoc {
|
|
|
20
20
|
|
|
21
21
|
public async compile(options?: { publicSubdir?: string }) {
|
|
22
22
|
const data = {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
23
|
+
compilerOptions: {
|
|
24
|
+
experimentalDecorators: true,
|
|
25
|
+
useDefineForClassFields: false,
|
|
26
|
+
target: 'ES2022',
|
|
27
|
+
module: 'NodeNext',
|
|
28
|
+
moduleResolution: 'NodeNext',
|
|
29
|
+
esModuleInterop: true,
|
|
30
|
+
verbatimModuleSyntax: true,
|
|
31
|
+
skipLibCheck: true,
|
|
32
32
|
},
|
|
33
33
|
include: [],
|
|
34
34
|
};
|
|
@@ -51,7 +51,7 @@ export class TypeDoc {
|
|
|
51
51
|
targetDir = plugins.path.join(targetDir, options.publicSubdir);
|
|
52
52
|
}
|
|
53
53
|
await this.smartshellInstance.exec(
|
|
54
|
-
`typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts
|
|
54
|
+
`typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`,
|
|
55
55
|
);
|
|
56
56
|
plugins.smartfile.fs.remove(paths.tsconfigFile);
|
|
57
57
|
}
|
package/ts/cli.ts
CHANGED
|
@@ -36,7 +36,7 @@ export const run = async () => {
|
|
|
36
36
|
logger.log('info', `Generating new keywords...`);
|
|
37
37
|
logger.log('info', `This may take some time...`);
|
|
38
38
|
aidocInstance.buildDescription(paths.cwd);
|
|
39
|
-
})
|
|
39
|
+
});
|
|
40
40
|
|
|
41
41
|
tsdocCli.addCommand('test').subscribe((argvArg) => {
|
|
42
42
|
tsdocCli.triggerCommand('typedoc', argvArg);
|
package/ts/paths.ts
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import * as plugins from './plugins.js';
|
|
2
2
|
|
|
3
3
|
// dirs
|
|
4
|
-
export const packageDir = plugins.path.join(
|
|
4
|
+
export const packageDir = plugins.path.join(
|
|
5
|
+
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
|
6
|
+
'../',
|
|
7
|
+
);
|
|
5
8
|
export const cwd = process.cwd();
|
|
6
9
|
export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
|
|
7
10
|
export const assetsDir = plugins.path.join(packageDir, './assets');
|
package/ts/plugins.ts
CHANGED
|
@@ -10,13 +10,27 @@ import * as smartai from '@push.rocks/smartai';
|
|
|
10
10
|
import * as smartcli from '@push.rocks/smartcli';
|
|
11
11
|
import * as smartdelay from '@push.rocks/smartdelay';
|
|
12
12
|
import * as smartfile from '@push.rocks/smartfile';
|
|
13
|
+
import * as smartgit from '@push.rocks/smartgit';
|
|
13
14
|
import * as smartinteract from '@push.rocks/smartinteract';
|
|
14
15
|
import * as smartlog from '@push.rocks/smartlog';
|
|
15
16
|
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
|
|
16
17
|
import * as smartpath from '@push.rocks/smartpath';
|
|
17
18
|
import * as smartshell from '@push.rocks/smartshell';
|
|
18
19
|
|
|
19
|
-
export {
|
|
20
|
+
export {
|
|
21
|
+
npmextra,
|
|
22
|
+
qenv,
|
|
23
|
+
smartai,
|
|
24
|
+
smartcli,
|
|
25
|
+
smartdelay,
|
|
26
|
+
smartfile,
|
|
27
|
+
smartgit,
|
|
28
|
+
smartinteract,
|
|
29
|
+
smartlog,
|
|
30
|
+
smartlogDestinationLocal,
|
|
31
|
+
smartpath,
|
|
32
|
+
smartshell,
|
|
33
|
+
};
|
|
20
34
|
|
|
21
35
|
// third party scope
|
|
22
36
|
import * as typedoc from 'typedoc';
|