fix(core): update
This commit is contained in:
17
readme.md
17
readme.md
@@ -1,4 +1,5 @@
|
||||
# @git.zone/tsdoc
|
||||
|
||||
An advanced TypeScript documentation tool using AI to generate and enhance documentation for TypeScript projects.
|
||||
|
||||
## Install
|
||||
@@ -50,7 +51,7 @@ tsdoc
|
||||
The `typedoc` command will generate documentation compliant with the TypeDoc format.
|
||||
|
||||
```bash
|
||||
tsdoc typedoc --publicSubdir docs
|
||||
tsdoc typedoc --publicSubdir docs
|
||||
```
|
||||
|
||||
### Example
|
||||
@@ -62,7 +63,7 @@ const tsconfigPath = plugins.path.join(__dirname, 'tsconfig.json');
|
||||
const outputPath = plugins.path.join(__dirname, 'docs');
|
||||
|
||||
await plugins.smartshellInstance.exec(
|
||||
`typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`
|
||||
`typedoc --tsconfig ${tsconfigPath} --out ${outputPath} index.ts`,
|
||||
);
|
||||
```
|
||||
|
||||
@@ -243,7 +244,7 @@ import * as plugins from './plugins';
|
||||
|
||||
export const packageDir = plugins.path.join(
|
||||
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
||||
'../'
|
||||
'../',
|
||||
);
|
||||
export const cwd = process.cwd();
|
||||
export const binDir = plugins.path.join(packageDir, './node_modules/.bin');
|
||||
@@ -273,7 +274,7 @@ import { AiDoc } from './classes.aidoc';
|
||||
export const run = async () => {
|
||||
const tsdocCli = new plugins.smartcli.Smartcli();
|
||||
|
||||
tsdocCli.standardCommand().subscribe(async argvArg => {
|
||||
tsdocCli.standardCommand().subscribe(async (argvArg) => {
|
||||
switch (true) {
|
||||
case await TypeDoc.isTypeDocDir(paths.cwd):
|
||||
tsdocCli.triggerCommand('typedoc', argvArg);
|
||||
@@ -283,14 +284,14 @@ export const run = async () => {
|
||||
}
|
||||
});
|
||||
|
||||
tsdocCli.addCommand('typedoc').subscribe(async argvArg => {
|
||||
tsdocCli.addCommand('typedoc').subscribe(async (argvArg) => {
|
||||
const typeDocInstance = new TypeDoc(paths.cwd);
|
||||
await typeDocInstance.compile({
|
||||
publicSubdir: argvArg.publicSubdir
|
||||
publicSubdir: argvArg.publicSubdir,
|
||||
});
|
||||
});
|
||||
|
||||
tsdocCli.addCommand('aidoc').subscribe(async argvArg => {
|
||||
tsdocCli.addCommand('aidoc').subscribe(async (argvArg) => {
|
||||
const aidocInstance = new AiDoc(argvArg);
|
||||
await aidocInstance.start();
|
||||
await aidocInstance.buildReadme(paths.cwd);
|
||||
@@ -309,7 +310,7 @@ The `@git.zone/tsdoc` tool is designed to be extensible. Explore the source file
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
|
Reference in New Issue
Block a user