fix(core): update

This commit is contained in:
Philipp Kunz 2024-06-23 12:27:26 +02:00
parent 9a3d8588a8
commit fba54035ea
3 changed files with 10 additions and 9 deletions

View File

@ -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');
}) })

View File

@ -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.38',
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

@ -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.