1.4.3

changelog.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 2025-01-14 - 1.4.3 - fix(aidocs_classes)
+Improve readme generation instructions to ensure correct markdown formatting.
+
+- Added guidance to avoid using backticks at the beginning and end of readme generation to prevent markdown issues.
+- Clarified that the output is directly written to readme.md and backticks should only be used for code blocks.
+
+## 2024-10-28 - 1.4.2 - fix(cli)
+Ensure async completion for aidoc readme and description generation
+
+- Added await statements for asynchronous methods buildReadme and buildDescription in the aidoc command.
+
 ## 2024-10-28 - 1.4.1 - fix(readme)
 Correct async call to getModuleSubDirs in readme generation.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@git.zone/tsdoc",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "private": false,
   "description": "An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.",
   "type": "module",

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tsdoc',
-  version: '1.4.1',
+  version: '1.4.3',
   description: 'An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.'
 }

ts/aidocs_classes/readme.ts

@@ -127,6 +127,8 @@ The Readme should follow the following template:
     Good to know:
     * npmextra.json contains overall module information.
     * readme.hints.md provides valuable hints about module ideas.
+    * Your output lands directly in the readme.md file.
+    * Don't use \`\`\` at the beginning or the end. It'll cause problems. Only use it for codeblocks. You are directly writing markdown. No need to introduce it weirdly.
   ]
               `,
         messageHistory: [],

ts/cli.ts

@@ -28,14 +28,14 @@ export const run = async () => {
   });
 
   tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
-    logger.log('info', `Generating new readme...`);
-    logger.log('info', `This may take some time...`);
     const aidocInstance = new AiDoc();
     await aidocInstance.start();
-    aidocInstance.buildReadme(paths.cwd);
+    logger.log('info', `Generating new readme...`);
+    logger.log('info', `This may take some time...`);
+    await aidocInstance.buildReadme(paths.cwd);
     logger.log('info', `Generating new keywords...`);
     logger.log('info', `This may take some time...`);
-    aidocInstance.buildDescription(paths.cwd);
+    await aidocInstance.buildDescription(paths.cwd);
   });
 
   tsdocCli.addCommand('test').subscribe((argvArg) => {