@gunshi/bone 0.28.2 → 0.29.0

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-//#region ../../node_modules/.pnpm/args-tokens@0.23.1/node_modules/args-tokens/lib/parser.d.ts
+//#region ../../node_modules/.pnpm/args-tokens@0.24.1/node_modules/args-tokens/lib/parser-DH5KtXsI.d.ts
 //#region src/parser.d.ts
 /**
  * Entry point of argument parser.
@@ -55,7 +55,7 @@ interface ArgToken {
  * Parser Options.
  */
 //#endregion
-//#region ../../node_modules/.pnpm/args-tokens@0.23.1/node_modules/args-tokens/lib/resolver.d.ts
+//#region ../../node_modules/.pnpm/args-tokens@0.24.1/node_modules/args-tokens/lib/resolver.d.ts
 //#region src/resolver.d.ts
 /**
  * An argument schema definition for command-line argument parsing.
@@ -190,7 +190,7 @@ interface ArgSchema {
    * }
    * ```
    */
-  required?: true;
+  required?: boolean;
   /**
    * Allows the argument to accept multiple values.
    *
@@ -417,6 +417,28 @@ interface ArgSchema {
    * ```
    */
   conflicts?: string | string[];
+  /**
+   * Display name hint for help text generation.
+   *
+   * Provides a meaningful type hint for the argument value in help output.
+   * Particularly useful for `type: 'custom'` arguments where the type
+   * name would otherwise be unhelpful.
+   *
+   * @example
+   * Metavar usage:
+   * ```ts
+   * {
+   *   port: {
+   *     type: 'custom',
+   *     parse: (v: string) => parseInt(v, 10),
+   *     metavar: 'integer',
+   *     description: 'Port number (1-65535)'
+   *   }
+   * }
+   * // Help output: --port <integer>  Port number (1-65535)
+   * ```
+   */
+  metavar?: string;
   /**
    * Custom parsing function for `type: 'custom'` arguments.
    *
@@ -475,7 +497,6 @@ interface Args {
 type ArgValues<T> = T extends Args ? ResolveArgValues<T, { [Arg in keyof T]: ExtractOptionValue<T[Arg]> }> : {
   [option: string]: string | boolean | number | (string | boolean | number)[] | undefined;
 };
-type IsFunction<T> = T extends ((...args: any[]) => any) ? true : false;
 /**
  * Extracts the value type from the argument schema.
  *
@@ -483,7 +504,7 @@ type IsFunction<T> = T extends ((...args: any[]) => any) ? true : false;
  *
  * @internal
  */
-type ExtractOptionValue<A extends ArgSchema> = A['type'] extends 'string' ? ResolveOptionValue<A, string> : A['type'] extends 'boolean' ? ResolveOptionValue<A, boolean> : A['type'] extends 'number' ? ResolveOptionValue<A, number> : A['type'] extends 'positional' ? ResolveOptionValue<A, string> : A['type'] extends 'enum' ? A['choices'] extends string[] | readonly string[] ? ResolveOptionValue<A, A['choices'][number]> : never : A['type'] extends 'custom' ? IsFunction<A['parse']> extends true ? ResolveOptionValue<A, ReturnType<NonNullable<A['parse']>>> : never : ResolveOptionValue<A, string | boolean | number>;
+type ExtractOptionValue<A extends ArgSchema> = undefined extends A['parse'] ? A['type'] extends 'string' ? ResolveOptionValue<A, string> : A['type'] extends 'boolean' ? ResolveOptionValue<A, boolean> : A['type'] extends 'number' ? ResolveOptionValue<A, number> : A['type'] extends 'positional' ? ResolveOptionValue<A, string> : A['type'] extends 'enum' ? A['choices'] extends string[] | readonly string[] ? ResolveOptionValue<A, A['choices'][number]> : never : A['type'] extends 'custom' ? never : ResolveOptionValue<A, string | boolean | number> : A['parse'] extends ((value: string) => infer R) ? ResolveOptionValue<A, R> : never;
 type ResolveOptionValue<A extends ArgSchema, T> = A['multiple'] extends true ? T[] : T;
 /**
  * Resolved argument values.
@@ -503,7 +524,7 @@ type ResolveArgValues<A extends Args, V extends Record<keyof A, unknown>> = { -r
  *
  * @internal
  */
