@versatiles/release-tool 2.5.0 → 2.6.0

package/README.md

@@ -51,6 +51,7 @@ Node.js/TypeScript projects.
 
 Options:
   -h, --help                                display help for command
+  -v, --verbose                             Enable verbose output
 
 Commands:
   check                                     Check repo for required scripts and other stuff.
@@ -61,7 +62,7 @@ Commands:
   doc-toc <readme> [heading]                Generate a Table of Contents (TOC) in a Markdown file.
   doc-typescript [options]                  Generate documentation for a TypeScript project.
   help [command]                            display help for command
-  release-npm [path]                        Publish an npm package from the specified path to the npm registry.
+  release-npm [options] [path]              Publish an npm package from the specified path to the npm registry.
 ```
 
 ## Subcommand: `vrt check`
@@ -178,11 +179,12 @@ Usage: vrt release-npm [options] [path]
 Publish an npm package from the specified path to the npm registry.
 
 Arguments:
-  path        Root path of the Node.js project. Defaults to the current
-              directory.
+  path           Root path of the Node.js project. Defaults to the current
+                 directory.
 
 Options:
-  -h, --help  display help for command
+  -h, --help     display help for command
+  -n, --dry-run  Show what would be done without making any changes
 ```
 
 # Development
@@ -220,6 +222,7 @@ end
 5-->4
 6-->4
 6-->7
+7-->4
 8-->9
 A-->4
 B-->9
@@ -234,6 +237,7 @@ E-->8
 E-->A
 E-->B
 E-->C
+E-->4
 
 class 0,1,3 subgraphs;
 classDef subgraphs fill-opacity:0.1, fill:#888, color:#888, stroke:#888;

package/dist/commands/check.js

