Compare commits

...

4 Commits

4 changed files with 39 additions and 31 deletions

View File

@ -1,32 +1,40 @@
# Changelog # Changelog
## 23.06.2024 - 1.3.2 - fix(aidocs_classes)
Fix typo in INextCommitObject interface and update date format in changelog generation.
- Corrected typo in INextCommitObject interface within the aidocs_classes directory.
- Updated date format in changelog generation from European format to hyphened sortable format.
```markdown ```markdown
## [1.2.4] ## 2023-xx-xx - 1.3.1 - aidocs_classes
### Fixed Fix typo in INextCommitObject interface
- Refactor logger initialization to use commitinfo data - Corrected a minor typo in the INextCommitObject interface for consistency.
## 1.3.0 ## 2023-xx-xx - 1.3.0 - core
feat(core): Added smarttime dependency and improved changelog generation Added smarttime dependency and improved changelog generation
- Introduced smarttime dependency to the core module.
- Enhanced changelog generation to be more efficient.
## 2023-xx-xx - 1.2.4 - logging
Refactor logger initialization to use commitinfo data
- Logger initialization now utilizes commitinfo data for better context and accuracy.
## 2023-xx-xx - 1.2.3 - aidocs
Fix bug in AiDoc class causing undefined token handling
- Resolved an issue in the AiDoc class where undefined tokens were not being handled correctly.
## 2023-xx-xx - 1.2.1 - core
Fixed usage of plugins in project context and readme generation
- Improved the usage of plugins within the project context.
- Fixed issues related to README.md generation.
## 2023-xx-xx - 1.2.0 - aidocs_classes
Enhance changelog generation by supporting complete generation in the absence of previous changelog files
- Updated changelog generation to support complete generation even when previous changelog files are absent.
## 2023-xx-xx - 1.1.42 - aidoc_classes
Improve commit message generation by handling empty diffs and updating changelog instructions
- Enhanced commit message generation to handle empty diffs.
- Updated instructions for changelog generation for better clarity.
``` ```
## [1.2.4] - 1.2.4
fix(logging): Refactor logger initialization to use commitinfo data
## [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.3.0", "version": "1.3.2",
"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

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@git.zone/tsdoc', name: '@git.zone/tsdoc',
version: '1.3.0', version: '1.3.2',
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

@ -6,7 +6,7 @@ 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
recommendedNextVersionScope: 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.
recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself. recommendedNextVersionMessage: string; // the commit message. Don't put fix() feat() or BREAKING CHANGE in the message. Please just the message itself.
recommendedNextVersionDetauls: string[]; // detailed bullet points for the changelog recommendedNextVersionDetails: string[]; // detailed bullet points for the changelog
recommendedNextVersion: string; // the recommended next version of the project, x.x.x recommendedNextVersion: string; // the recommended next version of the project, x.x.x
changelog?: string; // the changelog for the next version changelog?: string; // the changelog for the next version
} }
@ -108,7 +108,7 @@ ${commitMessages.join('\n')}
} }
let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', ''); let oldChangelog = previousChangelog.contents.toString().replace('# Changelog\n\n', '');
let newDateString = new plugins.smarttime.ExtendedDate().exportToEuropeanDate(); let newDateString = new plugins.smarttime.ExtendedDate().exportToHyphedSortableDate();
let newChangelog = `# Changelog\n\n${ let newChangelog = `# Changelog\n\n${
`## ${newDateString} - {{nextVersion}} - {{nextVersionScope}} `## ${newDateString} - {{nextVersion}} - {{nextVersionScope}}
{{nextVersionMessage}} {{nextVersionMessage}}