gunshi 0.14.5 → 0.15.0

package/lib/{cli-JT5dcEoE.js → cli--6qYDY8U.js}

@@ -1,4 +1,4 @@
-import { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE$1 as DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, renderHeader, renderUsage, renderValidationErrors, resolveLazyCommand, resolveOptionKey } from "./renderer-DGPRTLmr.js";
+import { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE$1 as DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, renderHeader, renderUsage, renderValidationErrors, resolveLazyCommand, resolveOptionKey } from "./renderer-BeuJazdk.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/locales/en-US.json
@@ -9,6 +9,7 @@ var USAGE = "USAGE";
 var OPTIONS = "OPTIONS";
 var EXAMPLES = "EXAMPLES";
 var FORMORE = "For more info, run any command with the `--help` flag:";
+var NEGATABLE = "Negatable of";
 var help = "Display this help message";
 var version = "Display this version";
 var en_US_default = {
@@ -19,6 +20,7 @@ var en_US_default = {
 	OPTIONS,
 	EXAMPLES,
 	FORMORE,
+	NEGATABLE,
 	help,
 	version
 };
@@ -60,7 +62,7 @@ var DefaultTranslation = class {
 //#endregion
 //#region src/context.ts
 const BUILT_IN_PREFIX_CODE = BUILT_IN_PREFIX.codePointAt(0);
-async function createCommandContext({ options, values, positionals, args, tokens, command, commandOptions, omitted = false }) {
+async function createCommandContext({ options, values, positionals, rest, args, tokens, command, commandOptions, omitted = false }) {
 	/**
 	* normailize the options schema and values, to avoid prototype pollution
 	*/
@@ -121,6 +123,7 @@ async function createCommandContext({ options, values, positionals, args, tokens
 		options: _options,
 		values,
 		positionals,
+		rest,
 		_: args,
 		tokens,
 		log: commandOptions.usageSilent ? NOOP : log,
@@ -175,12 +178,16 @@ async function cli(args, entry, opts = {}) {
 	const [name, command] = await resolveCommand(subCommand, entry, resolvedCommandOptions);
 	if (!command) throw new Error(`Command not found: ${name || ""}`);
 	const options = resolveArgOptions(command.options);
-	const { values, positionals, error } = resolveArgs(options, tokens);
+	const { values, positionals, rest, error } = resolveArgs(options, tokens, {
+		optionGrouping: true,
+		allowNegative: true
+	});
 	const omitted = !subCommand;
 	const ctx = await createCommandContext({
 		options,
 		values,
 		positionals,
+		rest,
 		args,
 		tokens,
 		omitted,

package/lib/{definition.d-TBObezo_.d.ts → definition.d-DD_GraLw.d.ts}

@@ -1,4 +1,4 @@
-import { Command } from "./types.d-GVRYnEFw.js";
+import { Command } from "./types.d-zAq1WIpD.js";
 import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues as ArgValues$1 } from "args-tokens";
 
 //#region src/definition.d.ts

package/lib/definition.d.ts

@@ -1,4 +1,4 @@
-import "./types.d-GVRYnEFw.js";
-import { ArgOptionSchema, ArgOptions, ArgValues, define$1 as define } from "./definition.d-TBObezo_.js";
+import "./types.d-zAq1WIpD.js";
+import { ArgOptionSchema, ArgOptions, ArgValues, define$1 as define } from "./definition.d-DD_GraLw.js";
 
 export { ArgOptionSchema, ArgOptions, ArgValues, define };

package/lib/generator.d.ts

@@ -1,4 +1,4 @@
-import { Command, CommandOptions } from "./types.d-GVRYnEFw.js";
+import { Command, CommandOptions } from "./types.d-zAq1WIpD.js";
 import { ArgOptions } from "args-tokens";
 
 //#region src/generator.d.ts

package/lib/generator.js

@@ -1,5 +1,5 @@
-import { create } from "./renderer-DGPRTLmr.js";
-import { cli } from "./cli-JT5dcEoE.js";
+import { create } from "./renderer-BeuJazdk.js";
+import { cli } from "./cli--6qYDY8U.js";
 
 //#region src/generator.ts
 async function generate(command, entry, opts = {}) {

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-import { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types.d-GVRYnEFw.js";
-import { define$1 as define } from "./definition.d-TBObezo_.js";
+import { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types.d-zAq1WIpD.js";
+import { define$1 as define } from "./definition.d-DD_GraLw.js";
 import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues, parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/cli.d.ts
@@ -24,4 +24,4 @@ declare class DefaultTranslation implements TranslationAdapter {
 }
 
 //#endregion
-export { ArgOptionSchema, ArgOptions, ArgValues, Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, DefaultTranslation, GenerateNamespacedKey, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions, cli, define, parseArgs, resolveArgs };
+export { ArgOptionSchema, ArgOptions, ArgValues, Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, DefaultTranslation, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions, cli, define, parseArgs, resolveArgs };

package/lib/index.js

@@ -1,6 +1,6 @@
 import { define } from "./definition-BAm6f1St.js";
-import { DEFAULT_LOCALE$1 as DEFAULT_LOCALE } from "./renderer-DGPRTLmr.js";
-import { DefaultTranslation, cli } from "./cli-JT5dcEoE.js";
+import { DEFAULT_LOCALE$1 as DEFAULT_LOCALE } from "./renderer-BeuJazdk.js";
+import { DefaultTranslation, cli } from "./cli--6qYDY8U.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 export { DEFAULT_LOCALE, DefaultTranslation, cli, define, parseArgs, resolveArgs };

package/lib/locales/en-US.json

@@ -6,6 +6,7 @@
   "OPTIONS": "OPTIONS",
   "EXAMPLES": "EXAMPLES",
   "FORMORE": "For more info, run any command with the `--help` flag:",
+  "NEGATABLE": "Negatable of",
   "help": "Display this help message",
   "version": "Display this version"
 }

package/lib/locales/ja-JP.json

@@ -6,6 +6,7 @@
   "OPTIONS": "オプション",
   "EXAMPLES": "例",
   "FORMORE": "詳細は、コマンドと`--help`フラグを実行してください:",
+  "NEGATABLE": "否定可能な",
   "help": "このヘルプメッセージを表示",
   "version": "このバージョンを表示"
 }

package/lib/{renderer-DGPRTLmr.js → renderer-BeuJazdk.js}

@@ -224,6 +224,11 @@ function hasAllDefaultOptions(ctx) {
 function generateOptionsSymbols(ctx) {
 	return hasOptions(ctx) ? hasAllDefaultOptions(ctx) ? `[${ctx.translate(resolveBuiltInKey("OPTIONS"))}]` : `<${ctx.translate(resolveBuiltInKey("OPTIONS"))}>` : "";
 }
+function makeShortLongOptionPair(schema, name) {
+	let key = `--${name}`;
+	if (schema.short) key = `-${schema.short}, ${key}`;
+	return key;
+}
 /**
 * Get options pairs for usage
 * @param ctx A {@link CommandContext | command context}
@@ -231,13 +236,17 @@ function generateOptionsSymbols(ctx) {
 */
 function getOptionsPairs(ctx) {
 	return Object.entries(ctx.options).reduce((acc, [name, value]) => {
-		let key = `--${name}`;
-		if (value.short) key = `-${value.short}, ${key}`;
+		let key = makeShortLongOptionPair(value, name);
 		if (value.type !== "boolean") key = value.default ? `${key} [${name}]` : `${key} <${name}>`;
 		acc[name] = key;
+		if (value.type === "boolean" && !(name === "help" || name === "version")) acc[`no-${name}`] = `--no-${name}`;
 		return acc;
 	}, create());
 }
+const resolveNegatableKey = (key) => key.split("no-")[1];
+function resolveNegatableType(key, ctx) {
+	return ctx.options[key.startsWith("no-") ? resolveNegatableKey(key) : key].type;
+}
 /**
 * Generate options usage
 * @param ctx A {@link CommandContext | command context}
@@ -246,10 +255,16 @@ function getOptionsPairs(ctx) {
 */
 async function generateOptionsUsage(ctx, optionsPairs) {
 	const optionsMaxLength = Math.max(...Object.entries(optionsPairs).map(([_, value]) => value.length));
-	const optionSchemaMaxLength = ctx.env.usageOptionType ? Math.max(...Object.entries(optionsPairs).map(([key, _]) => ctx.options[key].type.length)) : 0;
+	const optionSchemaMaxLength = ctx.env.usageOptionType ? Math.max(...Object.entries(optionsPairs).map(([key, _]) => resolveNegatableType(key, ctx).length)) : 0;
 	const usages = await Promise.all(Object.entries(optionsPairs).map(([key, value]) => {
-		const rawDesc = ctx.translate(resolveOptionKey(key));
-		const optionsSchema = ctx.env.usageOptionType ? `[${ctx.options[key].type}] ` : "";
+		let rawDesc = ctx.translate(resolveOptionKey(key));
+		if (!rawDesc && key.startsWith("no-")) {
+			const name = resolveNegatableKey(key);
+			const schema = ctx.options[name];
+			const optionKey = makeShortLongOptionPair(schema, name);
+			rawDesc = `${ctx.translate(resolveBuiltInKey("NEGATABLE"))} ${optionKey}`;
+		}
+		const optionsSchema = ctx.env.usageOptionType ? `[${resolveNegatableType(key, ctx)}] ` : "";
 		const desc = `${optionsSchema ? optionsSchema.padEnd(optionSchemaMaxLength + 3) : ""}${rawDesc}`;
 		const option = `${value.padEnd(optionsMaxLength + ctx.env.middleMargin)}${desc}`;
 		return `${option.padStart(ctx.env.leftMargin + option.length)}`;

package/lib/renderer.d.ts

@@ -1,4 +1,4 @@
-import { CommandContext } from "./types.d-GVRYnEFw.js";
+import { CommandContext } from "./types.d-zAq1WIpD.js";
 import { ArgOptions } from "args-tokens";
 
 //#region src/renderer/header.d.ts

package/lib/renderer.js

@@ -1,3 +1,3 @@
-import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-DGPRTLmr.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-BeuJazdk.js";
 
 export { renderHeader, renderUsage, renderValidationErrors };

package/lib/{types.d-GVRYnEFw.d.ts → types.d-zAq1WIpD.d.ts}

@@ -32,7 +32,7 @@ type CommonOptionType = {
 };
 declare const COMMON_OPTIONS: CommonOptionType;
 declare const COMMAND_OPTIONS_DEFAULT: CommandOptions<ArgOptions>;
-declare const COMMAND_BUILTIN_RESOURCE_KEYS: readonly ["USAGE", "COMMAND", "SUBCOMMAND", "COMMANDS", "OPTIONS", "EXAMPLES", "FORMORE"];
+declare const COMMAND_BUILTIN_RESOURCE_KEYS: readonly ["USAGE", "COMMAND", "SUBCOMMAND", "COMMANDS", "OPTIONS", "EXAMPLES", "FORMORE", "NEGATABLE"];
 
 //#endregion
 //#region src/types.d.ts
@@ -46,6 +46,9 @@ type RemoveIndexSignature<T> = {
 type RemovedIndex<T> = RemoveIndexSignature<{
     [K in keyof T]: T[K];
 }>;
+type KeyOfArgOptions<Options extends ArgOptions> = keyof Options | {
+    [K in keyof Options]: Options[K]['type'] extends 'boolean' ? `no-${Extract<K, string>}` : never;
+}[keyof Options];
 /**
  * Generate a namespaced key.
  */
@@ -67,7 +70,7 @@ type CommandBuiltinKeys = GenerateNamespacedKey<CommandBuiltinOptionsKeys> | Gen
  * Command i18n option keys.
  * The command i18n option keys are used to {@link CommandContext.translate | translate} function.
  */
-type CommandOptionKeys<Options extends ArgOptions> = GenerateNamespacedKey<keyof RemovedIndex<Options>, typeof OPTION_PREFIX>;
+type CommandOptionKeys<Options extends ArgOptions> = GenerateNamespacedKey<KeyOfArgOptions<RemovedIndex<Options>>, typeof OPTION_PREFIX>;
 /**
  * Command environment.
  */
@@ -236,6 +239,10 @@ interface CommandContext<Options extends ArgOptions = ArgOptions, Values = ArgVa
      * Resolve positionals with `resolveArgs` from command arguments.
      */
     positionals: string[];
+    /**
+     * Command rest arguments, that is the remaining argument not resolved by the optional command option delimiter `--`.
+     */
+    rest: string[];
     /**
      * Original command line arguments.
      * This argument is passed from `cli` function.
@@ -316,7 +323,7 @@ type CommandResource<Options extends ArgOptions = ArgOptions> = {
      */
     examples: string;
 } & {
-    [Option in GenerateNamespacedKey<keyof RemovedIndex<Options>, typeof OPTION_PREFIX>]: string;
+    [Option in GenerateNamespacedKey<KeyOfArgOptions<RemovedIndex<Options>>, typeof OPTION_PREFIX>]: string;
 } & {
     [key: string]: string;
 };
@@ -393,4 +400,4 @@ type LazyCommand<Options extends ArgOptions = ArgOptions> = () => Awaitable<Comm
 type Commandable<Options extends ArgOptions> = Command<Options> | LazyCommand<Options>;
 
 //#endregion
-export { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions };
+export { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gunshi",
   "description": "Modern javascript command-line library",
-  "version": "0.14.5",
+  "version": "0.15.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -71,7 +71,7 @@
     }
   },
   "dependencies": {
-    "args-tokens": "^0.14.0"
+    "args-tokens": "^0.15.1"
   },
   "devDependencies": {
     "@eslint/markdown": "^6.3.0",
@@ -100,7 +100,7 @@
     "knip": "^5.50.2",
     "lint-staged": "^15.5.0",
     "messageformat": "4.0.0-10",
-    "pkg-pr-new": "^0.0.42",
+    "pkg-pr-new": "^0.0.43",
     "prettier": "^3.5.3",
     "publint": "^0.3.11",
     "tsdown": "^0.9.1",
@@ -153,7 +153,7 @@
     "lint:knip": "knip",
     "lint:prettier": "prettier . --check",
     "release": "bumpp --commit \"release: v%s\" --all --push --tag",
-    "test": "vitest run",
+    "test": "vitest --typecheck run",
     "typecheck": "pnpm run --stream --color \"/^typecheck:/\"",
     "typecheck:deno": "deno check --all ./src",
     "typecheck:tsc": "tsc --noEmit"