Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
8a0046818b | |||
97fa9db32f | |||
d61de9b615 | |||
fba54035ea |
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@git.zone/tsdoc",
|
"name": "@git.zone/tsdoc",
|
||||||
"version": "1.1.37",
|
"version": "1.1.39",
|
||||||
"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');
|
||||||
|
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@git.zone/tsdoc',
|
name: '@git.zone/tsdoc',
|
||||||
version: '1.1.37',
|
version: '1.1.39',
|
||||||
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.'
|
||||||
}
|
}
|
||||||
|
@ -4,10 +4,10 @@ import { ProjectContext } from './projectcontext.js';
|
|||||||
|
|
||||||
export interface INextCommitObject {
|
export interface INextCommitObject {
|
||||||
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
||||||
recommendedScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
||||||
recommendedNextVersion: string; // the recommended next version of the project
|
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
|
||||||
message: string; // the commit message. use conventional commits format
|
recommendedNextVersion: string; // the recommended next version of the project, x.x.x
|
||||||
changelog?: string; // the changelog
|
changelog?: string; // the changelog for the next version
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Commit {
|
export class Commit {
|
||||||
@ -47,9 +47,9 @@ 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: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
recommendedNextVersionLevel: 'fix' | 'feat' | 'BREAKING CHANGE'; // the recommended next version level of the project
|
||||||
recommendedScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
recommendedNextVersionScope: string; // the recommended scope name of the next version, like "core" or "cli", or specific class names.
|
||||||
recommendedNextVersion: string; // the recommended next version of the project
|
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
|
||||||
message: 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.
|
||||||
@ -82,7 +82,7 @@ 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}}, {{nextVersionScope}} and {{nextVersionMessage}} placeholders.
|
||||||
`,
|
`,
|
||||||
userMessage: `
|
userMessage: `
|
||||||
The previous changelog file is:
|
The previous changelog file is:
|
||||||
|
Reference in New Issue
Block a user