-type FilterArgs<A extends Args, V extends Record<keyof A, unknown>, K extends keyof ArgSchema> = { [Arg in keyof A as A[Arg][K] extends {} ? Arg : never]: V[Arg] };
+type FilterArgs<A extends Args, V extends Record<keyof A, unknown>, K extends keyof ArgSchema> = { [Arg in keyof A as K extends 'required' ? A[Arg][K] extends true ? Arg : never : A[Arg][K] extends {} ? Arg : never]: V[Arg] };
 /**
  * Filters positional arguments from the argument schema.
  *

package/lib/index.js

@@ -1,4 +1,4 @@
-//#region ../../node_modules/.pnpm/args-tokens@0.23.1/node_modules/args-tokens/lib/parser.js
+//#region ../../node_modules/.pnpm/args-tokens@0.24.1/node_modules/args-tokens/lib/parser.js
 const HYPHEN_CHAR = "-";
 const HYPHEN_CODE = HYPHEN_CHAR.codePointAt(0);
 const EQUAL_CHAR = "=";
@@ -196,7 +196,7 @@ function hasOptionValue(value) {
 }
 
 //#endregion
-//#region ../../node_modules/.pnpm/args-tokens@0.23.1/node_modules/args-tokens/lib/utils-CxvkckUD.js
+//#region ../../node_modules/.pnpm/args-tokens@0.24.1/node_modules/args-tokens/lib/utils-CxvkckUD.js
 /**
 * Entry point of utils.
 *
@@ -219,7 +219,7 @@ function kebabnize(str) {
 }
 
 //#endregion
-//#region ../../node_modules/.pnpm/args-tokens@0.23.1/node_modules/args-tokens/lib/resolver.js
+//#region ../../node_modules/.pnpm/args-tokens@0.24.1/node_modules/args-tokens/lib/resolver.js
 /**
 * Entry point of argument options resolver.
 *
@@ -305,13 +305,15 @@ function resolveArgs(args, tokens, { shortGrouping = false, skipPositional = SKI
 				rest.push(token.value);
 				continue;
 			}
-			if (currentShortOption) {
-				if (schemas.find((schema) => schema.short === currentShortOption.name && schema.type === "boolean")) positionalTokens.push({ ...token });
-			} else if (currentLongOption) {
-				if (args[currentLongOption.name]?.type === "boolean") positionalTokens.push({ ...token });
-			} else positionalTokens.push({ ...token });
-			applyLongOptionValue(token.value);
-			applyShortOptionValue(token.value);
+			if (currentShortOption) if (schemas.find((schema) => schema.short === currentShortOption.name && schema.type === "boolean")) {
+				positionalTokens.push({ ...token });
+				applyShortOptionValue();
+			} else applyShortOptionValue(token.value);
+			else if (currentLongOption) if (args[currentLongOption.name]?.type === "boolean") {
+				positionalTokens.push({ ...token });
+				applyLongOptionValue();
+			} else applyLongOptionValue(token.value);
+			else positionalTokens.push({ ...token });
 		} else if (token.kind === "option") if (token.rawName) {
 			if (hasLongOptionPrefix(token.rawName)) {
 				applyLongOptionValue();
@@ -376,14 +378,27 @@ function resolveArgs(args, tokens, { shortGrouping = false, skipPositional = SKI
 			if (schema.multiple) {
 				const remainingPositionals = positionalTokens.slice(positionalsCount);
 				if (remainingPositionals.length > 0) {
-					values[rawArg] = remainingPositionals.map((p) => p.value);
+					if (typeof schema.parse === "function") {
+						const parsed = [];
+						for (const p of remainingPositionals) try {
+							parsed.push(schema.parse(p.value));
+						} catch (error) {
+							errors.push(error);
+						}
+						values[rawArg] = parsed;
+					} else values[rawArg] = remainingPositionals.map((p) => p.value);
 					positionalsCount += remainingPositionals.length;
 					explicit[rawArg] = true;
 				} else if (schema.required) errors.push(createRequireError(arg, schema));
 			} else {
 				const positional = positionalTokens[positionalsCount];
 				if (positional != null) {
-					values[rawArg] = positional.value;
+					if (typeof schema.parse === "function") try {
+						values[rawArg] = schema.parse(positional.value);
+					} catch (error) {
+						errors.push(error);
+					}
+					else values[rawArg] = positional.value;
 					explicit[rawArg] = true;
 				} else errors.push(createRequireError(arg, schema));
 				positionalsCount++;
@@ -409,7 +424,6 @@ function resolveArgs(args, tokens, { shortGrouping = false, skipPositional = SKI
 				explicit[rawArg] = true;
 				const actualInputName = isShortOption(token.rawName) ? `-${token.name}` : `--${arg}`;
 				actualInputNames.set(rawArg, actualInputName);
-				if (schema.type === "boolean") token.value = void 0;
 				const [parsedValue, error] = parse(token, arg, schema);
 				if (error) errors.push(error);
 				else if (schema.multiple) {
@@ -431,22 +445,25 @@ function resolveArgs(args, tokens, { shortGrouping = false, skipPositional = SKI
 	};
 }
 function parse(token, option, schema) {
+	if (typeof schema.parse === "function") try {
+		if (schema.type === "boolean") {
+			const boolValue = !(schema.negatable && token.name.startsWith("no-"));
+			return [schema.parse(String(boolValue)), void 0];
+		}
+		return [schema.parse(token.value ?? String(schema.default ?? "")), void 0];
+	} catch (error) {
+		return [void 0, error];
+	}
 	switch (schema.type) {
 		case "string": return typeof token.value === "string" ? [token.value || schema.default, void 0] : [void 0, createTypeError(option, schema)];
-		case "boolean": return token.value ? [token.value || schema.default, void 0] : [!(schema.negatable && token.name.startsWith("no-")), void 0];
+		case "boolean": return [!(schema.negatable && token.name.startsWith("no-")), void 0];
 		case "number":
 			if (!isNumeric(token.value)) return [void 0, createTypeError(option, schema)];
 			return token.value ? [+token.value, void 0] : [+(schema.default || ""), void 0];
 		case "enum":
 			if (schema.choices && !schema.choices.includes(token.value)) return [void 0, new ArgResolveError(`Optional argument '--${option}' ${schema.short ? `or '-${schema.short}' ` : ""}should be chosen from '${schema.type}' [${schema.choices.map((c) => JSON.stringify(c)).join(", ")}] values`, option, "type", schema)];
 			return [token.value || schema.default, void 0];
-		case "custom":
-			if (typeof schema.parse !== "function") throw new TypeError(`argument '${option}' should have a 'parse' function`);
-			try {
-				return [schema.parse(token.value || String(schema.default || "")), void 0];
-			} catch (error) {
-				return [void 0, error];
-			}
+		case "custom": throw new TypeError(`argument '${option}' should have a 'parse' function`);
 		default: throw new Error(`Unsupported argument type '${schema.type}' for option '${option}'`);
 	}
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/bone",
   "description": "gunshi minimum",
-  "version": "0.28.2",
+  "version": "0.29.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -56,10 +56,10 @@
     "jsr-exports-lint": "^0.4.1",
     "publint": "^0.3.16",
     "tsdown": "0.15.12",
-    "@gunshi/plugin-global": "0.28.2",
-    "@gunshi/definition": "0.28.2",
-    "gunshi": "0.28.2",
-    "@gunshi/plugin-renderer": "0.28.2"
+    "@gunshi/definition": "0.29.0",
+    "gunshi": "0.29.0",
+    "@gunshi/plugin-global": "0.29.0",
+    "@gunshi/plugin-renderer": "0.29.0"
   },
   "scripts": {
     "build": "tsdown",