@thi.ng/args 2.8.6 → 2.9.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-08-04T09:13:01Z
+- **Last updated**: 2025-08-06T18:02:31Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -11,6 +11,16 @@ 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.9.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/args@2.9.0) (2025-08-06)
+
+#### 🚀 Features
+
+- add arg preset specs ([2b13af5](https://github.com/thi-ng/umbrella/commit/2b13af5))
+  - add ARG_DRY_RUN
+  - add ARG_QUIET, ARG_VERBOSE
+  - add ARG_OUT_DIR, ARG_OUT_FILE
+- add configureLogLevel() ([ea5c6e4](https://github.com/thi-ng/umbrella/commit/ea5c6e4))
+
 ## [2.8.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/args@2.8.0) (2025-07-12)
 
 #### 🚀 Features

package/README.md

@@ -72,7 +72,7 @@ For Node.js REPL:
 const args = await import("@thi.ng/args");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 3.06 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 3.29 KB
 
 ## Dependencies
 

package/args.d.ts

@@ -249,4 +249,74 @@ export declare const vec: <S extends Partial<ArgSpec<Tuple<number>>>>(size: numb
     hint: string;
     group: string;
 };
+/**
+ * Re-usable preset arg spec for a `--dry-run` flag.
+ */
+export declare const ARG_DRY_RUN: {
+    dryRun: {
+        desc: string;
+    } & {
+        flag: true;
+        default: boolean;
+        group: string;
+    };
+};
+/**
+ * Re-usable preset arg spec for a `--quiet` / `-q` flag.
+ */
+export declare const ARG_QUIET: {
+    quiet: {
+        alias: string;
+        desc: string;
+    } & {
+        flag: true;
+        default: boolean;
+        group: string;
+    };
+};
+/**
+ * Re-usable preset arg spec for a `--verbose` / `-v` flag.
+ */
+export declare const ARG_VERBOSE: {
+    verbose: {
+        alias: string;
+        desc: string;
+    } & {
+        flag: true;
+        default: boolean;
+        group: string;
+    };
+};
+/**
+ * Higher-order re-usable preset arg spec for a `--out-dir` / `-O` arg. Accepts
+ * optional default value (e.g. sourced from an env var). If the the
+ * `defaultVal` is defined, the arg is declared as optional, otherwise
+ * mandatory.
+ *
+ * @param defaultVal
+ * @param desc
+ */
+export declare const ARG_OUT_DIR: <T extends string | undefined>(defaultVal?: string, desc?: string) => {
+    outDir: ReturnType<typeof string> & (T extends string ? {
+        default: string;
+    } : {
+        optional: false;
+    });
+};
+/**
+ * Higher-order re-usable preset arg spec for a `--out-file` / `-o` arg. Accepts
+ * optional default value (e.g. sourced from an env var). If the the
+ * `defaultVal` is defined, the arg is declared as optional, otherwise
+ * mandatory.
+ *
+ * @param defaultVal
+ * @param desc
+ */
+export declare const ARG_OUT_FILE: <T extends string | undefined>(defaultVal?: T, desc?: string) => {
+    outFile: ReturnType<typeof string> & (T extends string ? {
+        default: string;
+    } : {
+        optional: false;
+    });
+};
 //# sourceMappingURL=args.d.ts.map

package/args.js

@@ -84,7 +84,47 @@ const tuple = (coerce, size2, spec, delim = ",") => ({
 });
 const size = (size2, spec, delim = "x") => tuple(coerceInt, size2, spec, delim);
 const vec = (size2, spec, delim = ",") => tuple(coerceFloat, size2, spec, delim);
+const ARG_DRY_RUN = {
+  dryRun: flag({
+    desc: "Dry run (no changes applied)"
+  })
+};
+const ARG_QUIET = {
+  quiet: flag({
+    alias: "q",
+    desc: "Disable all logging"
+  })
+};
+const ARG_VERBOSE = {
+  verbose: flag({
+    alias: "v",
+    desc: "Display extra information"
+  })
+};
+const ARG_OUT_DIR = (defaultVal, desc) => ({
+  outDir: string({
+    alias: "O",
+    desc: "Output directory" + (desc ?? ""),
+    hint: "PATH",
+    default: defaultVal,
+    optional: !!defaultVal
+  })
+});
+const ARG_OUT_FILE = (defaultVal, desc) => ({
+  outFile: string({
+    alias: "o",
+    desc: "Output file" + (desc ?? ""),
+    hint: "PATH",
+    default: defaultVal,
+    optional: !!defaultVal
+  })
+});
 export {
+  ARG_DRY_RUN,
+  ARG_OUT_DIR,
+  ARG_OUT_FILE,
+  ARG_QUIET,
+  ARG_VERBOSE,
   flag,
   float,
   floats,

package/cli.d.ts

@@ -1,3 +1,4 @@
+import { type ILogger } from "@thi.ng/logger/api";
 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>;
 /**
@@ -7,4 +8,5 @@ export declare const cliApp: <OPTS extends object, CTX extends CommandCtx<OPTS,
  * @param fallback
  */
 export declare const terminalLineWidth: (fallback?: number) => number;
+export declare const configureLogLevel: (logger: ILogger, verbose: boolean, quiet?: boolean) => void;
 //# sourceMappingURL=cli.d.ts.map

package/cli.js

@@ -1,5 +1,6 @@
 import { isArray } from "@thi.ng/checks/is-array";
 import { illegalArgs } from "@thi.ng/errors/illegal-arguments";
+import { LogLevel } from "@thi.ng/logger/api";
 import { StreamLogger } from "@thi.ng/logger/stream";
 import { PRESET_ANSI16, PRESET_NONE } from "@thi.ng/text-format/presets";
 import { execFileSync } from "node:child_process";
@@ -110,7 +111,12 @@ const terminalLineWidth = (fallback = 80) => {
     return fallback;
   }
 };
+const configureLogLevel = (logger, verbose, quiet = false) => {
+  if (quiet) logger.level = LogLevel.NONE;
+  else if (verbose) logger.level = LogLevel.DEBUG;
+};
 export {
   cliApp,
+  configureLogLevel,
   terminalLineWidth
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/args",
-  "version": "2.8.6",
+  "version": "2.9.0",
   "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": "0bcedf8d1dd4f30cd06bb2c668599628f2f0141e\n"
+  "gitHead": "03e0d1024805407fbec5dde688b6178bbe0a2f3a\n"
 }