Compare commits

...

16 Commits

4 changed files with 49 additions and 13 deletions

20
changelog.md Normal file
View File

@ -0,0 +1,20 @@
# Changelog
## [1.2.3]
fix(aidocs): Fix bug in AiDoc class causing undefined token handling
## [1.2.2] - 2023-11-20
### Fixed
- Fix bug in AiDoc class causing undefined token handling
## [1.2.1] - 2023-11-10
### Fixed
- Fixed usage of plugins in project context and readme generation
## [1.2.0] - 2023-11-01
### Added
- Enhance changelog generation by supporting complete generation in the absence of previous changelog files
## [1.1.42] - 2023-10-30
### Fixed
- Improve commit message generation by handling empty diffs and updating changelog instructions

View File

@ -1,6 +1,6 @@
{ {
"name": "@git.zone/tsdoc", "name": "@git.zone/tsdoc",
"version": "1.1.38", "version": "1.2.3",
"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.",
"type": "module", "type": "module",

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.38', version: '1.2.3',
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

@ -22,16 +22,20 @@ export class Commit {
public async buildNextCommitObject(): Promise<INextCommitObject> { public async buildNextCommitObject(): Promise<INextCommitObject> {
const smartgitInstance = new plugins.smartgit.Smartgit(); const smartgitInstance = new plugins.smartgit.Smartgit();
await smartgitInstance.init(); await smartgitInstance.init();
const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(smartgitInstance, this.projectDir); const gitRepo = await plugins.smartgit.GitRepo.fromOpeningRepoDir(
smartgitInstance,
this.projectDir
);
const diffString = await gitRepo.getUncommittedDiff(); const diffString = await gitRepo.getUncommittedDiff();
const projectContext = new ProjectContext(this.projectDir); const projectContext = new ProjectContext(this.projectDir);
let contextString = await projectContext.update(); let contextString = await projectContext.update();
contextString = ` contextString = `
${contextString} ${contextString}
Here is the diff: Below is the diff of the uncommitted changes. If nothing is changed, there are no changes:
${diffString}
` ${diffString || 'No changes.'}
`;
let result = await this.aiDocsRef.openaiInstance.chat({ let result = await this.aiDocsRef.openaiInstance.chat({
systemMessage: ` systemMessage: `
@ -61,7 +65,9 @@ Also you are given a diff
}); });
// console.log(result.message); // console.log(result.message);
const resultObject: INextCommitObject = JSON.parse(result.message.replace('```json', '').replace('```', '')); const resultObject: INextCommitObject = JSON.parse(
result.message.replace('```json', '').replace('```', '')
);
// lets build the changelog based on that // lets build the changelog based on that
const commitMessages = await gitRepo.getAllCommitMessages(); const commitMessages = await gitRepo.getAllCommitMessages();
@ -82,18 +88,28 @@ You are given
Only return the changelog file, so it can be written directly to changelog.md Only return the changelog file, so it can be written directly to changelog.md
For the latest version, that is not yet part of the commit messages, use {{nextVersion}} and {{nextDescription}} placeholders. For the latest version, that is not yet part of the commit messages, add a placeholder entry that uses {{nextVersion}} and {{nextVersionMessage}} as variables to filled later.
Only output newer versions and their changes compared to ones already mentioned. We take of appending your output later.
If there is no previous changelog file, generate a complete changelog from commit messages with heading and everything + the placeholder section mentioned above.
`, `,
userMessage: ` userMessage: `
The previous changelog file is: The previous changelog file is:
${(!previousChangelog) ? 'No previous changelog file found' : previousChangelog.contents.toString()} ${!previousChangelog ? 'No previous changelog file found' : previousChangelog.contents.toString()}
Here are the commit messages so far: Here are the commit messages so far:
${commitMessages.join('\n\n')} ${commitMessages.join('\n\n')}
` `,
}) });
resultObject.changelog = result2.message; if (previousChangelog) {
let newChangelog = result2.message;
newChangelog = newChangelog.replace('# Changelog\n\n', '');
let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
newChangelog = `# Changelog\n\n${newChangelog}\n\n${oldChangelog}`;
resultObject.changelog = newChangelog;
} else {
resultObject.changelog = result2.message;
}
return resultObject; return resultObject;
} }
} }