@villedemontreal/caporal 3.1.10 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@villedemontreal/caporal",
-  "version": "3.1.10",
+  "version": "4.0.0",
   "description": "A full-featured framework for building command line applications (cli) with node.js",
   "main": "./dist/src/index.js",
   "typings": "dist/src",
@@ -13,8 +13,8 @@
     "test": "vitest run src",
     "compile": "tsc --build",
     "show-tsconfig": "tsc --showConfig",
-    "lint": "eslint -c .eslintrc.js --ext .ts src",
-    "lint-fix": "eslint -c .eslintrc.js --fix --ext .ts src",
+    "lint": "eslint",
+    "lint-fix": "eslint --fix",
     "ncu": "ncu --target minor -x @types/node",
     "ncu-fix": "ncu -u --target minor -x @types/node"
   },
@@ -46,28 +46,32 @@
   },
   "license": "MIT",
   "devDependencies": {
+    "@eslint/eslintrc": "3.3.3",
+    "@eslint/js": "9.39.2",
     "@tsconfig/node22": "22.0.5",
     "@types/lodash": "^4.17.21",
-    "@types/node": "20.5.6",
+    "@types/node": "25.0.3",
     "@types/tabtab": "^3.0.4",
-    "@typescript-eslint/eslint-plugin": "5.62.0",
-    "@typescript-eslint/parser": "5.62.0",
-    "eslint": "8.57.1",
-    "eslint-config-prettier": "8.10.2",
+    "@typescript-eslint/eslint-plugin": "8.50.1",
+    "@typescript-eslint/parser": "8.50.1",
+    "@typescript-eslint/utils": "^8.50.1",
+    "eslint": "9.39.2",
+    "eslint-config-prettier": "10.1.8",
     "eslint-plugin-prettier": "5.5.4",
+    "globals": "16.5.0",
     "json": "^11.0.0",
-    "prettier": "3.7.3",
+    "prettier": "3.7.4",
     "strip-ansi": "^7.1.2",
     "typescript": "5.9.3",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.16"
   },
   "dependencies": {
-    "chalk": "4.1.2",
-    "glob": "^11.1.0",
+    "chalk": "5.6.2",
+    "glob": "^13.0.0",
     "lodash": "^4.17.21",
     "lodash.truncate": "^4.4.2",
     "table": "^6.9.0",
     "tabtab": "^3.0.2",
-    "winston": "^3.18.3"
+    "winston": "^3.19.0"
   }
 }

package/src/autocomplete/index.ts

@@ -147,7 +147,7 @@ async function getCompOptValues(ctx: CompletionContext): Promise<CompletionItem[
   if (currentOpt.choices.length) {
     return currentOpt.choices.map((choice) => ({
       name: choice.toString(),
-      description: "Value for option " + currentOpt.synopsis,
+      description: `Value for option ${currentOpt.synopsis}`,
     }))
   }
 
@@ -188,7 +188,7 @@ async function getCompArgValues(ctx: CompletionContext): Promise<CompletionItem[
     return arg.choices
       .map((choice) => ({
         name: choice.toString(),
-        description: "Value for argument " + arg.synopsis,
+        description: `Value for argument ${arg.synopsis}`,
       }))
       .filter((choice) => !lastPartial || choice.name.toString().startsWith(lastPartial))
   }
@@ -214,7 +214,7 @@ async function hanldleCompleter(
       return item
     }
     return {
-      name: "" + item,
+      name: `${item}`,
       description: `Value for ${type} ${argOrOpt.synopsis}`,
     }
   })

package/src/command/__tests__/command.spec.ts

