Compare commits

...

54 Commits

Author SHA1 Message Date
94a066247f 1.3.9 2024-06-23 23:50:51 +02:00
7de157ccb3 fix(aidoc): Fix changelog generation by properly stripping markdown code fences 2024-06-23 23:50:51 +02:00
d783965b25 1.3.8 2024-06-23 23:29:37 +02:00
07f1413d5e fix(changelog): Fix changelog generation by properly stripping markdown code fences 2024-06-23 23:29:36 +02:00
d7bf45f6b5 1.3.7 2024-06-23 23:24:09 +02:00
3eb64bcb5d fix(aidoc): Update to include package-lock.json in uncommitted changes check 2024-06-23 23:24:09 +02:00
e24a027fdd 1.3.6 2024-06-23 23:20:02 +02:00
3f451cfcb1 fix(commit): Fixed issue with retrieving uncommitted diffs in git repository 2024-06-23 23:20:01 +02:00
e355c51c8d 1.3.5 2024-06-23 23:05:47 +02:00
b0fcaba2c3 fix(aidocs_classes): Refactor and enhance changelog formatting 2024-06-23 23:05:47 +02:00
4ea205e11b 1.3.4 2024-06-23 22:48:06 +02:00
f819e7b521 fix(aidocs_classes): Fix changelog formatting issue in commit class 2024-06-23 22:48:05 +02:00
d4903f32f0 1.3.3 2024-06-23 22:47:28 +02:00
34102a2544 fix(aidocs_classes): Fix minor bugs and update dependencies in aidocs_classes 2024-06-23 22:47:27 +02:00
5e2171dbfd 1.3.2 2024-06-23 19:55:40 +02:00
70d4af653a fix(aidocs_classes): Fix typo in INextCommitObject interface and update date format in changelog generation. 2024-06-23 19:55:39 +02:00
06f6fdef98 1.3.1 2024-06-23 19:47:44 +02:00
b6fb7bf029 fix(aidocs_classes): Fix typo in INextCommitObject interface 2024-06-23 19:47:43 +02:00
4c83725120 1.3.0 2024-06-23 18:38:35 +02:00
a060cd1a03 feat(core): Added smarttime dependency and improved changelog generation 2024-06-23 18:38:34 +02:00
e8372effc7 1.2.4 2024-06-23 17:37:20 +02:00
571249705e fix(logging): Refactor logger initialization to use commitinfo data 2024-06-23 17:37:19 +02:00
927cd961fd 1.2.3 2024-06-23 17:36:03 +02:00
63b4fcc232 fix(aidocs): Fix bug in AiDoc class causing undefined token handling 2024-06-23 17:36:02 +02:00
4188ed7f24 1.2.2 2024-06-23 16:46:59 +02:00
1feddc6e85 fix(aidocs): Fix bug in AiDoc class causing undefined token handling 2024-06-23 16:46:58 +02:00
499baebc18 1.2.1 2024-06-23 16:46:11 +02:00
01fc0d0c6e fix(core): Fixed usage of plugins in project context and readme generation 2024-06-23 16:46:10 +02:00
b6c9cea5d1 1.2.0 2024-06-23 16:45:21 +02:00
a949039192 feat(aidocs_classes): Enhance changelog generation by supporting complete generation in the absence of previous changelog files 2024-06-23 16:45:20 +02:00
11bde9d756 1.1.42 2024-06-23 16:43:24 +02:00
eac26521c6 fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions 2024-06-23 16:43:23 +02:00
e1323569f5 1.1.41 2024-06-23 13:49:15 +02:00
41e4bd6689 fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions 2024-06-23 13:49:14 +02:00
164a58ec59 1.1.40 2024-06-23 13:04:48 +02:00
e1c0f82fe8 fix(core): update 2024-06-23 13:04:47 +02:00
8a0046818b 1.1.39 2024-06-23 12:38:58 +02:00
97fa9db32f fix(core): update 2024-06-23 12:38:58 +02:00
d61de9b615 1.1.38 2024-06-23 12:27:27 +02:00
fba54035ea fix(core): update 2024-06-23 12:27:26 +02:00
9a3d8588a8 1.1.37 2024-06-23 12:20:07 +02:00
eb8f8fa70a fix(core): update 2024-06-23 12:20:06 +02:00
afe7b5e99e 1.1.36 2024-06-23 12:11:07 +02:00
e074562362 fix(core): update 2024-06-23 12:11:06 +02:00
240d6bb314 1.1.35 2024-06-23 12:03:26 +02:00
2d0839a1da fix(core): update 2024-06-23 12:03:25 +02:00
9f250ae2b3 1.1.34 2024-06-23 11:59:39 +02:00
1223bb8567 fix(core): update 2024-06-23 11:59:38 +02:00
9395cfc166 1.1.33 2024-06-22 21:21:53 +02:00
3b4c6bd97f fix(core): update 2024-06-22 21:21:52 +02:00
5d2c9e6158 1.1.32 2024-06-22 19:13:58 +02:00
89977038ec fix(core): update 2024-06-22 19:13:57 +02:00
b753c206b0 1.1.31 2024-06-22 13:20:56 +02:00
1965bd9b47 fix(core): update 2024-06-22 13:20:55 +02:00
17 changed files with 248 additions and 96 deletions