@@ -17,8 +17,8 @@ export function checkPackage(directory) {
         info('scripts.doc is recommended');
     if (!scripts.build)
         warn('scripts.build is required');
-    else if (!scripts.build.includes("npm run doc")) {
-        warn(`scripts.build should include "npm run doc-graph", but is "${scripts.build}"`);
+    else if (!scripts.build.includes('npm run doc')) {
+        warn(`scripts.build should include "npm run doc", but is "${scripts.build}"`);
     }
     if (!scripts.check)
         warn('scripts.check is required');

package/dist/commands/deps-graph.js

@@ -6,7 +6,7 @@ export async function generateDependencyGraph(directory) {
         cruiseResult = await cruise([directory], {
             includeOnly: '^src',
             outputType: 'mermaid',
-            exclude: ["\\.(test|d)\\.ts$", "node_modules", "__mocks__/"],
+            exclude: ['\\.(test|d)\\.ts$', 'node_modules', '__mocks__/'],
         });
     }
     catch (pError) {

package/dist/commands/doc-command.js

@@ -36,18 +36,18 @@ async function getCommandResults(command) {
             NODE_ENV: undefined,
             NODE_DISABLE_COLORS: '1',
             NO_COLORS: '1',
-            FORCE_COLOR: '0'
+            FORCE_COLOR: '0',
         };
         // Spawn a child process to run the command with the '--help' flag.
         const childProcess = cp.spawn('npm', ['--offline', 'exec', '--', ...command.split(' '), '--help'], { env });
         let output = '';
         // Collect output data from the process.
-        childProcess.stdout.on('data', data => output += String(data));
-        childProcess.stderr.on('data', data => {
+        childProcess.stdout.on('data', (data) => (output += String(data)));
+        childProcess.stderr.on('data', (data) => {
             console.error(`stderr: ${data}`);
         });
         // Handle process errors.
-        childProcess.on('error', error => {
+        childProcess.on('error', (error) => {
             reject(new Error(`Failed to start subprocess: ${error.message}`));
         });
         // Handle process exit.
@@ -72,8 +72,8 @@ async function getCommandResults(command) {
  */
 function extractSubcommands(result) {
     return result
-        .replace(/.*\nCommands:/msgi, '') // Remove everything before the "Commands:" section.
-        .replace(/\n[a-z]+:.*/msi, '') // Remove everything after the subcommands list.
+        .replace(/.*\nCommands:/gims, '') // Remove everything before the "Commands:" section.
+        .replace(/\n[a-z]+:.*/ims, '') // Remove everything after the subcommands list.
         .split('\n') // Split by newline to process each line.
         .flatMap((line) => {
         // Extract subcommand names from each line.

package/dist/commands/doc-typescript.js

@@ -16,11 +16,7 @@ export async function generateTypescriptDocs(options) {
         logLevel: quiet ? 'Warn' : 'Info',
         highlightLanguages: ['typescript', 'javascript', 'json', 'shell', 'bash', 'sh', 'css', 'html'],
         groupOrder: ['Classes', 'Variables', 'Functions', '*'],
-    }, [
-        new td.TypeDocReader(),
-        new td.PackageJsonReader(),
-        new td.TSConfigReader(),
-    ]);
+    }, [new td.TypeDocReader(), new td.PackageJsonReader(), new td.TSConfigReader()]);
     app.options.setValue('readme', 'none');
     if (isMarkdown) {
         app.options.setValue('hidePageHeader', true);

package/dist/commands/markdown.js

@@ -2,6 +2,18 @@ import { remark } from 'remark';
 import remarkGfm from 'remark-gfm';
 import remarkStringify from 'remark-stringify';
 import { getErrorMessage } from '../lib/utils.js';
+// Custom blockquote handler that preserves GitHub alert syntax
+function blockquoteHandler(node, _parent, state, info) {
+    const exit = state.enter('blockquote');
+    const tracker = state.createTracker(info);
+    tracker.move('> ');
+    tracker.shift(2);
+    let value = state.indentLines(state.containerFlow(node, tracker.current()), (line, _index, blank) => '>' + (blank ? '' : ' ') + line);
+    exit();
+    // Unescape GitHub alert markers that remark-stringify escapes
+    value = value.replace(/^(>\s*)\\\[!(NOTE|WARNING|TIP|IMPORTANT|CAUTION)\]/m, '$1[!$2]');
+    return value;
+}
 /**
  * Injects a Markdown segment under a specified heading in a Markdown document.
  * Optionally, the injected segment can be made foldable for better readability.
@@ -45,6 +57,9 @@ export function injectMarkdown(document, segment, heading, foldable) {
         .use(remarkStringify, {
         bullet: '-',
         rule: '-',
+        handlers: {
+            blockquote: blockquoteHandler,
+        },
     })
         .stringify(documentAst);
     return result;
@@ -62,7 +77,7 @@ export function updateTOC(main, heading) {
     const headingText = extractTextFromMDAsHTML(parseMarkdown(heading));
     // Build the TOC by iterating over each heading in the document.
     const toc = mainAst.children
-        .flatMap(c => {
+        .flatMap((c) => {
         // Skip non-heading nodes and the specified heading.
         if (c.type !== 'heading' || extractTextFromMDAsHTML(c) === headingText)
             return [];
@@ -89,12 +104,12 @@ function findSegmentStartIndex(mainAst, headingAst) {
     if (headingAst.children.length !== 1)
         throw Error('headingAst.children.length !== 1');
     if (headingAst.children[0].type !== 'heading')
-        throw Error('headingAst.children[0].type !== \'heading\'');
+        throw Error("headingAst.children[0].type !== 'heading'");
     const sectionDepth = headingAst.children[0].depth;
     const sectionText = extractTextFromMDAsHTML(headingAst);
     // Search for the index of the heading in the main document AST.
     const indexes = mainAst.children.flatMap((c, index) => {
-        if ((c.type === 'heading') && (c.depth === sectionDepth) && extractTextFromMDAsHTML(c).startsWith(sectionText)) {
+        if (c.type === 'heading' && c.depth === sectionDepth && extractTextFromMDAsHTML(c).startsWith(sectionText)) {
             return [index];
         }
         return [];
@@ -133,7 +148,7 @@ function findNextHeadingIndex(mainAst, startIndex, depth) {
 function getHeadingDepth(mainAst, index) {
     const node = mainAst.children[index];
     if (node.type !== 'heading')
-        throw Error('node.type !== \'heading\'');
+        throw Error("node.type !== 'heading'");
     return node.depth;
 }
 /**
@@ -142,9 +157,9 @@ function getHeadingDepth(mainAst, index) {
  * @param depth The depth to which the segment should be indented.
  */
 function indentSegmentToDepth(segmentAst, depth) {
-    segmentAst.children.forEach(node => {
+    segmentAst.children.forEach((node) => {
         if (node.type == 'heading')
-            return node.depth += depth;
+            return (node.depth += depth);
     });
 }
 /**
@@ -174,7 +189,6 @@ function extractTextFromMDAsHTML(node) {
         case 'html':
             return '';
         default:
-            console.log(node);
             throw Error('unknown type: ' + node.type);
     }
 }
@@ -200,12 +214,12 @@ function getMDAnchor(node) {
                 text += c.value;
                 break;
             default:
-                console.log(c);
                 throw Error('unknown type: ' + c.type);
         }
     }
     // Format the text to create a suitable anchor ID.
-    text = text.toLowerCase()
+    text = text
+        .toLowerCase()
         .replace(/[()]+/g, '')
         .replace(/[^a-z0-9]+/g, '-')
         .replace(/^-+|-+$/g, '');
@@ -238,7 +252,7 @@ function convertToFoldable(ast) {
     closeDetails(0);
     ast.children = children;
     function closeDetails(depth) {
-        while ((openDetails.length > 0) && (openDetails[0] >= depth)) {
+        while (openDetails.length > 0 && openDetails[0] >= depth) {
             children.push({ type: 'html', value: '</details>' });
             openDetails.shift();
         }
@@ -273,11 +287,13 @@ export function nodeToHtml(node) {
                 attributes.push(`title="${node.title}"`);
             return `<img ${attributes.join(' ')} />`;
         }
-        case 'footnoteReference': throw new Error('Not implemented yet: "footnoteReference" case');
-        case 'imageReference': throw new Error('Not implemented yet: "imageReference" case');
-        case 'linkReference': throw new Error('Not implemented yet: "linkReference" case');
+        case 'footnoteReference':
+            throw new Error('Not implemented yet: "footnoteReference" case');
+        case 'imageReference':
+            throw new Error('Not implemented yet: "imageReference" case');
+        case 'linkReference':
+            throw new Error('Not implemented yet: "linkReference" case');
         default:
-            console.log(node);
             throw Error('unknown type');
     }
 }
@@ -285,7 +301,7 @@ function nodesToHtml(children) {
     return children.map(nodeToHtml).join('');
 }
 function textToHtml(text) {
-    return text.replace(/[^a-z0-9 ,.\-:_?@äöüß]/gi, c => `&#${c.charCodeAt(0)};`);
+    return text.replace(/[^a-z0-9 ,.\-:_?@äöüß]/gi, (c) => `&#${c.charCodeAt(0)};`);
 }
 export function parseMarkdown(document) {
     return remark().use(remarkGfm).parse(document);

package/dist/commands/release-npm.d.ts

@@ -1,2 +1,2 @@
 #!/usr/bin/env npx tsx
-export declare function release(directory: string, branch?: string): Promise<void>;
+export declare function release(directory: string, branch?: string, dryRun?: boolean): Promise<void>;

package/dist/commands/release-npm.js

@@ -5,10 +5,19 @@ import { check, info, panic, warn } from '../lib/log.js';
 import { Shell } from '../lib/shell.js';
 import { getGit } from '../lib/git.js';
 import { resolve } from 'path';
-export async function release(directory, branch = 'main') {
+function isValidPackageJson(pkg) {
+    if (typeof pkg !== 'object' || pkg === null)
+        return false;
+    if (!('version' in pkg) || typeof pkg.version !== 'string')
+        return false;
+    if (!('scripts' in pkg) || typeof pkg.scripts !== 'object' || pkg.scripts === null)
+        return false;
+    return true;
+}
+export async function release(directory, branch = 'main', dryRun = false) {
     const shell = new Shell(directory);
     const { getCommitsBetween, getCurrentGitHubCommit, getLastGitHubTag } = getGit(directory);
-    info('starting release process');
+    info(dryRun ? 'starting release process (dry-run)' : 'starting release process');
     // git: check if in the correct branch
     const currentBranch = await check('get branch name', shell.stdout('git rev-parse --abbrev-ref HEAD'));
     if (currentBranch !== branch)
@@ -18,17 +27,14 @@ export async function release(directory, branch = 'main') {
     // git: pull
     await check('git pull', shell.run('git pull -t'));
     // check package.json
-    const pkg = JSON.parse(readFileSync(resolve(directory, 'package.json'), 'utf8'));
-    if (typeof pkg !== 'object' || pkg === null)
+    const pkgRaw = JSON.parse(readFileSync(resolve(directory, 'package.json'), 'utf8'));
+    if (!isValidPackageJson(pkgRaw))
         panic('package.json is not valid');
-    if (!('version' in pkg) || (typeof pkg.version !== 'string'))
-        panic('package.json is missing "version"');
-    if (!('scripts' in pkg) || (typeof pkg.scripts !== 'object') || (pkg.scripts == null))
-        panic('package.json is missing "scripts"');
-    if (!('check' in pkg.scripts))
+    if (!('check' in pkgRaw.scripts))
         panic('missing npm script "check" in package.json');
-    if (!('prepack' in pkg.scripts))
+    if (!('prepack' in pkgRaw.scripts))
         panic('missing npm script "prepack" in package.json');
+    const pkg = pkgRaw;
     // get last version
     const tag = await check('get last github tag', getLastGitHubTag());
     const shaLast = tag?.sha;
@@ -40,12 +46,31 @@ export async function release(directory, branch = 'main') {
     const { sha: shaCurrent } = await check('get current github commit', getCurrentGitHubCommit());
     // handle version
     const nextVersion = await getNewVersion(versionLastPackage);
+    // prepare release notes
+    const releaseNotes = await check('prepare release notes', getReleaseNotes(nextVersion, shaLast, shaCurrent));
+    if (dryRun) {
+        info('Dry-run mode - the following actions would be performed:');
+        info(`  Version: ${versionLastPackage} -> ${nextVersion}`);
+        info('  Release notes:');
+        releaseNotes.split('\n').forEach((line) => info(`    ${line}`));
+        info('  Commands that would be executed:');
+        info('    npm run check');
+        info('    npm i --package-lock-only');
+        if (!('private' in pkg) || !pkg.private) {
+            info('    npm publish --access public');
+        }
+        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(`    gh release create/edit "v${nextVersion}"`);
+        info('Dry-run complete - no changes were made');
+        return;
+    }
     // test
     await check('run checks', shell.run('npm run check'));
     // update version
     await check('update version', setNextVersion(nextVersion));
-    // prepare release notes
-    const releaseNotes = await check('prepare release notes', getReleaseNotes(nextVersion, shaLast, shaCurrent));
     if (!('private' in pkg) || !pkg.private) {
         // npm publish
         await check('npm publish', shell.runInteractive('npm publish --access public'));
@@ -56,12 +81,12 @@ export async function release(directory, branch = 'main') {
     await check('git tag', shell.run(`git tag -f -a "v${nextVersion}" -m "new release: v${nextVersion}"`));
     await check('git push', shell.run('git push --no-verify --follow-tags'));
     // github release
-    const releaseNotesPipe = `echo -e '${releaseNotes.replace(/[^a-z0-9,.?!:_<> -]/gi, c => '\\x' + ('00' + c.charCodeAt(0).toString(16)).slice(-2))}'`;
-    if (await check('check github release', shell.ok('gh release view v' + nextVersion))) {
-        await check('edit release', shell.run(`${releaseNotesPipe} | gh release edit "v${nextVersion}" -F -`));
+    const releaseTag = `v${nextVersion}`;
+    if (await check('check github release', shell.ok(`gh release view ${releaseTag}`))) {
+        await check('edit release', shell.exec('gh', ['release', 'edit', releaseTag, '--notes', releaseNotes]));
     }
     else {
-        await check('create release', shell.run(`${releaseNotesPipe} | gh release create "v${nextVersion}" -F -`));
+        await check('create release', shell.exec('gh', ['release', 'create', releaseTag, '--notes', releaseNotes]));
     }
     info('Finished');
     return;
@@ -80,30 +105,26 @@ export async function release(directory, branch = 'main') {
     }
     async function getReleaseNotes(version, hashLast, hashCurrent) {
         const commits = await getCommitsBetween(hashLast, hashCurrent);
-        let notes = commits.reverse()
-            .map(commit => '- ' + commit.message.replace(/\s+/g, ' '))
+        let notes = commits
+            .reverse()
+            .map((commit) => '- ' + commit.message.replace(/\s+/g, ' '))
             .join('\n');
         notes = `# Release v${version}\n\nchanges:\n${notes}\n\n`;
         return notes;
     }
     async function getNewVersion(versionPackage) {
         // ask for new version
-        const choices = [
-            { value: versionPackage },
-            { ...bump(2) },
-            { ...bump(1) },
-            { ...bump(0) }
-        ];
-        const versionNew = (await select({
+        const choices = [{ value: versionPackage }, { ...bump(2) }, { ...bump(1) }, { ...bump(0) }];
+        const versionNew = await select({
             message: 'What should be the new version?',
             choices,
             default: choices[1].value,
-        }));
+        });
         if (!versionNew)
             throw Error();
         return versionNew;
         function bump(index) {
-            const p = versionPackage.split('.').map(v => parseInt(v, 10));
+            const p = versionPackage.split('.').map((v) => parseInt(v, 10));
             if (p.length !== 3)
                 throw Error();
             switch (index) {
@@ -120,7 +141,7 @@ export async function release(directory, branch = 'main') {
                     p[2]++;
                     break;
             }
-            const name = p.map((n, i) => (i == index) ? `\x1b[1m${n}` : `${n}`).join('.') + '\x1b[22m';
+            const name = p.map((n, i) => (i == index ? `\x1b[1m${n}` : `${n}`)).join('.') + '\x1b[22m';
             const value = p.join('.');
             return { name, value };
         }

package/dist/index.js

@@ -11,6 +11,7 @@ import { upgradeDependencies } from './commands/deps-upgrade.js';
 import { generateDependencyGraph } from './commands/deps-graph.js';
 import { check } from './commands/check.js';
 import { generateTypescriptDocs } from './commands/doc-typescript.js';
+import { setVerbose } from './lib/log.js';
 /**
  * Main CLI program, configured with custom text styling for titles, commands, options, etc.
  */
@@ -26,12 +27,19 @@ program.configureHelp({
 });
 program
     .name('vrt')
-    .description('CLI tool for releasing packages and generating documentation for Node.js/TypeScript projects.');
+    .description('CLI tool for releasing packages and generating documentation for Node.js/TypeScript projects.')
+    .option('-v, --verbose', 'Enable verbose output')
+    .hook('preAction', (thisCommand) => {
+    const opts = thisCommand.opts();
+    if (opts.verbose)
+        setVerbose(true);
+});
 /**
  * Command: check-package
  * Checks that the project's package.json includes certain required scripts/fields.
  */
-program.command('check')
+program
+    .command('check')
     .description('Check repo for required scripts and other stuff.')
     .action(() => {
     void check(process.cwd());
@@ -40,7 +48,8 @@ program.command('check')
  * Command: deps-graph
  * Analyzes the project’s files to produce a dependency graph (in Mermaid format).
  */
-program.command('deps-graph')
+program
+    .command('deps-graph')
     .description('Analyze project files and output a dependency graph as Mermaid markup.')
     .action(() => {
     void generateDependencyGraph(process.cwd());
@@ -49,7 +58,8 @@ program.command('deps-graph')
  * Command: deps-upgrade
  * Upgrades project dependencies in package.json to their latest versions and reinstalls them.
  */
-program.command('deps-upgrade')
+program
+    .command('deps-upgrade')
     .description('Upgrade all dependencies in the current project to their latest versions.')
     .action(() => {
     void upgradeDependencies(process.cwd());
@@ -58,7 +68,8 @@ program.command('deps-upgrade')
  * Command: doc-command
  * Generates Markdown documentation for a given CLI command.
  */
-program.command('doc-command')
+program
+    .command('doc-command')
     .description('Generate Markdown documentation for a specified command and output the result.')
     .argument('<command>', 'Command to document (e.g., "npm run build").')
     .action(async (command) => {
@@ -70,7 +81,8 @@ program.command('doc-command')
  * Inserts Markdown content from stdin into a specified Markdown file under a given heading.
  * Optionally makes the inserted content foldable.
  */
-program.command('doc-insert')
+program
+    .command('doc-insert')
     .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')
@@ -80,8 +92,7 @@ program.command('doc-insert')
     for await (const data of process.stdin) {
         buffers.push(data);
     }
-    const mdContent = '<!--- This chapter is generated automatically --->\n'
-        + Buffer.concat(buffers).toString();
+    const mdContent = '<!--- This chapter is generated automatically --->\n' + Buffer.concat(buffers).toString();
     let mdFile = readFileSync(mdFilename, 'utf8');
     mdFile = injectMarkdown(mdFile, mdContent, heading, foldable);
     writeFileSync(mdFilename, mdFile);
@@ -90,7 +101,8 @@ program.command('doc-insert')
  * Command: doc-toc
  * Updates or generates a Table of Contents in a Markdown file under a specified heading.
  */
-program.command('doc-toc')
+program
+    .command('doc-toc')
     .description('Generate a Table of Contents (TOC) in a Markdown file.')
     .argument('<readme>', 'Path to the Markdown file (e.g., README.md).', checkFilename)
     .argument('[heading]', 'Heading in the Markdown file where TOC should be inserted. Default is "# Table of Content".', '# Table of Content')
@@ -104,7 +116,8 @@ program.command('doc-toc')
  * Generates documentation for a TypeScript project.
  * Allows specifying entry point and output location.
  */
-program.command('doc-typescript')
+program
+    .command('doc-typescript')
     .description('Generate documentation for a TypeScript project.')
     .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".')
@@ -116,11 +129,13 @@ program.command('doc-typescript')
  * Command: release-npm
  * Releases/publishes an npm package from a specified project path to the npm registry.
  */
-program.command('release-npm')
+program
+    .command('release-npm')
     .description('Publish an npm package from the specified path to the npm registry.')
+    .option('-n, --dry-run', 'Show what would be done without making any changes')
     .argument('[path]', 'Root path of the Node.js project. Defaults to the current directory.')
-    .action((path) => {
-    void release(resolve(path ?? '.', process.cwd()), 'main');
+    .action((path, options) => {
+    void release(resolve(process.cwd(), path ?? '.'), 'main', options.dryRun ?? false);
 });
 if (process.env.NODE_ENV !== 'test') {
     await program.parseAsync();

package/dist/lib/git.js

@@ -9,19 +9,19 @@ export function getGit(cwd) {
     async function getLastGitHubTag() {
         const commits = await getAllCommits();
         const result = commits
-            .map(commit => ({
+            .map((commit) => ({
             sha: commit.sha,
-            version: commit.tag?.match(/^v(\d+\.\d+\.\d+)$/)?.[1],
+            version: commit.tag?.match(/^v(\d+\.\d+\.\d+(?:-[\w.]+)?(?:\+[\w.]+)?)$/)?.[1],
         }))
-            .find(r => r.version);
+            .find((r) => r.version);
         return result;
     }
     async function getAllCommits() {
-        const result = await shell.stdout('git log --pretty=format:\'⍃%H⍄%s⍄%D⍄\'');
+        const result = await shell.stdout("git log --pretty=format:'⍃%H⍄%s⍄%D⍄'");
         return result
             .split('⍃')
-            .filter(line => line.length > 2)
-            .map(line => {
+            .filter((line) => line.length > 2)
+            .map((line) => {
             const obj = line.split('⍄');
             return {
                 sha: obj[0],
@@ -35,10 +35,10 @@ export function getGit(cwd) {
     }
     async function getCommitsBetween(shaLast, shaCurrent) {
         let commits = await getAllCommits();
-        const start = commits.findIndex(commit => commit.sha === shaCurrent);
+        const start = commits.findIndex((commit) => commit.sha === shaCurrent);
         if (start >= 0)
             commits = commits.slice(start);
-        const end = commits.findIndex(commit => commit.sha === shaLast);
+        const end = commits.findIndex((commit) => commit.sha === shaLast);
         if (end >= 0)
             commits = commits.slice(0, end);
         return commits;

package/dist/lib/log.d.ts

@@ -1,5 +1,8 @@
+export declare function setVerbose(enabled: boolean): void;
+export declare function isVerbose(): boolean;
 export declare function panic(text: string): never;
 export declare function warn(text: string): void;
 export declare function info(text: string): void;
+export declare function debug(text: string): void;
 export declare function abort(): never;
-export declare function check<T>(message: string, promise: (Promise<T>) | (() => Promise<T>)): Promise<T>;
+export declare function check<T>(message: string, promise: Promise<T> | (() => Promise<T>)): Promise<T>;

package/dist/lib/log.js

@@ -1,3 +1,10 @@
+let verboseMode = false;
+export function setVerbose(enabled) {
+    verboseMode = enabled;
+}
+export function isVerbose() {
+    return verboseMode;
+}
 export function panic(text) {
     process.stderr.write(`\x1b[1;31m! ERROR: ${text}\x1b[0m\n`);
     abort();
@@ -8,9 +15,14 @@ export function warn(text) {
 export function info(text) {
     process.stderr.write(`\x1b[0mi ${text}\n`);
 }
+export function debug(text) {
+    if (verboseMode) {
+        process.stderr.write(`\x1b[0;90m  ${text}\x1b[0m\n`);
+    }
+}
 export function abort() {
     info('abort');
-    process.exit();
+    process.exit(1);
 }
 export async function check(message, promise) {
     process.stderr.write(`\x1b[0;90m\u2B95 ${message}\x1b[0m`);
@@ -22,7 +34,6 @@ export async function check(message, promise) {
     catch (error) {
         process.stderr.write(`\r\x1b[0;91m\u2718 ${message}\x1b[0m\n`);
         panic(error.message);
-        throw error;
     }
 }
 //# sourceMappingURL=log.js.map

package/dist/lib/shell.d.ts

@@ -7,6 +7,12 @@ export declare class Shell {
         stdout: string;
         stderr: string;
     }>;
+    exec(command: string, args: string[], errorOnCodeNonZero?: boolean, skipLog?: boolean): Promise<{
+        code: number | null;
+        signal: string | null;
+        stdout: string;
+        stderr: string;
+    }>;
     runInteractive(command: string, errorOnCodeNonZero?: boolean): Promise<{
         code: number | null;
         signal: string | null;

package/dist/lib/shell.js

@@ -1,38 +1,48 @@
 import { spawn } from 'child_process';
+import { debug, isVerbose } from './log.js';
 export class Shell {
     cwd;
     constructor(cwd) {
         this.cwd = cwd;
     }
     async run(command, errorOnCodeNonZero = true) {
-        try {
-            return await new Promise((resolve, reject) => {
-                const stdout = [];
-                const stderr = [];
-                const cp = spawn('bash', ['-c', command], { cwd: this.cwd })
-                    .on('error', error => reject(error))
-                    .on('close', (code, signal) => {
-                    const result = {
-                        code,
-                        signal,
-                        stdout: Buffer.concat(stdout).toString(),
-                        stderr: Buffer.concat(stderr).toString(),
-                    };
-                    if (errorOnCodeNonZero && code !== 0) {
-                        reject(result);
-                    }
-                    else {
-                        resolve(result);
-                    }
-                });
-                cp.stdout.on('data', chunk => stdout.push(chunk));
-                cp.stderr.on('data', chunk => stderr.push(chunk));
-            });
-        }
-        catch (error) {
-            console.error(error);
-            throw error;
+        debug(`$ ${command}`);
+        return this.exec('bash', ['-c', command], errorOnCodeNonZero, true);
+    }
+    // Execute a command with arguments directly, avoiding shell escaping issues
+    async exec(command, args, errorOnCodeNonZero = true, skipLog = false) {
+        if (!skipLog) {
+            debug(`$ ${command} ${args.join(' ')}`);
         }
+        return await new Promise((resolve, reject) => {
+            const stdout = [];
+            const stderr = [];
+            const cp = spawn(command, args, { cwd: this.cwd })
+                .on('error', (error) => reject(error))
+                .on('close', (code, signal) => {
+                const result = {
+                    code,
+                    signal,
+                    stdout: Buffer.concat(stdout).toString(),
+                    stderr: Buffer.concat(stderr).toString(),
+                };
+                if (isVerbose()) {
+                    if (result.stdout)
+                        result.stdout.split('\n').forEach((line) => debug(`  stdout: ${line}`));
+                    if (result.stderr)
+                        result.stderr.split('\n').forEach((line) => debug(`  stderr: ${line}`));
+                    debug(`  exit code: ${code}`);
+                }
+                if (errorOnCodeNonZero && code !== 0) {
+                    reject(result);
+                }
+                else {
+                    resolve(result);
+                }
+            });
+            cp.stdout.on('data', (chunk) => stdout.push(chunk));
+            cp.stderr.on('data', (chunk) => stderr.push(chunk));
+        });
     }
     // Runs a command interactively, so the user can interact with stdin/stdout/stderr directly.
     async runInteractive(command, errorOnCodeNonZero = true) {

package/dist/lib/utils.js

@@ -24,10 +24,22 @@ export function prettyStyleJSON(inputData) {
             return singleLine(data);
         if (typeof data === 'object') {
             if (Array.isArray(data)) {
-                return '[\n\t' + prefix + data.map((value) => recursive(value, prefix + '\t', path + '[]')).join(',\n\t' + prefix) + '\n' + prefix + ']';
+                return ('[\n\t' +
+                    prefix +
+                    data.map((value) => recursive(value, prefix + '\t', path + '[]')).join(',\n\t' + prefix) +
+                    '\n' +
+                    prefix +
+                    ']');
             }
             if (data) {
-                return '{\n\t' + prefix + Object.entries(data).map(([key, value]) => '"' + key + '": ' + recursive(value, prefix + '\t', path + '.' + key)).join(',\n\t' + prefix) + '\n' + prefix + '}';
+                return ('{\n\t' +
+                    prefix +
+                    Object.entries(data)
+                        .map(([key, value]) => '"' + key + '": ' + recursive(value, prefix + '\t', path + '.' + key))
+                        .join(',\n\t' + prefix) +
+                    '\n' +
+                    prefix +
+                    '}');
             }
         }
         return singleLine(data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/release-tool",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "VersaTiles release and documentation tools",
   "bin": {
     "vrt": "./dist/index.js"
@@ -12,11 +12,13 @@
   "scripts": {
     "build": "npm run build-node && npm run doc",
     "build-node": "rm -rf dist && tsc -p tsconfig.build.json && chmod +x dist/index.js",
-    "check": "npm run lint && npm run build && npm run test",
+    "check": "npm run lint && npm run build && npm run test && npm run format:check",
     "dev": "tsx src/index.ts",
     "doc": "npm run doc-command && npm run doc-graph",
     "doc-command": "tsx src/index.ts doc-command vrt | tsx src/index.ts doc-insert README.md '# Command'",
     "doc-graph": "tsx src/index.ts deps-graph | tsx src/index.ts doc-insert README.md '## Dependency Graph'",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "lint": "eslint . --color",
     "prepack": "npm run build",
     "release": "tsx src/index.ts release-npm",
@@ -27,6 +29,9 @@
   "author": "Michael Kreil <versatiles@michael-kreil.de>",
   "license": "Unlicense",
   "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/versatiles-org/node-release-tool.git"
@@ -34,24 +39,25 @@
   "homepage": "https://github.com/versatiles-org/node-release-tool",
   "devDependencies": {
     "@schemastore/package": "^0.0.10",
-    "@types/node": "^24.10.1",
-    "@typescript-eslint/eslint-plugin": "^8.48.1",
-    "@typescript-eslint/parser": "^8.48.1",
-    "@vitest/coverage-v8": "^4.0.15",
-    "eslint": "^9.39.1",
+    "@types/node": "^25.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^9.39.2",
+    "prettier": "^3.8.1",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.48.1",
-    "vitest": "^4.0.15"
+    "typescript-eslint": "^8.54.0",
+    "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@inquirer/select": "^5.0.2",
+    "@inquirer/select": "^5.0.4",
     "commander": "^14.0.2",
-    "dependency-cruiser": "^17.3.2",
-    "npm-check-updates": "^19.1.2",
+    "dependency-cruiser": "^17.3.7",
+    "npm-check-updates": "^19.3.2",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "typedoc": "^0.28.15",
+    "typedoc": "^0.28.16",
     "typedoc-github-theme": "^0.3.1",
     "typedoc-github-wiki-theme": "^2.1.0",
     "typedoc-plugin-markdown": "^4.9.0"