@versatiles/release-tool 1.2.4 → 1.2.6

package/README.md

@@ -43,14 +43,8 @@ Have a look at this [package.json](https://github.com/versatiles-org/node-releas
 
 <!--- This chapter is generated automatically --->
 
-> @versatiles/release-tool@1.2.4 npx
-> vrt cmd2md vrt
-
 ```console
 $ vrt
-> @versatiles/release-tool@1.2.4 npx
-> vrt --help
-
 Usage: vrt [options] [command]
 
 versatiles release and documentaion tool
@@ -71,9 +65,6 @@ Commands:
 
 ```console
 $ vrt ts2md
-> @versatiles/release-tool@1.2.4 npx
-> vrt ts2md --help
-
 Usage: vrt ts2md [options] <typescript> <tsconfig>
 
 documents a TypeScript file and outputs it to stdout
@@ -90,9 +81,6 @@ Options:
 
 ```console
 $ vrt cmd2md
-> @versatiles/release-tool@1.2.4 npx
-> vrt cmd2md --help
-
 Usage: vrt cmd2md [options] <command>
 
 documents a runnable command and outputs it to stdout
@@ -108,9 +96,6 @@ Options:
 
 ```console
 $ vrt insertmd
-> @versatiles/release-tool@1.2.4 npx
-> vrt insertmd --help
-
 Usage: vrt insertmd [options] <readme> [heading] [foldable]
 
 takes Markdown from stdin and insert it into a Markdown file
@@ -128,9 +113,6 @@ Options:
 
 ```console
 $ vrt inserttoc
-> @versatiles/release-tool@1.2.4 npx
-> vrt inserttoc --help
-
 Usage: vrt inserttoc [options] <readme> [heading]
 
 updates the TOC in a Markdown file
@@ -147,9 +129,6 @@ Options:
 
 ```console
 $ vrt release-npm
-> @versatiles/release-tool@1.2.4 npx
-> vrt release-npm --help
-
 Usage: vrt release-npm [options] [path]
 
 release a npm package

package/dist/commands/command.js

@@ -31,7 +31,6 @@ export async function generateCommandDocumentation(command) {
  */
 async function getCommandResults(command) {
     return new Promise((resolve, reject) => {
-        // eslint-disable-next-line @typescript-eslint/naming-convention
         const env = { ...process.env, NODE_ENV: undefined };
         // Spawn a child process to run the command with the '--help' flag.
         const childProcess = cp.spawn('npx', [...command.split(' '), '--help'], { env });
@@ -72,7 +71,7 @@ function extractSubcommands(result) {
         .split('\n') // Split by newline to process each line.
         .flatMap((line) => {
         // Extract subcommand names from each line.
-        const extract = /^  ([^ ]{2,})/.exec(line);
+        const extract = /^ {2}([^ ]{2,})/.exec(line);
         if (!extract)
             return [];
         const [, subcommand] = extract;

package/dist/commands/markdown.js

@@ -10,7 +10,6 @@ import { getErrorMessage } from '../lib/utils.js';
  * @param foldable If true, makes the segment foldable.
  * @returns The modified Markdown document.
  */
-// eslint-disable-next-line @typescript-eslint/max-params
 export function injectMarkdown(document, segment, heading, foldable) {
     // Parse the input strings into Abstract Syntax Trees (ASTs).
     const documentAst = parseMarkdown(document);
@@ -145,7 +144,6 @@ function indentSegmentToDepth(segmentAst, depth) {
  * @param startIndex The start index in the main AST.
  * @param endIndex The end index in the main AST.
  */
-// eslint-disable-next-line @typescript-eslint/max-params
 function mergeSegments(mainAst, segmentAst, startIndex, endIndex) {
     mainAst.children.splice(startIndex, endIndex - startIndex, ...segmentAst.children);
 }
@@ -181,11 +179,12 @@ function getMDAnchor(node) {
     for (const c of node.children) {
         // Handle different types of child nodes to construct the anchor text.
         switch (c.type) {
-            case 'html':
+            case 'html': {
                 const match = /<a\s.*id\s*=\s*['"]([^'"]+)/i.exec(c.value);
                 if (match)
                     return match[1];
                 break;
+            }
             case 'text':
             case 'inlineCode':
                 text += c.value;
@@ -199,7 +198,7 @@ function getMDAnchor(node) {
     text = text.toLowerCase()
         .replace(/[()]+/g, '')
         .replace(/[^a-z0-9]+/g, '-')
-        .replace(/^\-+|\-+$/g, '');
+        .replace(/^-+|-+$/g, '');
     return text;
 }
 /**
@@ -256,13 +255,14 @@ export function nodeToHtml(node) {
             return `<strong>${nodesToHtml(node.children)}</strong>`;
         case 'link':
             return `<a href="${node.url}"${node.title == null ? '' : ` title="${node.title}"`}>${nodesToHtml(node.children)}</a>`;
-        case 'image':
+        case 'image': {
             const attributes = [`src="${node.url}"`];
             if (node.alt ?? '')
                 attributes.push(`alt="${node.alt}"`);
             if (node.title ?? '')
                 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');

package/dist/commands/release.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env npx tsx
 import { readFileSync, writeFileSync } from 'node:fs';
-import inquirer from 'inquirer';
+import select from '@inquirer/select';
 import { check, info, panic, warn } from '../lib/log.js';
 import { getShell } from '../lib/shell.js';
 import { getGit } from '../lib/git.js';
@@ -46,7 +46,7 @@ export async function release(directory, branch = 'main') {
     await check('update version', setNextVersion(nextVersion));
     // prepare release notes
     const releaseNotes = await check('prepare release notes', getReleaseNotes(nextVersion, shaLast, shaCurrent));
-    if (!('private' in pkg) || !Boolean(pkg.private)) {
+    if (!('private' in pkg) || !pkg.private) {
         // npm publish
         await check('npm publish', shell.run('npm publish --access public'));
     }
@@ -72,7 +72,6 @@ export async function release(directory, branch = 'main') {
     }
     async function setNextVersion(version) {
         // set new version in package.json
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const packageJSON = JSON.parse(readFileSync(resolve(directory, 'package.json'), 'utf8'));
         packageJSON.version = version;
         writeFileSync(resolve(directory, 'package.json'), JSON.stringify(packageJSON, null, '  ') + '\n');
@@ -89,15 +88,17 @@ export async function release(directory, branch = 'main') {
     }
     async function getNewVersion(versionPackage) {
         // ask for new version
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-        const versionNew = (await inquirer.prompt({
+        const choices = [
+            { value: versionPackage },
+            { ...bump(2) },
+            { ...bump(1) },
+            { ...bump(0) }
+        ];
+        const versionNew = (await select({
             message: 'What should be the new version?',
-            name: 'versionNew',
-            type: 'list',
-            choices: [versionPackage, bump(2), bump(1), bump(0)],
-            default: 1,
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        })).versionNew;
+            choices,
+            default: choices[1].value,
+        }));
         if (!versionNew)
             throw Error();
         return versionNew;

package/dist/commands/typedoc.js

@@ -18,7 +18,8 @@ function* documentProject(project) {
     }
     for (const group of project.groups) {
         yield '\n# ' + group.title;
-        for (const declaration of group.children) {
+        for (const d of group.children) {
+            const declaration = d;
             switch (declaration.kind) {
                 case ReflectionKind.Class:
                     yield* documentClass(declaration);
@@ -201,7 +202,7 @@ function formatTypeDeclaration(someType) {
                 return some.name;
             case 'literal':
                 return JSON.stringify(some.value);
-            case 'reference':
+            case 'reference': {
                 let result = some.name;
                 if (some.reflection)
                     result = `[${result}](#${createAnchorId(some.reflection)})`;
@@ -211,6 +212,7 @@ function formatTypeDeclaration(someType) {
                             .map(getTypeRec).join(',')
                         + '>';
                 return result;
+            }
             case 'reflection':
                 switch (some.declaration.kind) {
                     case ReflectionKind.TypeLiteral: return decodeReflectionTypeLiteral(some.declaration);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versatiles/release-tool",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "VersaTiles release and documentation tools",
   "bin": {
     "vrt": "./dist/index.js"
@@ -30,23 +30,24 @@
   "homepage": "https://github.com/versatiles-org/node-versatiles/blob/main/versatiles-release-tool/README.md",
   "devDependencies": {
     "@types/inquirer": "^9.0.7",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.2",
-    "@typescript-eslint/eslint-plugin": "^7.12.0",
-    "@typescript-eslint/parser": "^7.12.0",
-    "eslint": "^8.57.0",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.5.5",
+    "@typescript-eslint/eslint-plugin": "^8.6.0",
+    "@typescript-eslint/parser": "^8.6.0",
+    "eslint": "^9.11.0",
     "jest": "^29.7.0",
-    "npm-check-updates": "^16.14.20",
-    "ts-jest": "^29.1.4",
+    "npm-check-updates": "^17.1.3",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "tsx": "^4.12.0",
-    "typescript": "^5.4.5"
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2",
+    "typescript-eslint": "^8.6.0"
   },
   "dependencies": {
+    "@inquirer/select": "^3.0.1",
     "commander": "^12.1.0",
-    "inquirer": "^9.2.23",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.0",
-    "typedoc": "^0.25.13"
+    "typedoc": "^0.26.7"
   }
 }