@versatiles/release-tool 2.7.0 → 2.7.2

package/README.md

@@ -1,5 +1,8 @@
-[![Code Coverage](https://codecov.io/gh/versatiles-org/node-release-tool/branch/main/graph/badge.svg?token=IDHAI13M0K)](https://codecov.io/gh/versatiles-org/node-release-tool)
-[![GitHub Workflow Status)](https://img.shields.io/github/actions/workflow/status/versatiles-org/node-release-tool/ci.yml)](https://github.com/versatiles-org/node-release-tool/actions/workflows/ci.yml)
+[![NPM version](https://img.shields.io/npm/v/%40versatiles%2Frelease-tool)](https://www.npmjs.com/package/@versatiles/release-tool)
+[![NPM downloads](https://img.shields.io/npm/dt/%40versatiles%2Frelease-tool)](https://www.npmjs.com/package/@versatiles/release-tool)
+[![Code coverage](https://codecov.io/gh/versatiles-org/node-release-tool/branch/main/graph/badge.svg?token=IDHAI13M0K)](https://codecov.io/gh/versatiles-org/node-release-tool)
+[![CI status](https://img.shields.io/github/actions/workflow/status/versatiles-org/node-release-tool/ci.yml)](https://github.com/versatiles-org/node-release-tool/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
 
 # VersaTiles Release Tools
 

package/dist/commands/deps-upgrade.js

@@ -24,7 +24,7 @@ export async function upgradeDependencies(directory) {
         });
     });
     const shell = new Shell(directory);
-    await check('Remove lock file and node_modules', shell.stdout('rm -f package-lock.json && rm -rf node_modules'));
+    await shell.run('rm -f package-lock.json && rm -rf node_modules', false);
     await check('Reinstall all dependencies', shell.stdout('npm i'));
     // Final log message
     info('All dependencies are up to date');

package/dist/commands/doc-command.js

@@ -19,7 +19,7 @@ export async function generateCommandDocumentation(command) {
         }
         catch (error) {
             // Handle errors in generating subcommand documentation.
-            throw new Error(`Error generating documentation for subcommand '${fullCommand}': ${getErrorMessage(error)}`);
+            throw new Error(`Error generating documentation for subcommand '${fullCommand}': ${getErrorMessage(error)}`, { cause: error });
         }
     }))).join('');
     return markdown;

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

@@ -7,9 +7,9 @@ export type DocFormat = 'markdown' | 'wiki' | 'html';
  */
 export interface TypescriptDocOptions {
     /** Path to the entry point file (default: './src/index.ts') */
-    entryPoint?: string;
+    input?: string;
     /** Output directory for generated docs (default: './docs') */
-    outputPath?: string;
+    output?: string;
     /** Documentation format: 'markdown', 'wiki', or 'html' (default: 'markdown') */
     format?: DocFormat;
     /** Suppress info-level logging (default: false) */
@@ -33,8 +33,8 @@ export interface TypescriptDocOptions {
  *
  * // Generate HTML docs to custom directory
  * await generateTypescriptDocs({
- *   entryPoint: './src/main.ts',
- *   outputPath: './api-docs',
+ *   input: './src/main.ts',
+ *   output: './api-docs',
  *   format: 'html'
  * });
  * ```

package/dist/commands/doc-typescript.js

@@ -18,14 +18,14 @@ import { panic, warn } from '../lib/log.js';
  *
  * // Generate HTML docs to custom directory
  * await generateTypescriptDocs({
- *   entryPoint: './src/main.ts',
- *   outputPath: './api-docs',
+ *   input: './src/main.ts',
+ *   output: './api-docs',
  *   format: 'html'
  * });
  * ```
  */
 export async function generateTypescriptDocs(options) {
-    const { entryPoint, outputPath, quiet } = options;
+    const { input, output, quiet } = options;
     const format = options.format ?? 'markdown';
     const isMarkdown = format !== 'html';
     const plugin = [
@@ -34,8 +34,8 @@ export async function generateTypescriptDocs(options) {
         format === 'html' && 'typedoc-github-theme',
     ].filter(Boolean);
     const app = await td.Application.bootstrapWithPlugins({
-        entryPoints: [entryPoint ?? './src/index.ts'],
-        out: outputPath ?? './docs',
+        entryPoints: [input ?? './src/index.ts'],
+        out: output ?? './docs',
         plugin,
         logLevel: quiet ? 'Warn' : 'Info',
         highlightLanguages: ['typescript', 'javascript', 'json', 'shell', 'bash', 'sh', 'css', 'html'],

package/dist/commands/release-npm.js

@@ -112,7 +112,7 @@ export async function release(directory, branch = 'main', dryRun = false) {
         info('    git add .');
         info(`    git commit -m "v${nextVersion}"`);
         info(`    git tag -f -a "v${nextVersion}" -m "new release: v${nextVersion}"`);
-        info('    git push --no-verify --follow-tags');
+        info('    git push --atomic --no-verify --follow-tags');
         info(`    gh release create/edit "v${nextVersion}"`);
         info('Dry-run complete - no changes were made');
         return;
@@ -137,9 +137,9 @@ export async function release(directory, branch = 'main', dryRun = false) {
     }
     // git push
     await check('git add', shell.run('git add .'));
-    await check('git commit', shell.run(`git commit -m "v${nextVersion}"`, false));
+    await check('git commit', shell.run(`git commit -m "v${nextVersion}"`));
     await check('git tag', shell.run(`git tag -f -a "v${nextVersion}" -m "new release: v${nextVersion}"`));
-    await check('git push', withRetry(() => shell.run('git push --no-verify --follow-tags'), {
+    await check('git push', withRetry(() => shell.run('git push --atomic --no-verify --follow-tags'), {
         onRetry: (attempt, error) => warn(`git push failed (attempt ${attempt}): ${error.message}, retrying...`),
     }));
     // github release (with retry for transient network failures)

package/dist/index.js

@@ -86,7 +86,7 @@ program
     .description('Insert Markdown from stdin into a specified section of a Markdown file.')
     .argument('<readme>', 'Path to the target Markdown file (e.g., README.md).', checkFilename)
     .argument('[heading]', 'Heading in the Markdown file where content should be placed. Default is "# API".', '# API')
-    .argument('[foldable]', 'Whether to wrap the inserted content in a foldable section.', false)
+    .argument('[foldable]', 'Whether to wrap the inserted content in a foldable section.', (v) => v === 'true', false)
     .action(async (mdFilename, heading, foldable) => {
     const buffers = [];
     for await (const data of process.stdin) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/release-tool",
-  "version": "2.7.0",
+  "version": "2.7.2",
   "description": "VersaTiles release and documentation tools",
   "bin": {
     "vrt": "./dist/index.js"
@@ -39,31 +39,32 @@
   },
   "homepage": "https://github.com/versatiles-org/node-release-tool",
   "devDependencies": {
+    "@eslint/js": "^10.0.1",
     "@schemastore/package": "^0.0.10",
-    "@types/node": "^25.2.0",
-    "@typescript-eslint/eslint-plugin": "^8.54.0",
-    "@typescript-eslint/parser": "^8.54.0",
+    "@types/node": "^25.2.3",
+    "@typescript-eslint/eslint-plugin": "^8.56.0",
+    "@typescript-eslint/parser": "^8.56.0",
     "@vitest/coverage-v8": "^4.0.18",
-    "eslint": "^9.39.2",
+    "eslint": "^10.0.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.2.7",
     "prettier": "^3.8.1",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.54.0",
+    "typescript-eslint": "^8.56.0",
     "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@inquirer/select": "^5.0.4",
+    "@inquirer/select": "^5.0.7",
     "commander": "^14.0.3",
-    "dependency-cruiser": "^17.3.7",
+    "dependency-cruiser": "^17.3.8",
     "npm-check-updates": "^19.3.2",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "typedoc": "^0.28.16",
-    "typedoc-github-theme": "^0.3.1",
+    "typedoc": "^0.28.17",
+    "typedoc-github-theme": "^0.4.0",
     "typedoc-github-wiki-theme": "^2.1.0",
-    "typedoc-plugin-markdown": "^4.9.0"
+    "typedoc-plugin-markdown": "^4.10.0"
   },
   "lint-staged": {
     "*.{ts,js,json,md,yml,yaml}": "prettier --write",