@thi.ng/args 2.6.4 → 2.7.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-07-10T14:20:23Z
+- **Last updated**: 2025-07-11T08:24:44Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -11,6 +11,24 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [2.7.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/args@2.7.1) (2025-07-11)
+
+#### 🩹 Bug fixes
+
+- update arg names in parse errors ([5e82c16](https://github.com/thi-ng/umbrella/commit/5e82c16))
+  - use kebab-case arg names
+
+## [2.7.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/args@2.7.0) (2025-07-10)
+
+#### 🚀 Features
+
+- add `terminalLineWidth()` helper ([e8fdd27](https://github.com/thi-ng/umbrella/commit/e8fdd27))
+- update ColorTheme and error msg output ([c2bca13](https://github.com/thi-ng/umbrella/commit/c2bca13))
+
+#### ♻️ Refactoring
+
+- simplify error handling in cliApp() ([9973cf0](https://github.com/thi-ng/umbrella/commit/9973cf0))
+
 ### [2.6.3](https://github.com/thi-ng/umbrella/tree/@thi.ng/args@2.6.3) (2025-07-09)
 
 #### 🩹 Bug fixes

package/api.d.ts

@@ -165,6 +165,7 @@ export interface UsageOpts {
 export interface ColorTheme {
     default: number;
     command: number;
+    error: number;
     hint: number;
     multi: number;
     param: number;

package/api.js

@@ -1,6 +1,7 @@
 const DEFAULT_THEME = {
   default: 95,
   command: 92,
+  error: 91,
   hint: 90,
   multi: 90,
   param: 96,

package/cli.d.ts

@@ -1,3 +1,10 @@
 import type { CLIAppConfig, CommandCtx } from "./api.js";
 export declare const cliApp: <OPTS extends object, CTX extends CommandCtx<OPTS, OPTS>>(config: CLIAppConfig<OPTS, CTX>) => Promise<void>;
+/**
+ * Calls `tput cols` to obtain the number of columns in the current
+ * terminal. Returns `fallback` in case of error.
+ *
+ * @param fallback
+ */
+export declare const terminalLineWidth: (fallback?: number) => number;
 //# sourceMappingURL=cli.d.ts.map

package/cli.js

@@ -1,6 +1,7 @@
 import { illegalArgs } from "@thi.ng/errors/illegal-arguments";
 import { StreamLogger } from "@thi.ng/logger/stream";
 import { PRESET_ANSI16, PRESET_NONE } from "@thi.ng/text-format/presets";
+import { execFileSync } from "node:child_process";
 import { parse } from "./parse.js";
 import { usage } from "./usage.js";
 import {
@@ -12,7 +13,7 @@ import {
 const cliApp = async (config) => {
   const argv = config.argv || process.argv;
   const isColor = !process.env.NO_COLOR;
-  const format = isColor ? PRESET_ANSI16 : PRESET_NONE;
+  const theme = __colorTheme(isColor);
   const usageOpts = {
     prefix: "",
     color: isColor,
@@ -38,19 +39,15 @@ const cliApp = async (config) => {
     let parsed;
     try {
       parsed = parse({ ...config.opts, ...cmd.opts }, argv, {
-        showUsage: false,
         usageOpts,
         start
       });
     } catch (e) {
-      __printError(e.message, format);
-    }
-    if (!parsed) {
-      __usageAndExit(config, usageOpts);
       process.exit(1);
     }
+    if (!parsed) process.exit(0);
     if (cmd.inputs !== void 0 && cmd.inputs !== parsed.rest.length) {
-      __printError(`expected ${cmd.inputs || 0} input(s)`, format);
+      __printError(`expected ${cmd.inputs || 0} input(s)`, theme);
       __usageAndExit(config, usageOpts);
     }
     const ctx = await config.ctx(
@@ -65,7 +62,7 @@ const cliApp = async (config) => {
     await cmd.fn(ctx);
     if (config.post) await config.post(ctx, cmd);
   } catch (e) {
-    __printError(e.message, format);
+    __printError(e.message, theme);
     process.exit(1);
   }
 };
@@ -92,7 +89,15 @@ const __descriptions = (commands, { color, lineWidth = 80 } = {}) => {
     "\n"
   ].join("\n");
 };
-const __printError = (msg, fmt) => process.stderr.write(fmt.red(msg) + "\n\n");
+const __printError = (msg, theme) => process.stderr.write(__ansi(msg, theme.error) + "\n\n");
+const terminalLineWidth = (fallback = 80) => {
+  try {
+    return +execFileSync("tput", ["cols"], { encoding: "ascii" });
+  } catch (e) {
+    return fallback;
+  }
+};
 export {
-  cliApp
+  cliApp,
+  terminalLineWidth
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/args",
-  "version": "2.6.4",
+  "version": "2.7.1",
   "description": "Declarative, functional CLI argument/options parser, value coercions, sub-commands etc.",
   "type": "module",
   "module": "./index.js",
@@ -110,5 +110,5 @@
     "tag": "cli",
     "year": 2018
   },
-  "gitHead": "56d8f088389b22192a06e9a395b5eecebf47697a\n"
+  "gitHead": "cc6ab918acdac66990d04d6751d19c573a09730d\n"
 }

package/parse.js

@@ -1,8 +1,9 @@
 import { isArray } from "@thi.ng/checks/is-array";
 import { defError } from "@thi.ng/errors/deferror";
 import { illegalArgs } from "@thi.ng/errors/illegal-arguments";
-import { camel } from "@thi.ng/strings/case";
+import { camel, kebab } from "@thi.ng/strings/case";
 import { usage } from "./usage.js";
+import { __ansi, __colorTheme } from "./utils.js";
 const ParseError = defError(() => "parse error");
 const parse = (specs, argv, opts) => {
   opts = { start: 2, showUsage: true, help: ["--help", "-h"], ...opts };
@@ -11,7 +12,10 @@ const parse = (specs, argv, opts) => {
   } catch (e) {
     if (opts.showUsage) {
       console.log(
-        e.message + "\n\n" + usage(specs, opts.usageOpts)
+        __ansi(
+          e.message,
+          __colorTheme(opts.usageOpts?.color).error
+        ) + "\n\n" + usage(specs, opts.usageOpts)
       );
     }
     throw new ParseError(e.message);
@@ -41,7 +45,7 @@ const __parseOpts = (specs, argv, opts) => {
       i++;
     }
   }
-  id && illegalArgs(`missing value for: --${id}`);
+  id && illegalArgs(`missing value for: --${kebab(id)}`);
   return {
     result: __processResults(specs, acc),
     index: i,
@@ -90,7 +94,7 @@ const __processResults = (specs, acc) => {
       if (spec.default !== void 0) {
         acc[id] = spec.default;
       } else if (spec.optional === false) {
-        illegalArgs(`missing arg: --${id}`);
+        illegalArgs(`missing arg: --${kebab(id)}`);
       }
     } else if (spec.coerce) {
       __coerceValue(spec, acc, id);
@@ -108,7 +112,7 @@ const __coerceValue = (spec, acc, id) => {
     }
     acc[id] = spec.coerce(acc[id]);
   } catch (e) {
-    throw new Error(`arg --${id}: ${e.message}`);
+    throw new Error(`arg --${kebab(id)}: ${e.message}`);
   }
 };
 export {

package/utils.d.ts

@@ -1,7 +1,7 @@
 import type { Maybe } from "@thi.ng/api";
 import { type ColorTheme } from "./api.js";
 /** @internal */
-export declare const __ansi: (x: string, col: number) => string;
+export declare const __ansi: (x: string, col?: number) => string;
 /** @internal */
 export declare const __padRightAnsi: (x: string, width: number) => string;
 /** @internal */

package/utils.js

@@ -1,9 +1,9 @@
 import { isPlainObject } from "@thi.ng/checks/is-plain-object";
+import { lengthAnsi } from "@thi.ng/strings/ansi";
+import { padRight } from "@thi.ng/strings/pad-right";
 import { repeat } from "@thi.ng/strings/repeat";
 import { SPLIT_ANSI, wordWrapLines } from "@thi.ng/strings/word-wrap";
 import { DEFAULT_THEME } from "./api.js";
-import { lengthAnsi } from "@thi.ng/strings/ansi";
-import { padRight } from "@thi.ng/strings/pad-right";
 const __ansi = (x, col) => col != null ? `\x1B[${col}m${x}\x1B[0m` : x;
 const __padRightAnsi = (x, width) => padRight(width)(x, lengthAnsi(x));
 const __wrap = (str, width) => str ? wordWrapLines(str, {
@@ -15,7 +15,7 @@ const __wrapWithIndent = (body, indent, width) => {
   const prefix = repeat(" ", indent);
   return __wrap(body, width - indent).map((l, i) => i ? prefix + l : l).join("\n");
 };
-const __colorTheme = (color) => isPlainObject(color) ? { ...DEFAULT_THEME, ...color } : color ? DEFAULT_THEME : {};
+const __colorTheme = (color) => isPlainObject(color) ? { ...DEFAULT_THEME, ...color } : color !== false ? DEFAULT_THEME : {};
 export {
   __ansi,
   __colorTheme,