gunshi 0.37.3 → 1.0.0-beta.1

package/lib/agent.d.ts

@@ -1,16 +1,11 @@
 //#region ../../node_modules/.pnpm/std-env@4.1.0/node_modules/std-env/dist/index.d.mts
 //#region src/agents.d.ts
 /**
-* Represents the name of an AI coding agent.
-*/
+ * Represents the name of an AI coding agent.
+ */
 type AgentName = (string & {}) | "cursor" | "claude" | "devin" | "replit" | "gemini" | "codex" | "auggie" | "opencode" | "kiro" | "goose" | "pi";
-/**
-* Provides information about an AI coding agent.
-*/
-
 //#endregion
 //#region src/agent.d.ts
-
 /**
  * A profile that summarizes whether the current process is running on an
  * AI coding agent.

package/lib/bone.d.ts

@@ -1,12 +1,6 @@
-import { i as Args, l as ArgToken, n as ArgSchema, r as ArgValues } from "./resolver-CbDvcwY3.js";
-import { C as NormalizeToGunshiParams, D as SubCommandable, E as RenderingOptions, O as ValidationErrorsDecorator, S as MergeGunshiExtensions, T as RendererDecorator, _ as ExtractArgs, a as CommandContext, b as GunshiParamsConstraint, c as CommandDecorator, d as CommandLoader, f as CommandRunner, g as ExtractArgExplicitlyProvided, h as ExtendContext, i as CommandCallMode, l as CommandEnvironment, m as DefaultGunshiParams, n as CliOptions, o as CommandContextCore, p as Commandable, r as Command, s as CommandContextExtension, t as Awaitable, u as CommandExamplesFetcher, v as ExtractExtensions, w as Prettify, x as LazyCommand, y as GunshiParams } from "./types-H9nag_2Z.js";
-
+import { i as Args, l as ArgToken, n as ArgSchema, r as ArgValues } from "./resolver-BezrTUr7.js";
+import { C as NormalizeToGunshiParams, D as SubCommandable, E as RenderingOptions, O as ValidationErrorsDecorator, S as MergeGunshiExtensions, T as RendererDecorator, _ as ExtractArgs, a as CommandContext, b as GunshiParamsConstraint, c as CommandDecorator, d as CommandLoader, f as CommandRunner, g as ExtractArgExplicitlyProvided, h as ExtendContext, i as CommandCallMode, l as CommandEnvironment, m as DefaultGunshiParams, n as CliOptions, o as CommandContextCore, p as Commandable, r as Command, s as CommandContextExtension, t as Awaitable, u as CommandExamplesFetcher, v as ExtractExtensions, w as Prettify, x as LazyCommand, y as GunshiParams } from "./types-lD5uzpd5.js";
 //#region src/cli/bone.d.ts
-/**
-* @author kazuya kawaguchi (a.k.a. kazupon)
-* @license MIT
-*/
-
 /**
  * Run the command.
  *
@@ -47,11 +41,4 @@ declare function cli<E extends ExtendContext = ExtendContext, G extends GunshiPa
  */
 declare function cli<G extends GunshiParams = DefaultGunshiParams>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>;
 //#endregion
-//#region src/bone.d.ts
-/**
-* @author kazuya kawaguchi (a.k.a. kazupon)
-* @license MIT
-*/
-
-//#endregion
-export { ArgSchema, ArgToken, ArgValues, Args, Awaitable, CliOptions, Command, CommandCallMode, CommandContext, CommandContextCore, CommandContextExtension, CommandDecorator, CommandEnvironment, CommandExamplesFetcher, CommandLoader, CommandRunner, Commandable, DefaultGunshiParams, ExtendContext, ExtractArgExplicitlyProvided, ExtractArgs, ExtractExtensions, GunshiParams, GunshiParamsConstraint, LazyCommand, MergeGunshiExtensions, NormalizeToGunshiParams, Prettify, RendererDecorator, RenderingOptions, SubCommandable, ValidationErrorsDecorator, cli };
+export { type ArgSchema, type ArgToken, type ArgValues, type Args, type Awaitable, type CliOptions, type Command, type CommandCallMode, type CommandContext, type CommandContextCore, type CommandContextExtension, type CommandDecorator, type CommandEnvironment, type CommandExamplesFetcher, type CommandLoader, type CommandRunner, type Commandable, type DefaultGunshiParams, type ExtendContext, type ExtractArgExplicitlyProvided, type ExtractArgs, type ExtractExtensions, type GunshiParams, type GunshiParamsConstraint, type LazyCommand, type MergeGunshiExtensions, type NormalizeToGunshiParams, type Prettify, type RendererDecorator, type RenderingOptions, type SubCommandable, type ValidationErrorsDecorator, cli };

