@versatiles/release-tool 2.1.0 → 2.2.0

package/README.md

@@ -5,12 +5,12 @@
 
 Tools used for:
 
-* creating a graph of the source code as mermaid: [`vrt deps-graph`](#subcommand-vrt-deps-graph)
-* upgrading all package dependencies: [`vrt deps-upgrade`](#subcommand-vrt-deps-upgrade)
-* creating Markdown documentation of executables: [`vrt doc-command`](#subcommand-vrt-doc-command)
-* inserting Markdown into documents: [`vrt doc-insert`](#subcommand-vrt-doc-insert)
-* updating "Table of Content" in Markdown files: [`vrt doc-toc`](#subcommand-vrt-doc-toc)
-* releasing the project as npm package: [`vrt release-npm`](#subcommand-vrt-release-npm)
+- creating a graph of the source code as mermaid: [`vrt deps-graph`](#subcommand-vrt-deps-graph)
+- upgrading all package dependencies: [`vrt deps-upgrade`](#subcommand-vrt-deps-upgrade)
+- creating Markdown documentation of executables: [`vrt doc-command`](#subcommand-vrt-doc-command)
+- inserting Markdown into documents: [`vrt doc-insert`](#subcommand-vrt-doc-insert)
+- updating "Table of Content" in Markdown files: [`vrt doc-toc`](#subcommand-vrt-doc-toc)
+- releasing the project as npm package: [`vrt release-npm`](#subcommand-vrt-release-npm)
 
 # Installation
 
@@ -34,9 +34,9 @@ You need to configure the scripts in the package.json:
 }
 ```
 
-* `scripts.check` is **required** by the release command. Here you can lint, build and test your code.
-* `scripts.prepack` is **recommended** to ensure that all files are up-to-date before releasing. Here you can build code and documentation.
-* `scripts.release` is **recommended** to make it easy to release a new version.
+- `scripts.check` is **required** by the release command. Here you can lint, build and test your code.
+- `scripts.prepack` is **recommended** to ensure that all files are up-to-date before releasing. Here you can build code and documentation.
+- `scripts.release` is **recommended** to make it easy to release a new version.
 
 # Command `vrt`
 
@@ -160,11 +160,13 @@ Usage: vrt doc-typescript [options]
 Generate documentation for a TypeScript project.
 
 Options:
-  -h, --help       display help for command
-  -i <entryPoint>  Entry point of the TypeScript project. Default is
-                   "./src/index.ts".
-  -o <outputPath>  Output path for the generated documentation. Default is
-                   "./docs".
+  -f, --format <format>      Allowed are "markdown", "wiki" and "html". Default
+                             is "markdown".
+  -h, --help                 display help for command
+  -i, --input <entryPoint>   Entry point of the TypeScript project. Default is
+                             "./src/index.ts".
+  -o, --output <outputPath>  Output path for the generated documentation.
+                             Default is "./docs".
 ```
 
 ## Subcommand: `vrt release-npm`

package/dist/commands/deps-upgrade.js

@@ -21,7 +21,7 @@ export async function upgradeDependencies(directory) {
     await check('Upgrade all versions', async () => {
         const { stdout } = await shell.run('npm outdated --all --json', false);
         const outdated = JSON.parse(stdout);
-        const latestVersion = new Map();
+        const latestVersions = new Map();
         // Collect the latest version for each dependency
         for (const [name, entry] of Object.entries(outdated)) {
             let version = '0.0.0';
@@ -34,7 +34,7 @@ export async function upgradeDependencies(directory) {
             else {
                 version = entry.latest;
             }
-            latestVersion.set(name, version);
+            latestVersions.set(name, version);
         }
         // Load package.json
         const pack = JSON.parse(readFileSync('package.json', 'utf8'));
@@ -55,7 +55,9 @@ export async function upgradeDependencies(directory) {
             if (!dependencies)
                 return;
             for (const name of Object.keys(dependencies)) {
-                dependencies[name] = latestVersion.get(name) ?? dependencies[name];
+                const version = latestVersions.get(name);
+                if (version)
+                    dependencies[name] = '^' + version;
             }
         }
     });

package/dist/commands/doc-typescript.d.ts

@@ -1,4 +1,6 @@
 export declare function generateTypescriptDocs(options: {
     entryPoint?: string;
     outputPath?: string;
+    format?: 'markdown' | 'wiki' | 'html';
+    quiet?: boolean;
 }): Promise<void>;

package/dist/commands/doc-typescript.js

@@ -1,31 +1,37 @@
 import * as td from 'typedoc';
-import * as tdMarkdown from 'typedoc-plugin-markdown';
-import * as tdTheme from 'typedoc-github-wiki-theme';
 import { panic, warn } from '../lib/log.js';
 export async function generateTypescriptDocs(options) {
+    const { entryPoint, outputPath, quiet } = options;
+    const format = options.format ?? 'markdown';
+    const isMarkdown = format !== 'html';
+    const plugin = [
+        isMarkdown && 'typedoc-plugin-markdown',
+        format === 'wiki' && 'typedoc-github-wiki-theme',
+        format === 'html' && 'typedoc-unhoax-theme',
+    ].filter(Boolean);
     const app = await td.Application.bootstrapWithPlugins({
-        entryPoints: [options.entryPoint ?? './src/index.ts'],
+        entryPoints: [entryPoint ?? './src/index.ts'],
         gitRevision: 'main',
-        outputs: [{ name: 'markdown', path: options.outputPath ?? './docs' }],
+        out: outputPath ?? './docs',
+        plugin,
+        logLevel: quiet ? 'Warn' : 'Info',
     }, [
-        new td.ArgumentsReader(0),
         new td.TypeDocReader(),
         new td.PackageJsonReader(),
         new td.TSConfigReader(),
-        new td.ArgumentsReader(300),
     ]);
-    tdMarkdown.load(app);
-    tdTheme.load(app);
     app.options.setValue('readme', 'none');
-    app.options.setValue('hidePageHeader', true);
-    app.options.setValue('classPropertiesFormat', 'table');
-    app.options.setValue('enumMembersFormat', 'table');
-    app.options.setValue('indexFormat', 'table');
-    app.options.setValue('interfacePropertiesFormat', 'table');
-    app.options.setValue('parametersFormat', 'table');
-    app.options.setValue('propertiesFormat', 'table');
-    app.options.setValue('propertyMembersFormat', 'table');
-    app.options.setValue('typeDeclarationFormat', 'table');
+    if (isMarkdown) {
+        app.options.setValue('hidePageHeader', true);
+        app.options.setValue('classPropertiesFormat', 'table');
+        app.options.setValue('enumMembersFormat', 'table');
+        app.options.setValue('indexFormat', 'table');
+        app.options.setValue('interfacePropertiesFormat', 'table');
+        app.options.setValue('parametersFormat', 'table');
+        app.options.setValue('propertiesFormat', 'table');
+        app.options.setValue('propertyMembersFormat', 'table');
+        app.options.setValue('typeDeclarationFormat', 'table');
+    }
     const project = await app.convert();
     if (!project)
         panic('Failed to convert project');

package/dist/commands/markdown.js

@@ -1,5 +1,6 @@
 import { remark } from 'remark';
 import remarkGfm from 'remark-gfm';
+import remarkStringify from 'remark-stringify';
 import { getErrorMessage } from '../lib/utils.js';
 /**
  * Injects a Markdown segment under a specified heading in a Markdown document.
@@ -37,7 +38,16 @@ export function injectMarkdown(document, segment, heading, foldable) {
     // Merge the original document AST with the new segment AST.
     mergeSegments(documentAst, segmentAst, startIndex + 1, endIndex);
     // Convert the modified AST back to a Markdown string and return.
-    return remark().stringify(documentAst);
+    const result = remark()
+        .use(remarkGfm, {
+        tableCellPadding: true,
+    })
+        .use(remarkStringify, {
+        bullet: '-',
+        rule: '-',
+    })
+        .stringify(documentAst);
+    return result;
 }
 /**
  * Updates the Table of Contents (TOC) of a Markdown document.

package/dist/index.js

@@ -106,8 +106,9 @@ program.command('doc-toc')
  */
 program.command('doc-typescript')
     .description('Generate documentation for a TypeScript project.')
-    .option('-i <entryPoint>', 'Entry point of the TypeScript project. Default is "./src/index.ts".')
-    .option('-o <outputPath>', 'Output path for the generated documentation. Default is "./docs".')
+    .option('-i, --input <entryPoint>', 'Entry point of the TypeScript project. Default is "./src/index.ts".')
+    .option('-o, --output <outputPath>', 'Output path for the generated documentation. Default is "./docs".')
+    .option('-f, --format <format>', 'Allowed are "markdown", "wiki" and "html". Default is "markdown".')
     .action(async (options) => {
     await generateTypescriptDocs(options);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/release-tool",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "VersaTiles release and documentation tools",
   "bin": {
     "vrt": "./dist/index.js"
@@ -53,6 +53,7 @@
     "remark-gfm": "^4.0.1",
     "typedoc": "^0.27.8",
     "typedoc-github-wiki-theme": "^2.1.0",
-    "typedoc-plugin-markdown": "^4.4.2"
+    "typedoc-plugin-markdown": "^4.4.2",
+    "typedoc-unhoax-theme": "^0.4.6"
   }
 }