Compare commits
10 Commits
Author | SHA1 | Date | |
---|---|---|---|
e1323569f5 | |||
41e4bd6689 | |||
164a58ec59 | |||
e1c0f82fe8 | |||
8a0046818b | |||
97fa9db32f | |||
d61de9b615 | |||
fba54035ea | |||
9a3d8588a8 | |||
eb8f8fa70a |
7
changelog.md
Normal file
7
changelog.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 1.1.41
|
||||||
|
fix(aidoc_classes): Improve commit message generation by handling empty diffs and updating changelog instructions
|
||||||
|
|
||||||
|
## 1.0.2
|
||||||
|
- fix(core): update
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@git.zone/tsdoc",
|
"name": "@git.zone/tsdoc",
|
||||||
"version": "1.1.36",
|
"version": "1.1.41",
|
||||||
"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",
|
||||||
|
@ -29,9 +29,10 @@ tap.test('should build commit object', async () => {
|
|||||||
const commitObject = await aidocs.buildNextCommitObject('./');
|
const commitObject = await aidocs.buildNextCommitObject('./');
|
||||||
console.log(commitObject);
|
console.log(commitObject);
|
||||||
expect(commitObject).not.toBeUndefined();
|
expect(commitObject).not.toBeUndefined();
|
||||||
expect(commitObject).toHaveProperty('message');
|
|
||||||
expect(commitObject).toHaveProperty('recommendedNextVersion');
|
expect(commitObject).toHaveProperty('recommendedNextVersion');
|
||||||
expect(commitObject).toHaveProperty('recommendedNextVersionLevel');
|
expect(commitObject).toHaveProperty('recommendedNextVersionLevel');
|
||||||
|
expect(commitObject).toHaveProperty('recommendedNextVersionScope');
|
||||||
|
expect(commitObject).toHaveProperty('recommendedNextVersionMessage');
|
||||||
|
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -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.36',
|
version: '1.1.41',
|
||||||
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.'
|
||||||
}
|
}
|
||||||
|
@ -3,10 +3,11 @@ import { AiDoc } from '../classes.aidoc.js';
|
|||||||
import { ProjectContext } from './projectcontext.js';
|
import { ProjectContext } from './projectcontext.js';
|
||||||
|
|
||||||
export interface INextCommitObject {
|
export interface INextCommitObject {
|
||||||
recommendedNextVersionLevel: 'patch' | 'minor' | 'major'; // the recommended next version level of the project
|
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
||||||
recommendedNextVersion: string; // the recommended next version of the project
|
recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
||||||
message: string; // the commit message. use conventional commits format
|
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
|
||||||
changelog?: string; // 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 {
|
||||||
@ -28,8 +29,9 @@ export class Commit {
|
|||||||
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({
|
||||||
@ -45,9 +47,10 @@ 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
|
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
||||||
recommendedNextVersion: string; // the recommended next version of the project
|
recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
||||||
message: string; // the commit message. use conventional commits format
|
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
|
||||||
|
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
|
||||||
}
|
}
|
||||||
|
|
||||||
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.
|
||||||
@ -80,7 +83,8 @@ 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, use {{nextVersion}} and {{nextVersionMessage}} placeholders.
|
||||||
|
Only output newer versions and their changes compared to ones already mentioned. We take of appending your output later.
|
||||||
`,
|
`,
|
||||||
userMessage: `
|
userMessage: `
|
||||||
The previous changelog file is:
|
The previous changelog file is:
|
||||||
|
Reference in New Issue
Block a user