git.zone/tsdoc
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(readme): Correct async call to getModuleSubDirs in readme generation.

Browse Source
This commit is contained in:
Philipp Kunz 2024-10-28 21:20:50 +01:00
parent e8608b1cae
commit 2adb4e8cb0
3 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
changelog.md
View File

@ -1,5 +1,11 @@
# Changelog # Changelog
## 2024-10-28 - 1.4.1 - fix(readme)
Correct async call to getModuleSubDirs in readme generation.
- Fixed an issue with asynchronous handling in readme generation for submodules.
- Ensured that getModuleSubDirs function is called with await to handle promises properly.
## 2024-10-28 - 1.4.0 - feat(aidocs) ## 2024-10-28 - 1.4.0 - feat(aidocs)
Added support for building readmes for sub-modules in aidocs Added support for building readmes for sub-modules in aidocs

2
ts/00_commitinfo_data.ts
View File

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

2
ts/aidocs_classes/readme.ts
View File

@ -83,7 +83,7 @@ The Readme should follow the following template:
// lets care about monorepo aspects // lets care about monorepo aspects
const tsPublishInstance = new plugins.tspublish.TsPublish(); const tsPublishInstance = new plugins.tspublish.TsPublish();
const subModules = tsPublishInstance.getModuleSubDirs(paths.cwd); const subModules = await tsPublishInstance.getModuleSubDirs(paths.cwd);
logger.log('info', `Found ${Object.keys(subModules).length} sub modules`); logger.log('info', `Found ${Object.keys(subModules).length} sub modules`);
for (const subModule of Object.keys(subModules)) { for (const subModule of Object.keys(subModules)) {
logger.log('info', `Building readme for ${subModule}`); logger.log('info', `Building readme for ${subModule}`);