@@ -169,6 +169,7 @@ describe("Command", () => {
 
   it(".run() should throw an ActionError when action throws a message", async () => {
     const action = vi.fn(() => {
+      // eslint-disable-next-line @typescript-eslint/only-throw-error
       throw "User Error"
     })
     const cmd = prog.command("order", "Order something").action(action)

package/src/command/find.ts

@@ -52,6 +52,6 @@ async function discoverCommand(
     }
     return cmdBuilder(options)
     // eslint-disable-next-line no-empty
-  } catch (e) {}
+  } catch {}
   return undefined
 }

package/src/command/index.ts

@@ -267,16 +267,11 @@ export class Command {
         ? "<OPTIONS...>"
         : "[OPTIONS...]"
       : ""
-    const name = this._name !== PROG_CMD ? " " + this._name : ""
+    const name = this._name !== PROG_CMD ? ` ${this._name}` : ""
 
-    return (
-      this.program.getBin() +
-      name +
-      " " +
-      this.args.map((a) => a.synopsis).join(" ") +
-      " " +
-      opts
-    ).trim()
+    return `${this.program.getBin() + name} ${this.args
+      .map((a) => a.synopsis)
+      .join(" ")} ${opts}`.trim()
   }
 
   /**

package/src/error/fatal.ts

@@ -14,7 +14,7 @@ export function fatalError(error: BaseError): void {
     logger.log({
       level: "error",
       ...error,
-      message: error.message + "\n\n" + error.stack,
+      message: `${error.message}\n\n${error.stack}`,
       stack: error.stack,
       name: error.name,
     })

package/src/error/multi-validation.ts

@@ -11,12 +11,9 @@ import type { Command } from "../command"
 export class ValidationSummaryError extends BaseError {
   constructor(cmd: Command, errors: CommonError[]) {
     const plural = errors.length > 1 ? "s" : ""
-    const msg =
-      `The following error${plural} occured:\n` +
-      errors.map((e) => "- " + e.message.replace(/\n/g, "\n  ")).join("\n") +
-      "\n\n" +
-      chalk.dim("Synopsis: ") +
-      colorize(cmd.synopsis)
+    const msg = `The following error${plural} occured:\n${errors
+      .map((e) => `- ${e.message.replace(/\n/g, "\n  ")}`)
+      .join("\n")}\n\n${chalk.dim("Synopsis: ")}${colorize(cmd.synopsis)}`
     super(msg, { errors })
   }
 }

package/src/error/unknown-command.ts

@@ -23,17 +23,16 @@ export class UnknownOrUnspecifiedCommandError extends BaseError {
       msg = `Unknown command ${chalk.bold(command)}.`
       const suggestions = getSuggestions(command, possibilities)
       if (suggestions.length) {
-        msg +=
-          " Did you mean " +
-          suggestions.map((s) => boldDiffString(command, s)).join(" or maybe ") +
-          " ?"
+        msg += ` Did you mean ${suggestions
+          .map((s) => boldDiffString(command, s))
+          .join(" or maybe ")} ?`
       }
     } else {
       msg =
-        "Unspecified command. Available commands are:\n" +
-        possibilities.map((p) => chalk.whiteBright(p)).join(", ") +
-        "." +
-        `\n\nFor more help, type ${chalk.whiteBright(program.getBin() + " --help")}`
+        `Unspecified command. Available commands are:\n${possibilities
+          .map((p) => chalk.whiteBright(p))
+          .join(", ")}.` +
+        `\n\nFor more help, type ${chalk.whiteBright(`${program.getBin()} --help`)}`
     }
 
     super(msg, { command })

package/src/error/unknown-option.ts

@@ -28,12 +28,9 @@ export class UnknownOptionError extends BaseError {
 
     let msg = `Unknown option ${c.bold.redBright(getDashedOpt(flag))}. `
     if (suggestions.length) {
-      msg +=
-        "Did you mean " +
-        suggestions
-          .map((s) => boldDiffString(getDashedOpt(flag), getDashedOpt(s)))
-          .join(" or maybe ") +
-        " ?"
+      msg += `Did you mean ${suggestions
+        .map((s) => boldDiffString(getDashedOpt(flag), getDashedOpt(s)))
+        .join(" or maybe ")} ?`
     }
     super(msg, { flag, command })
   }

package/src/error/validation.ts

@@ -63,7 +63,7 @@ export class ValidationError extends BaseError {
         'Invalid value for %s %s.\nExpected one of %s, but got "%s".',
         varName,
         c.redBright(name),
-        "'" + validator.join("', '") + "'",
+        `'${validator.join("', '")}'`,
         c.redBright(value),
       )
     } else if (validator instanceof RegExp) {
@@ -75,6 +75,6 @@ export class ValidationError extends BaseError {
         c.redBright(value),
       )
     }
-    super(message + "")
+    super(`${message}`)
   }
 }

package/src/help/index.ts

@@ -85,7 +85,7 @@ export function getContext(program: Program, command?: Command): TemplateContext
     table: buildTable,
     spaces,
     indent(str: string, sp = spaces) {
-      return sp + replace(str.trim(), /(\r\n|\r|\n)/g, "\n" + sp)
+      return sp + replace(str.trim(), /(\r\n|\r|\n)/g, `\n${sp}`)
     },
     eol: "\n",
     eol2: "\n\n",

package/src/help/templates/command.ts

@@ -2,7 +2,7 @@
  * @packageDocumentation
  * @internal
  */
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
+
 import type { TemplateContext, Template } from "../types"
 import { getOptionsTable, getArgumentsTable } from "../utils"
 import sortBy from "lodash/sortBy"
@@ -10,14 +10,14 @@ import sortBy from "lodash/sortBy"
 export const command: Template = async (ctx: TemplateContext) => {
   const { cmd, globalOptions: globalFlags, eol, eol3, colorize, tpl } = ctx
 
-  const options = sortBy(cmd!.options, "name"),
+  const options = sortBy(cmd.options, "name"),
     globalOptions = Array.from(globalFlags.keys())
 
   const help =
-    cmd!.synopsis +
+    cmd.synopsis +
     eol3 +
     (await tpl("custom", ctx)) +
-    getArgumentsTable(cmd!.args, ctx) +
+    getArgumentsTable(cmd.args, ctx) +
     eol +
     getOptionsTable(options, ctx) +
     eol +

package/src/help/templates/header.ts

@@ -7,13 +7,7 @@ import type { TemplateContext, Template } from "../types"
 export const header: Template = (ctx: TemplateContext) => {
   const { prog, chalk: c, spaces, eol, eol2 } = ctx
   const version = process.env?.NODE_ENV === "test" ? "" : prog.getVersion()
-  return (
-    eol +
-    spaces +
-    (prog.getName() || prog.getBin()) +
-    " " +
-    (version || "") +
-    (prog.getDescription() ? " \u2014 " + c.dim(prog.getDescription()) : "") +
-    eol2
-  )
+  return `${eol + spaces + (prog.getName() || prog.getBin())} ${version || ""}${
+    prog.getDescription() ? ` \u2014 ${c.dim(prog.getDescription())}` : ""
+  }${eol2}`
 }

package/src/help/templates/usage.ts

@@ -15,7 +15,7 @@ export const usage: Template = async (ctx: TemplateContext) => {
   }
 
   // usage
-  const usage = `${spaces + c.bold("USAGE")} ${cmd?.name ? "— " + c.dim(cmd.name) : ""}
+  const usage = `${spaces + c.bold("USAGE")} ${cmd?.name ? `— ${c.dim(cmd.name)}` : ""}
   ${eol + spaces + spaces + c.dim("\u25B8")} `
 
   const next = cmd ? await tpl("command", ctx) : await tpl("program", ctx)

package/src/help/utils.ts

@@ -36,7 +36,7 @@ export function buildTable(data: string[][], options = {}): string {
 export function getDefaultValueHint(obj: Argument | Option): string | undefined {
   return obj.default !== undefined &&
     !("boolean" in obj && obj.boolean && obj.default === false)
-    ? "default: " + JSON.stringify(obj.default)
+    ? `default: ${JSON.stringify(obj.default)}`
     : undefined
 }
 
@@ -97,8 +97,7 @@ export function getCommandsTable(
 ): string {
   const { chalk, prog, eol2, table, spaces } = ctx
   const cmdHint = `Type '${prog.getBin()} help <command>' to get some help about a command`
-  const help =
-    spaces + chalk.bold(title) + ` ${chalk.dim("\u2014")} ` + chalk.dim(cmdHint) + eol2
+  const help = `${spaces + chalk.bold(title)} ${chalk.dim("\u2014")} ${chalk.dim(cmdHint)}${eol2}`
   const rows = commands
     .filter((c) => c.visible)
     .map((cmd) => {

package/src/logger/__tests__/logger.spec.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 import { program } from "../../index"
 import { Program } from "../../program"
 import { logger } from ".."

package/src/logger/index.ts

@@ -11,7 +11,8 @@ import { EOL } from "os"
 
 const caporalFormat = format.printf((data) => {
   const { level, ...meta } = data
-  let { message } = data
+  // eslint-disable-next-line @typescript-eslint/no-base-to-string
+  let message = data.message?.toString() ?? ""
   let prefix = ""
 
   const levelStr = getLevelString(level)

package/src/option/__tests__/global.spec.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 import { program } from "../../index"
 import { Program } from "../../program"
 import { logger } from "../../logger"

package/src/option/index.ts

@@ -73,7 +73,7 @@ export { showHelp }
  */
 const showHelp: Action = async ({ program, command }: ActionParameters) => {
     const help = await getHelp(program, command)
-    // eslint-disable-next-line no-console
+
     console.log(help)
     program.emit("help", help)
     return false
@@ -84,7 +84,6 @@ const showHelp: Action = async ({ program, command }: ActionParameters) => {
    * @internal
    */
   showVersion: Action = ({ program }: ActionParameters) => {
-    // eslint-disable-next-line no-console
     console.log(program.getVersion())
     program.emit("version", program.getVersion())
     return false

package/src/option/utils.ts

@@ -132,8 +132,8 @@ export function parseOptionSynopsis(synopsis: string): OptionSynopsis {
     throw new OptionSynopsisSyntaxError(synopsis)
   }
 
-  infos.name = infos.longName || (infos.shortName as string)
-  infos.notation = infos.longNotation || (infos.shortNotation as string)
+  infos.name = infos.longName || infos.shortName
+  infos.notation = infos.longNotation || infos.shortNotation
 
   const fullSynopsis = { ...infos } as OptionSynopsis
 

package/src/parser/index.ts

@@ -34,7 +34,7 @@ function castAsBool(value: string | boolean): boolean {
 }
 
 function castAsString(val: string | boolean): string {
-  return val + ""
+  return `${val}`
 }
 
 function autoCast(val: string): ParserTypes {
@@ -330,7 +330,7 @@ class OptionParser {
     multi.forEach((o, index) => {
       const alias = this.config.alias[o]
       this.options[o] = index + 1 === n ? cast(o, val as string, this.config) : true
-      this.rawOptions["-" + o] = this.options[o]
+      this.rawOptions[`-${o}`] = this.options[o]
       if (alias) {
         this.options[alias] = this.options[o]
       }

package/src/program/__tests__/program.spec.ts

@@ -134,7 +134,7 @@ describe("Program", () => {
   })
 
   it("should be able to call discovered commands", async () => {
-    prog.discover(__dirname + "/../../command/__fixtures__")
+    prog.discover(`${__dirname}/../../command/__fixtures__`)
     await expect(prog.run(["example-cmd"])).resolves.toBe("hey")
   })
 

package/src/program/index.ts

@@ -148,7 +148,7 @@ export class Program extends EventEmitter {
         const command = args.command
           ? await findCommand(this, [args.command as string])
           : undefined
-        // eslint-disable-next-line no-console
+
         showHelp({ ...actionParams, command })
         return -1
       })
@@ -207,12 +207,9 @@ export class Program extends EventEmitter {
    * @internal
    */
   async getSynopsis(): Promise<string> {
-    return (
-      this.getBin() +
-      " " +
-      ((await this.hasCommands()) ? "<command> " : "") +
-      "[ARGUMENTS...] [OPTIONS...]"
-    ).trim()
+    return `${this.getBin()} ${
+      (await this.hasCommands()) ? "<command> " : ""
+    }[ARGUMENTS...] [OPTIONS...]`.trim()
   }
 
   /**
@@ -487,7 +484,7 @@ export class Program extends EventEmitter {
     try {
       stat = fs.statSync(dirPath)
       // eslint-disable-next-line no-empty
-    } catch (e) {}
+    } catch {}
     if (!stat || !stat.isDirectory()) {
       throw new Error(
         "Caporal setup error: parameter `dirPath` of discover() should be a directory",
@@ -576,7 +573,7 @@ export class Program extends EventEmitter {
       We are forced to catch a potential error to prevent the rejected
       promise to propagate un in the stack. 
     */
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
+
     return this._run(result, cmd) /*
     .catch((e) => e) */
   }

package/src/utils/__tests__/suggest.spec.ts

@@ -11,19 +11,19 @@ describe("Suggest", () => {
   })
   describe("boldDiffString()", () => {
     it("should make the diff bold at the end of the word", () => {
-      expect(boldDiffString("foo", "foob")).toEqual("foo" + c.bold.greenBright("b"))
+      expect(boldDiffString("foo", "foob")).toEqual(`foo${c.bold.greenBright("b")}`)
     })
     it("should make the diff bold at the beginning of the word", () => {
-      expect(boldDiffString("foo", "doo")).toBe(c.bold.greenBright("d") + "oo")
+      expect(boldDiffString("foo", "doo")).toBe(`${c.bold.greenBright("d")}oo`)
     })
 
     it("should make the diff bold at the middle of the word", () => {
-      expect(boldDiffString("foo", "fao")).toBe("f" + c.bold.greenBright("a") + "o")
+      expect(boldDiffString("foo", "fao")).toBe(`f${c.bold.greenBright("a")}o`)
     })
 
     it("should make the diff bold anywhere in the word", () => {
       expect(boldDiffString("minimum", "maximum")).toBe(
-        "m" + c.bold.greenBright("a") + c.bold.greenBright("x") + "imum",
+        `m${c.bold.greenBright("a")}${c.bold.greenBright("x")}imum`,
       )
     })
   })

package/src/utils/version.ts

@@ -6,9 +6,9 @@ import path from "path"
 
 export function detectVersion(): string | undefined {
   try {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     return require(path.join(__filename, "..", "..", "..", "package.json")).version
     // eslint-disable-next-line no-empty
-  } catch (e) {}
+  } catch {}
   return undefined
 }

package/src/utils/web/autocomplete.ts

@@ -6,8 +6,7 @@
  */
 import type { Program } from "../../program"
 import type { Argument, Option } from "../../types"
-/* eslint-disable @typescript-eslint/explicit-function-return-type */
-/* eslint-disable @typescript-eslint/no-empty-function */
+
 /* eslint-disable @typescript-eslint/no-unused-vars */
 export function registerCompletion(
   argOrOpt: Argument | Option,

package/src/utils/web/process.ts

@@ -4,9 +4,7 @@
  * @packageDocumentation
  * @internal
  */
-/* eslint-disable @typescript-eslint/explicit-function-return-type */
-/* eslint-disable @typescript-eslint/no-empty-function */
-/* eslint-disable no-console */
+
 export const version = process.version
 export const argv = ["node", "play.ts"]
 export const execArgv = [] as any[]

package/src/validator/caporal.ts

@@ -72,7 +72,7 @@ export function validateNumericFlag(
   value: ParserTypes,
   context: Argument | Option,
 ): number {
-  const str = value + ""
+  const str = `${value}`
   if (Array.isArray(value) || !isNumeric(str)) {
     throw new ValidationError({
       value,
@@ -100,5 +100,5 @@ export function validateArrayFlag(
  * @ignore
  */
 export function validateStringFlag(value: ParserTypes | ParserTypes[]): string {
-  return value + ""
+  return `${value}`
 }

package/src/validator/regexp.ts

@@ -23,7 +23,7 @@ export function validateWithRegExp(
       return validateWithRegExp(validator, v, context) as ParserTypes
     })
   }
-  if (!validator.test(value + "")) {
+  if (!validator.test(`${value}`)) {
     throw new ValidationError({
       validator: validator,
       value,

package/src/validator/utils.ts

@@ -15,6 +15,7 @@ export function isCaporalValidator(
     return false
   }
   const mask = getCaporalValidatorsMask()
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   const exist = (mask & validator) === validator
   return exist
 }
@@ -77,7 +78,7 @@ export function getTypeHint(obj: Argument | Option): string | undefined {
   } else if (Array.isArray(obj.validator)) {
     const stringified = JSON.stringify(obj.validator)
     if (stringified.length < 300) {
-      hint = "one of " + stringified.substr(1, stringified.length - 2)
+      hint = `one of ${stringified.substr(1, stringified.length - 2)}`
     }
   }
   return hint