65
changelog.md Normal file
View File

@ -0,0 +1,65 @@
# Changelog
## 2024-06-23 - 1.3.9 - fix(aidoc)
Fix changelog generation by properly stripping markdown code fences
- Corrected the changelog generation code to ensure markdown code fences are properly stripped.
## 2024-06-23 - 1.3.8 - fix(changelog)
Fix changelog generation by properly stripping markdown code fences
- Corrected the changelog generation code to ensure markdown code fences are properly stripped.
## 2024-06-23 - 1.3.7 - fix(aidoc)
Update to include package-lock.json in uncommitted changes check
- Modified the getUncommittedDiff method call in commit.ts to include package-lock.json along with pnpm-lock.yaml
## 2024-06-23 - 1.3.6 - fix(commit)
Fixed issue with retrieving uncommitted diffs in git repository
- Revised logic to correctly handle uncommitted changes by using an array for `getUncommittedDiff` method
- Ensured proper handling and representation of uncommitted changes in the output
## 2024-06-23 - 1.3.5 - fix(aidocs_classes)
Refactor and enhance changelog formatting
- Updated the `commit.ts` file to improve the changelog formatting and ensure consistency.
- Enhanced the changelog instructions to include summarizing messages for omitted commits.
- Removed unnecessary console logging in `projectcontext.ts`.
```markdown
## 2024-06-23 - 1.3.3 - fix(aidocs_classes)
Fix changelog formatting issue in commit class
## 2024-06-23 - 1.3.2 - fix(aidocs_classes)
Fix minor bugs and update dependencies in aidocs_classes
## 2024-06-23 - 1.3.1 - fix(aidocs_classes)
Fix typo in INextCommitObject interface and update date format in changelog generation.
## 2024-06-23 - 1.3.0 - fix(aidocs_classes)
Fix typo in INextCommitObject interface
## 2024-06-23 - 1.2.4 - feat(core)
Added smarttime dependency and improved changelog generation
## 2024-06-23 - 1.2.3 - fix(logging)
Refactor logger initialization to use commitinfo data
## 2024-06-23 - 1.2.2 - fix(aidocs)
Fix bug in AiDoc class causing undefined token handling
## 2024-06-23 - 1.2.0 - fix(core)
Fixed usage of plugins in project context and readme generation
## 2024-06-23 - 1.1.42 - feat(aidocs_classes)
Enhance changelog generation by supporting complete generation in the absence of previous changelog files
## 2024-06-23 - 1.1.41 - fix(aidocs_classes)
Improve commit message generation by handling empty diffs and updating changelog instructions
```

View File