package/lib/bone.js

@@ -1,4 +1,4 @@
-import { t as cliCore } from "./core-CLzX86kY.js";
+import { t as cliCore } from "./core-C-EvVI4v.js";
 //#region src/cli/bone.ts
 /**
 * @author kazuya kawaguchi (a.k.a. kazupon)

package/lib/{cli-BnmSo-DW.js → builtin-CMCjNe-j.js}

@@ -1,7 +1,7 @@
-import { r as hasPriorityValidationError } from "./error-B5QxSzk9.js";
-import { t as plugin } from "./plugin-DneW3Toi.js";
-import { a as namespacedId, o as COMMON_ARGS, t as renderer } from "./src-80_afJQM.js";
-import { t as cliCore } from "./core-CLzX86kY.js";
+import { a as hasPriorityValidationError } from "./error-wB83kWiv.js";
+import { t as plugin } from "./plugin-CG94VzCl.js";
+import { a as namespacedId, o as COMMON_ARGS, t as renderer } from "./src-BI37Q7Wx.js";
+import { t as cliCore } from "./core-C-EvVI4v.js";
 //#region ../plugin-global/src/types.ts
 /**
 * @author kazuya kawaguchi (a.k.a. kazupon)
@@ -24,16 +24,21 @@ const pluginId = namespacedId("global");
 * @returns A command decorator that adds global options handling
 */
 const decorator = (baseRunner) => async (ctx) => {
-	const { values, validationError, extensions: { [pluginId]: { showVersion, showHeader, showUsage, showValidationErrors } } } = ctx;
+	/**
+	* NOTE(kazupon): the core puts the globals still in effect on `env.globalOptions`. A command that
+	* declares the same name — even with an identical schema — is not in that map, so `--version` /
+	* `--help` belong to the command.
+	*/
+	const { values, validationError, env: { globalOptions }, extensions: { [pluginId]: { showVersion, showHeader, showUsage, showValidationErrors } } } = ctx;
 	if (hasPriorityValidationError(validationError)) {
 		await showValidationErrors(validationError);
 		throw validationError;
 	}
-	if (values.version) return showVersion();
+	if (values.version && globalOptions?.has("version")) return showVersion();
 	const buf = [];
 	const header = await showHeader();
 	if (header) buf.push(header);
-	if (values.help) {
+	if (values.help && globalOptions?.has("help")) {
 		const usage = await showUsage();
 		if (usage) {
 			buf.push(usage);
@@ -160,14 +165,29 @@ function global() {
 * @returns A rendered usage or undefined. if you will use {@linkcode CliOptions.usageSilent} option, it will return rendered usage string.
 */
 async function cli(args, entry, options = {}) {
-	const builtInPlugins = [global(), renderer()];
-	return cliCore(args, entry, options, builtInPlugins);
+	return cliCore(args, entry, options, createBuiltInPlugins());
 }
-//#endregion
-//#region src/cli.ts
 /**
-* @author kazuya kawaguchi (a.k.a. kazupon)
-* @license MIT
+* Render the usage of a command, without running it.
+*
+* This is what `generate` of `gunshi/generator` is made of. It resolves the command the same way
+* {@linkcode cli} does, with the same built-in plugins, and renders the usage of the command it
+* arrives at, whatever that command declares as its own arguments.
+*
+* @internal
+*
+* @typeParam G - A type extending {@linkcode GunshiParams} to specify the shape of command and cli options.
+*
+* @param args - Command line arguments, which name the command to render
+* @param entry - A {@link Command | entry command}, an {@link CommandRunner | inline command runner}, or a {@link LazyCommand | lazily-loaded command}
+* @param options - A {@link CliOptions | CLI options}
+* @returns A rendered usage, or `undefined` if there is no usage renderer to render it
 */
+async function cliUsage(args, entry, options = {}) {
+	return cliCore(args, entry, options, createBuiltInPlugins(), true);
+}
+function createBuiltInPlugins() {
+	return [global(), renderer()];
+}
 //#endregion
-export { cli as t };
+export { cliUsage as n, cli as t };