@ -1,12 +1,13 @@
{ {
"name": "@git.zone/tsdoc", "name": "@git.zone/tsdoc",
"version": "1.1.30", "version": "1.3.9",
"private": false, "private": false,
"description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.", "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
"author": "Lossless GmbH", "exports": {
".": "./dist_ts/index.js"
},
"author": "Task Venture Capital GmbH",
"license": "MIT", "license": "MIT",
"bin": { "bin": {
"tsdoc": "cli.js" "tsdoc": "cli.js"
@ -32,13 +33,14 @@
"@push.rocks/smartcli": "^4.0.11", "@push.rocks/smartcli": "^4.0.11",
"@push.rocks/smartdelay": "^3.0.5", "@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartfile": "^11.0.20", "@push.rocks/smartfile": "^11.0.20",
"@push.rocks/smartgit": "^3.0.4", "@push.rocks/smartgit": "^3.1.0",
"@push.rocks/smartinteract": "^2.0.15", "@push.rocks/smartinteract": "^2.0.15",
"@push.rocks/smartlog": "^3.0.7", "@push.rocks/smartlog": "^3.0.7",
"@push.rocks/smartlog-destination-local": "^9.0.2", "@push.rocks/smartlog-destination-local": "^9.0.2",
"@push.rocks/smartpath": "^5.0.18", "@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartshell": "^3.0.5", "@push.rocks/smartshell": "^3.0.5",
"typedoc": "^0.26.0", "@push.rocks/smarttime": "^4.0.6",
"typedoc": "^0.26.1",
"typescript": "^5.5.2" "typescript": "^5.5.2"
}, },
"files": [ "files": [

32
pnpm-lock.yaml generated
View File

@ -30,8 +30,8 @@ importers:
specifier: ^11.0.20 specifier: ^11.0.20
version: 11.0.20 version: 11.0.20
'@push.rocks/smartgit': '@push.rocks/smartgit':
specifier: ^3.0.4 specifier: ^3.1.0
version: 3.0.4 version: 3.1.0
'@push.rocks/smartinteract': '@push.rocks/smartinteract':
specifier: ^2.0.15 specifier: ^2.0.15
version: 2.0.15 version: 2.0.15
@ -47,9 +47,12 @@ importers:
'@push.rocks/smartshell': '@push.rocks/smartshell':
specifier: ^3.0.5 specifier: ^3.0.5
version: 3.0.5 version: 3.0.5
'@push.rocks/smarttime':
specifier: ^4.0.6
version: 4.0.6
typedoc: typedoc:
specifier: ^0.26.0 specifier: ^0.26.1
version: 0.26.0(typescript@5.5.2) version: 0.26.1(typescript@5.5.2)
typescript: typescript:
specifier: ^5.5.2 specifier: ^5.5.2
version: 5.5.2 version: 5.5.2
@ -429,8 +432,8 @@ packages:
'@push.rocks/smartfile@11.0.20': '@push.rocks/smartfile@11.0.20':
resolution: {integrity: sha512-gJERlNE2fNah9HLq6W3srcl1GZwlz2vFVZRmb50TQLabmWF4qyTlaMYAwY8ffgf8np4TsHAa4s+kL5F0zUfUUg==} resolution: {integrity: sha512-gJERlNE2fNah9HLq6W3srcl1GZwlz2vFVZRmb50TQLabmWF4qyTlaMYAwY8ffgf8np4TsHAa4s+kL5F0zUfUUg==}
'@push.rocks/smartgit@3.0.4': '@push.rocks/smartgit@3.1.0':
resolution: {integrity: sha512-6uYifD4rGjTp6KO8kdaVenXeef0uZOfQSTuLuG3+ubpMXwZNSp0iQWx+XgS5pQipzG0+3p4ddnQ7/R8gm7LWOg==} resolution: {integrity: sha512-a3LbECFQSURkJc9t8CGJrzv7ZzfG1c83x424nb6jfj3jVJXCqjMvs1AkmpkUiro77J7yg4CavTu8vslAfrPIOw==}
'@push.rocks/smarthash@3.0.4': '@push.rocks/smarthash@3.0.4':
resolution: {integrity: sha512-HJ/fSx41jm0CvSaqMLa6b2nuNK5rHAqAeAq3dAB7Sq9BCPm2M0J5ZVDTzEAH8pS91XYniUiwuE0jwPERNn9hmw==} resolution: {integrity: sha512-HJ/fSx41jm0CvSaqMLa6b2nuNK5rHAqAeAq3dAB7Sq9BCPm2M0J5ZVDTzEAH8pS91XYniUiwuE0jwPERNn9hmw==}
@ -1924,8 +1927,8 @@ packages:
resolution: {integrity: sha512-LpB/54B+/2J5hqQ7imZHfdU31OlgQqx7ZicVlkm9kzg9/w8GKLEcFfJl/t7DCEDueOyBAD6zCCwTO6Fzs0NoEQ==} resolution: {integrity: sha512-LpB/54B+/2J5hqQ7imZHfdU31OlgQqx7ZicVlkm9kzg9/w8GKLEcFfJl/t7DCEDueOyBAD6zCCwTO6Fzs0NoEQ==}
engines: {node: '>=16'} engines: {node: '>=16'}
isomorphic-git@1.25.10: isomorphic-git@1.26.2:
resolution: {integrity: sha512-IxGiaKBwAdcgBXwIcxJU6rHLk+NrzYaaPKXXQffcA0GW3IUrQXdUPDXDo+hkGVcYruuz/7JlGBiuaeTCgIgivQ==} resolution: {integrity: sha512-swKxfDm/GyaU5ojGwKtfs3EiHwlUf3iP1iIHPduaJHA5y1cIzMDFo3ogwdW6i00UmAjYQNKyF2BZgj/jz58/2A==}
engines: {node: '>=12'} engines: {node: '>=12'}
hasBin: true hasBin: true
@ -3015,8 +3018,8 @@ packages:
resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==} resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==}
engines: {node: '>= 0.6'} engines: {node: '>= 0.6'}
typedoc@0.26.0: typedoc@0.26.1:
resolution: {integrity: sha512-OcYevjHsMN8DfpaL0dSBGAEBhOxuBB5Au8QVs9oz9iB0kRStPZwXLFWqh9gwbMUxNjW3yQuIM5GrVVauMJ2Akw==} resolution: {integrity: sha512-APsVXqh93jTlpkLuw6+/IORx7n5LN8hzJV8nvMIrYYaIva0VCq0CoDN7Z3hsRThEYVExI/qoFHnAAxrhG+Wd7Q==}
engines: {node: '>= 18'} engines: {node: '>= 18'}
hasBin: true hasBin: true
peerDependencies: peerDependencies:
@ -3864,7 +3867,7 @@ snapshots:
glob: 10.4.1 glob: 10.4.1
js-yaml: 4.1.0 js-yaml: 4.1.0
'@push.rocks/smartgit@3.0.4': '@push.rocks/smartgit@3.1.0':
dependencies: dependencies:
'@push.rocks/smartenv': 5.0.12 '@push.rocks/smartenv': 5.0.12
'@push.rocks/smartfile': 11.0.20 '@push.rocks/smartfile': 11.0.20
@ -3872,10 +3875,11 @@ snapshots:
'@push.rocks/smartpromise': 4.0.3 '@push.rocks/smartpromise': 4.0.3
'@push.rocks/smartshell': 3.0.5 '@push.rocks/smartshell': 3.0.5
'@push.rocks/smartstring': 4.0.15 '@push.rocks/smartstring': 4.0.15
'@push.rocks/smarttime': 4.0.6
'@types/diff': 5.2.1 '@types/diff': 5.2.1
'@types/minimatch': 5.1.2 '@types/minimatch': 5.1.2
diff: 5.2.0 diff: 5.2.0
isomorphic-git: 1.25.10 isomorphic-git: 1.26.2
'@push.rocks/smarthash@3.0.4': '@push.rocks/smarthash@3.0.4':
dependencies: dependencies:
@ -5798,7 +5802,7 @@ snapshots:
isexe@3.1.1: {} isexe@3.1.1: {}
isomorphic-git@1.25.10: isomorphic-git@1.26.2:
dependencies: dependencies:
async-lock: 1.4.1 async-lock: 1.4.1
clean-git-ref: 2.0.1 clean-git-ref: 2.0.1
@ -7155,7 +7159,7 @@ snapshots:
media-typer: 0.3.0 media-typer: 0.3.0
mime-types: 2.1.35 mime-types: 2.1.35
typedoc@0.26.0(typescript@5.5.2): typedoc@0.26.1(typescript@5.5.2):
dependencies: dependencies:
lunr: 2.3.9 lunr: 2.3.9
markdown-it: 14.1.0 markdown-it: 14.1.0

View File

@ -1,4 +1,5 @@
# @git.zone/tsdoc # @git.zone/tsdoc
An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects. An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
## Install ## Install
@ -62,7 +63,7 @@ const tsconfigPath = plugins.path.join(__dirname, 'tsconfig.json');
const outputPath = plugins.path.join(__dirname, 'docs'); const outputPath = plugins.path.join(__dirname, 'docs');
await plugins.smartshellInstance.exec( await plugins.smartshellInstance.exec(
`typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts` `typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`,
); );
``` ```
@ -243,7 +244,7 @@ import * as plugins from './plugins';
export const packageDir = plugins.path.join( export const packageDir = plugins.path.join(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'../' '../',
); );
export const cwd = process.cwd(); export const cwd = process.cwd();
export const binDir = plugins.path.join(packageDir, './node_modules/.bin'); export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
@ -273,7 +274,7 @@ import { AiDoc } from './classes.aidoc';
export const run = async () => { export const run = async () => {
const tsdocCli = new plugins.smartcli.Smartcli(); const tsdocCli = new plugins.smartcli.Smartcli();
tsdocCli.standardCommand().subscribe(async argvArg => { tsdocCli.standardCommand().subscribe(async (argvArg) => {
switch (true) { switch (true) {
case await TypeDoc.isTypeDocDir(paths.cwd): case await TypeDoc.isTypeDocDir(paths.cwd):
tsdocCli.triggerCommand('typedoc', argvArg); tsdocCli.triggerCommand('typedoc', argvArg);
@ -283,14 +284,14 @@ export const run = async () => {
} }
}); });
tsdocCli.addCommand('typedoc').subscribe(async argvArg => { tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
const typeDocInstance = new TypeDoc(paths.cwd); const typeDocInstance = new TypeDoc(paths.cwd);
await typeDocInstance.compile({ await typeDocInstance.compile({
publicSubdir: argvArg.publicSubdir publicSubdir: argvArg.publicSubdir,
}); });
}); });
tsdocCli.addCommand('aidoc').subscribe(async argvArg => { tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
const aidocInstance = new AiDoc(argvArg); const aidocInstance = new AiDoc(argvArg);
await aidocInstance.start(); await aidocInstance.start();
await aidocInstance.buildReadme(paths.cwd); await aidocInstance.buildReadme(paths.cwd);

View File

@ -8,20 +8,32 @@ let aidocs: tsdocs.AiDoc;
tap.test('should create an AIdocs class', async () => { tap.test('should create an AIdocs class', async () => {
aidocs = new tsdocs.AiDoc({ aidocs = new tsdocs.AiDoc({
'OPENAI_TOKEN': await testQenv.getEnvVarOnDemand('OPENAI_TOKEN') OPENAI_TOKEN: await testQenv.getEnvVarOnDemand('OPENAI_TOKEN'),
}); });
expect(aidocs).toBeInstanceOf(tsdocs.AiDoc); expect(aidocs).toBeInstanceOf(tsdocs.AiDoc);
}); });
tap.test('should start AIdocs', async () => { tap.test('should start AIdocs', async () => {
await aidocs.start(); await aidocs.start();
});
tap.skip.test('should start AIdocs', async () => {
await aidocs.buildReadme('./'); await aidocs.buildReadme('./');
}) });
tap.test('should start AIdocs', async () => { tap.skip.test('should start AIdocs', async () => {
await aidocs.start();
await aidocs.buildDescription('./'); await aidocs.buildDescription('./');
}) });
tap.test('should build commit object', async () => {
const commitObject = await aidocs.buildNextCommitObject('./');
console.log(commitObject);
expect(commitObject).not.toBeUndefined();
expect(commitObject).toHaveProperty('recommendedNextVersion');
expect(commitObject).toHaveProperty('recommendedNextVersionLevel');
expect(commitObject).toHaveProperty('recommendedNextVersionScope');
expect(commitObject).toHaveProperty('recommendedNextVersionMessage');
})
tap.start(); tap.start();

View File

@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @push.rocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@git.zone/tsdoc', name: '@git.zone/tsdoc',
version: '1.1.30', version: '1.3.9',
description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.' description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
} }

View File

@ -2,6 +2,15 @@ import * as plugins from '../plugins.js';
import { AiDoc } from '../classes.aidoc.js'; import { AiDoc } from '../classes.aidoc.js';
import { ProjectContext } from './projectcontext.js'; import { ProjectContext } from './projectcontext.js';
export interface INextCommitObject {
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
changelog?: string; // the changelog for the next version
}
export class Commit { export class Commit {
private aiDocsRef: AiDoc; private aiDocsRef: AiDoc;
private projectDir: string; private projectDir: string;
@ -11,9 +20,23 @@ export class Commit {
this.projectDir = projectDirArg; this.projectDir = projectDirArg;
} }
public async build() { public async buildNextCommitObject(): Promise<INextCommitObject> {
const smartgitInstance = new plugins.smartgit.Smartgit();
await smartgitInstance.init();
const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(
smartgitInstance,
this.projectDir
);
const diffStringArray = await gitRepo.getUncommittedDiff(['pnpm-lock.yaml', 'package-lock.json']);
const projectContext = new ProjectContext(this.projectDir); const projectContext = new ProjectContext(this.projectDir);
const contextString = await projectContext.update(); let contextString = await projectContext.update();
contextString = `
${contextString}
Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
${diffStringArray[0] ? diffStringArray.join('\n\n') : 'No changes.'}
`;
let result = await this.aiDocsRef.openaiInstance.chat({ let result = await this.aiDocsRef.openaiInstance.chat({
systemMessage: ` systemMessage: `
@ -27,12 +50,17 @@ Important: Answer only in valid JSON.
Your answer should be parseable with JSON.parse() without modifying anything. Your answer should be parseable with JSON.parse() without modifying anything.
Here is the structure of the JSON you should return: Here is the structure of the JSON you should return:
{
recommendedNextVersionLevel: 'patch' | 'minor' | 'major'; // the recommended next version level of the project interface {
recommendedNextVersion: string; // the recommended next version of the project recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
message: string; // the commit message. use conventional commits format recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
} }
For the recommendedNextVersionDetails, please only add a detail entries to the array if it has an obvious value to the reader.
You are being given the files of the project. You should use them to create the commit message. You are being given the files of the project. You should use them to create the commit message.
Also you are given a diff Also you are given a diff
@ -41,15 +69,60 @@ Also you are given a diff
userMessage: contextString, userMessage: contextString,
}); });
console.log(result.message); // console.log(result.message);
const resultObject = JSON.parse(result.message.replace('```json', '').replace('```', '')); const resultObject: INextCommitObject = JSON.parse(
result.message.replace('```json', '').replace('```', '')
);
const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON; const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
const npmextraJsonContent = JSON.parse(npmextraJson.contents.toString()); let previousChangelog: plugins.smartfile.SmartFile;
if (await plugins.smartfile.fs.fileExists(previousChangelogPath)) {
previousChangelog = await plugins.smartfile.SmartFile.fromFilePath(previousChangelogPath);
}
npmextraJsonContent.gitzone.module.commit = resultObject.message; if (!previousChangelog) {
// lets build the changelog based on that
const commitMessages = await gitRepo.getAllCommitMessages();
console.log(JSON.stringify(commitMessages, null, 2));
let result2 = await this.aiDocsRef.openaiInstance.chat({
messageHistory: [],
systemMessage: `
You are building a changelog.md file for the project.
Omit commits and versions that lack relevant changes, but make sure to mention them as a range with a summarizing message instead.
npmextraJson.contents = Buffer.from(JSON.stringify(npmextraJsonContent, null, 2)); A changelog entry should look like this:
await npmextraJson.write();
## yyyy-mm-dd - x.x.x - scope here
main descriptiom here
- detailed bullet points follow
You are given:
* the commit messages of the project
Only return the changelog file, so it can be written directly to changelog.md`,
userMessage: `
Here are the commit messages:
${JSON.stringify(commitMessages, null, 2)}
`,
});
previousChangelog = await plugins.smartfile.SmartFile.fromString(
previousChangelogPath,
result2.message.replaceAll('```markdown', '').replaceAll('```', ''),
'utf8'
);
}
let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
let newDateString = new plugins.smarttime.ExtendedDate().exportToHyphedSortableDate();
let newChangelog = `# Changelog\n\n${`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
{{nextVersionMessage}}
{{nextVersionDetails}}`}\n\n${oldChangelog}`;
resultObject.changelog = newChangelog;
return resultObject;
} }
} }

View File

@ -45,7 +45,7 @@ Don't wrap the JSON in three ticks json!!!
console.log(result.message); console.log(result.message);
const resultObject: IDescriptionInterface = JSON.parse( const resultObject: IDescriptionInterface = JSON.parse(
result.message.replace('```json', '').replace('```', '') result.message.replace('```json', '').replace('```', ''),
); );
const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON; const npmextraJson = (await projectContext.gatherFiles()).smartfilesNpmextraJSON;

View File

@ -1,3 +1,4 @@
export * from './commit.js';
export * from './description.js'; export * from './description.js';
export * from './projectcontext.js'; export * from './projectcontext.js';
export * from './readme.js'; export * from './readme.js';

View File

@ -13,28 +13,28 @@ export class ProjectContext {
public async gatherFiles() { public async gatherFiles() {
const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath( const smartfilePackageJSON = await plugins.smartfile.SmartFile.fromFilePath(
plugins.path.join(this.projectDir, 'package.json'), plugins.path.join(this.projectDir, 'package.json'),
this.projectDir this.projectDir,
); );
const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath( const smartfilesReadme = await plugins.smartfile.SmartFile.fromFilePath(
plugins.path.join(this.projectDir, 'readme.md'), plugins.path.join(this.projectDir, 'readme.md'),
this.projectDir this.projectDir,
); );
const smartfilesReadmeHints = await plugins.smartfile.SmartFile.fromFilePath( const smartfilesReadmeHints = await plugins.smartfile.SmartFile.fromFilePath(
plugins.path.join(this.projectDir, 'readme.hints.md'), plugins.path.join(this.projectDir, 'readme.hints.md'),
this.projectDir this.projectDir,
); );
const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath( const smartfilesNpmextraJSON = await plugins.smartfile.SmartFile.fromFilePath(
plugins.path.join(this.projectDir, 'npmextra.json'), plugins.path.join(this.projectDir, 'npmextra.json'),
this.projectDir this.projectDir,
); );
const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject( const smartfilesMod = await plugins.smartfile.fs.fileTreeToObject(
this.projectDir, this.projectDir,
'ts*/**/*.ts' 'ts*/**/*.ts',
); );
const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject( const smartfilesTest = await plugins.smartfile.fs.fileTreeToObject(
this.projectDir, this.projectDir,
'test/**/*.ts' 'test/**/*.ts',
); );
return { return {
smartfilePackageJSON, smartfilePackageJSON,
@ -47,10 +47,9 @@ export class ProjectContext {
} }
public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) { public async convertFilesToContext(filesArg: plugins.smartfile.SmartFile[]) {
console.log(`Using the following files for the documentation:`) filesArg.map((fileArg) => {
filesArg.map(fileArg => { // console.log(` -> ${fileArg.relative}`);
console.log(` -> ${fileArg.relative}`); });
})
return filesArg return filesArg
.map((smartfile) => { .map((smartfile) => {
return ` return `

View File

@ -3,7 +3,6 @@ import * as plugins from '../plugins.js';
import { ProjectContext } from './projectcontext.js'; import { ProjectContext } from './projectcontext.js';
export class Readme { export class Readme {
// INSTANCE // INSTANCE
private aiDocsRef: AiDoc; private aiDocsRef: AiDoc;
private projectDir: string; private projectDir: string;
@ -21,8 +20,10 @@ export class Readme {
const contextString = await projectContext.update(); const contextString = await projectContext.update();
// lets first check legal before introducung any cost // lets first check legal before introducung any cost
const npmExtraJson = JSON.parse(((await projectContext.gatherFiles()).smartfilesNpmextraJSON).contents.toString()); const npmExtraJson = JSON.parse(
const legalInfo = npmExtraJson?.tsdoc?.legal (await projectContext.gatherFiles()).smartfilesNpmextraJSON.contents.toString(),
);
const legalInfo = npmExtraJson?.tsdoc?.legal;
if (!legalInfo) { if (!legalInfo) {
const error = new Error(`No legal information found in npmextra.json`); const error = new Error(`No legal information found in npmextra.json`);
console.log(error); console.log(error);
@ -68,11 +69,8 @@ The Readme should follow the following template:
userMessage: contextString, userMessage: contextString,
}); });
finalReadmeString += result.message + '\n' + legalInfo; finalReadmeString += result.message + '\n' + legalInfo;
console.log(`\n======================\n`); console.log(`\n======================\n`);
console.log(result.message); console.log(result.message);
console.log(`\n======================\n`); console.log(`\n======================\n`);

View File

@ -7,7 +7,7 @@ export class AiDoc {
public npmextraKV: plugins.npmextra.KeyValueStore; public npmextraKV: plugins.npmextra.KeyValueStore;
public qenvInstance: plugins.qenv.Qenv; public qenvInstance: plugins.qenv.Qenv;
public smartinteractInstance: plugins.smartinteract.SmartInteract; public aidocInteract: plugins.smartinteract.SmartInteract;
public openaiInstance: plugins.smartai.OpenAiProvider; public openaiInstance: plugins.smartai.OpenAiProvider;
argvArg: any; argvArg: any;
@ -33,7 +33,7 @@ export class AiDoc {
public async start() { public async start() {
// lets care about prerequisites // lets care about prerequisites
this.smartinteractInstance = new plugins.smartinteract.SmartInteract(); this.aidocInteract = new plugins.smartinteract.SmartInteract();
this.qenvInstance = new plugins.qenv.Qenv(); this.qenvInstance = new plugins.qenv.Qenv();
if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) { if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
this.npmextraKV = new plugins.npmextra.KeyValueStore({ this.npmextraKV = new plugins.npmextra.KeyValueStore({
@ -51,9 +51,9 @@ export class AiDoc {
// lets try smartinteract // lets try smartinteract
// wait for a second until OpenAI fixes punycode problem... // wait for a second until OpenAI fixes punycode problem...
await plugins.smartdelay.delayFor(1000); await plugins.smartdelay.delayFor(1000);
const answerObject = await this.smartinteractInstance.askQuestion({ const answerObject = await this.aidocInteract.askQuestion({
type: 'input', type: 'input',
message: `Please provide your OpenAI token`, message: `Please provide your OpenAI token. This will be persisted in your home directory.`,
name: 'OPENAI_TOKEN', name: 'OPENAI_TOKEN',
default: '', default: '',
}); });
@ -85,8 +85,9 @@ export class AiDoc {
return await descriptionInstance.build(); return await descriptionInstance.build();
} }
public async buildNextCommit(projectDirArg: string) { public async buildNextCommitObject(projectDirArg: string) {
const commitInstance = new aiDocsClasses.Commit(this, projectDirArg);
return await commitInstance.buildNextCommitObject();
} }
public async getProjectContext(projectDirArg: string) { public async getProjectContext(projectDirArg: string) {

View File

@ -20,15 +20,15 @@ export class TypeDoc {
public async compile(options?: { publicSubdir?: string }) { public async compile(options?: { publicSubdir?: string }) {
const data = { const data = {
"compilerOptions": { compilerOptions: {
"experimentalDecorators": true, experimentalDecorators: true,
"useDefineForClassFields": false, useDefineForClassFields: false,
"target": "ES2022", target: 'ES2022',
"module": "NodeNext", module: 'NodeNext',
"moduleResolution": "NodeNext", moduleResolution: 'NodeNext',
"esModuleInterop": true, esModuleInterop: true,
"verbatimModuleSyntax": true, verbatimModuleSyntax: true,
"skipLibCheck": true, skipLibCheck: true,
}, },
include: [], include: [],
}; };
@ -51,7 +51,7 @@ export class TypeDoc {
targetDir = plugins.path.join(targetDir, options.publicSubdir); targetDir = plugins.path.join(targetDir, options.publicSubdir);
} }
await this.smartshellInstance.exec( await this.smartshellInstance.exec(
`typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts` `typedoc --tsconfig ${paths.tsconfigFile} --out ${targetDir} ${startDirectory}/index.ts`,
); );
plugins.smartfile.fs.remove(paths.tsconfigFile); plugins.smartfile.fs.remove(paths.tsconfigFile);
} }

View File

@ -36,7 +36,7 @@ export const run = async () => {
logger.log('info', `Generating new keywords...`); logger.log('info', `Generating new keywords...`);
logger.log('info', `This may take some time...`); logger.log('info', `This may take some time...`);
aidocInstance.buildDescription(paths.cwd); aidocInstance.buildDescription(paths.cwd);
}) });
tsdocCli.addCommand('test').subscribe((argvArg) => { tsdocCli.addCommand('test').subscribe((argvArg) => {
tsdocCli.triggerCommand('typedoc', argvArg); tsdocCli.triggerCommand('typedoc', argvArg);

View File

@ -1,15 +1,6 @@
import { commitinfo } from './00_commitinfo_data.js';
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
export const logger = new plugins.smartlog.Smartlog({ export const logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
logContext: {
company: 'Some Company',
companyunit: 'Some CompanyUnit',
containerName: 'Some Containername',
environment: 'local',
runtime: 'node',
zone: 'gitzone',
},
minimumLogLevel: 'silly',
});
logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal()); logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());

View File

@ -1,7 +1,10 @@
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
// dirs // dirs
export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../'); export const packageDir = plugins.path.join(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'../',
);
export const cwd = process.cwd(); export const cwd = process.cwd();
export const binDir = plugins.path.join(packageDir, './node_modules/.bin'); export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
export const assetsDir = plugins.path.join(packageDir, './assets'); export const assetsDir = plugins.path.join(packageDir, './assets');

View File

@ -16,6 +16,7 @@ import * as smartlog from '@push.rocks/smartlog';
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local'; import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
import * as smartpath from '@push.rocks/smartpath'; import * as smartpath from '@push.rocks/smartpath';
import * as smartshell from '@push.rocks/smartshell'; import * as smartshell from '@push.rocks/smartshell';
import * as smarttime from '@push.rocks/smarttime';
export { export {
npmextra, npmextra,
@ -30,6 +31,7 @@ export {
smartlogDestinationLocal, smartlogDestinationLocal,
smartpath, smartpath,
smartshell, smartshell,
smarttime,
}; };
// third party scope // third party scope