gunshi 0.15.0 → 0.16.0

package/lib/cli-B7eqtqBF.js

@@ -0,0 +1,109 @@
+import { COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, create, resolveLazyCommand } from "./utils-BYPzZy9X.js";
+import { createCommandContext } from "./context-BROXRnNP.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-BNorS8VG.js";
+import { parseArgs, resolveArgs } from "args-tokens";
+
+//#region src/cli.ts
+/**
+* Run the command.
+* @param args Command line arguments
+* @param entry A {@link Command | entry command} or an {@link CommandRunner | inline command runner}
+* @param opts A {@link CommandOptions | command options}
+* @returns A rendered usage or undefined. if you will use {@link CommandOptions.usageSilent} option, it will return rendered usage string.
+*/
+async function cli(args, entry, opts = {}) {
+	const tokens = parseArgs(args);
+	const subCommand = getSubCommand(tokens);
+	const resolvedCommandOptions = resolveCommandOptions(opts, entry);
+	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, rest, error } = resolveArgs(options, tokens, {
+		optionGrouping: true,
+		allowNegative: true
+	});
+	const omitted = !subCommand;
+	const ctx = await createCommandContext({
+		options,
+		values,
+		positionals,
+		rest,
+		args,
+		tokens,
+		omitted,
+		command,
+		commandOptions: resolvedCommandOptions
+	});
+	if (values.version) {
+		showVersion(ctx);
+		return;
+	}
+	const usageBuffer = [];
+	const header = await showHeader(ctx);
+	if (header) usageBuffer.push(header);
+	if (values.help) {
+		const usage = await showUsage(ctx);
+		if (usage) usageBuffer.push(usage);
+		return usageBuffer.join("\n");
+	}
+	if (error) {
+		await showValidationErrors(ctx, error);
+		return;
+	}
+	await command.run(ctx);
+}
+function resolveArgOptions(options) {
+	return Object.assign(create(), options, COMMON_OPTIONS);
+}
+function resolveCommandOptions(options, entry) {
+	const subCommands = new Map(options.subCommands);
+	if (typeof entry === "object" && entry.name && options.subCommands) subCommands.set(entry.name, entry);
+	const resolvedOptions = Object.assign(create(), COMMAND_OPTIONS_DEFAULT, options, { subCommands });
+	return resolvedOptions;
+}
+function getSubCommand(tokens) {
+	const firstToken = tokens[0];
+	return firstToken && firstToken.kind === "positional" && firstToken.index === 0 && firstToken.value ? firstToken.value : "";
+}
+async function showUsage(ctx) {
+	if (ctx.env.renderUsage === null) return;
+	const usage = await (ctx.env.renderUsage || renderUsage)(ctx);
+	if (usage) {
+		ctx.log(usage);
+		return usage;
+	}
+}
+function showVersion(ctx) {
+	ctx.log(ctx.env.version);
+}
+async function showHeader(ctx) {
+	if (ctx.env.renderHeader === null) return;
+	const header = await (ctx.env.renderHeader || renderHeader)(ctx);
+	if (header) {
+		ctx.log(header);
+		ctx.log();
+		return header;
+	}
+}
+async function showValidationErrors(ctx, error) {
+	if (ctx.env.renderValidationErrors === null) return;
+	const render = ctx.env.renderValidationErrors || renderValidationErrors;
+	ctx.log(await render(ctx, error));
+}
+async function resolveCommand(sub, entry, options) {
+	const omitted = !sub;
+	if (typeof entry === "function") return [void 0, { run: entry }];
+	else if (omitted) return typeof entry === "object" ? [resolveEntryName(entry), await resolveLazyCommand(entry)] : [void 0, void 0];
+	else {
+		if (options.subCommands == null || options.subCommands.size === 0) return [resolveEntryName(entry), await resolveLazyCommand(entry)];
+		const cmd = options.subCommands?.get(sub);
+		if (cmd == null) return [sub, void 0];
+		return [sub, await resolveLazyCommand(cmd, sub)];
+	}
+}
+function resolveEntryName(entry) {
+	return entry.name || "(anonymous)";
+}
+
+//#endregion
+export { cli };

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

@@ -1,5 +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-BeuJazdk.js";
-import { parseArgs, resolveArgs } from "args-tokens";
+import { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, DEFAULT_LOCALE$1 as DEFAULT_LOCALE, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, resolveLazyCommand, resolveOptionKey } from "./utils-BYPzZy9X.js";
 
 //#region src/locales/en-US.json
 var COMMAND = "COMMAND";
@@ -62,6 +61,11 @@ var DefaultTranslation = class {
 //#endregion
 //#region src/context.ts
 const BUILT_IN_PREFIX_CODE = BUILT_IN_PREFIX.codePointAt(0);
+/**
+* Create a {@link CommandContext | command context}
+* @param param A {@link CommandContextParams | parameters} to create a {@link CommandContext | command context}
+* @returns A {@link CommandContext | command context}, which is readonly
+*/
 async function createCommandContext({ options, values, positionals, rest, args, tokens, command, commandOptions, omitted = false }) {
 	/**
 	* normailize the options schema and values, to avoid prototype pollution
@@ -170,100 +174,4 @@ async function loadCommandResource(ctx, command) {
 }
 
 //#endregion
-//#region src/cli.ts
-async function cli(args, entry, opts = {}) {
-	const tokens = parseArgs(args);
-	const subCommand = getSubCommand(tokens);
-	const resolvedCommandOptions = resolveCommandOptions(opts, entry);
-	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, rest, error } = resolveArgs(options, tokens, {
-		optionGrouping: true,
-		allowNegative: true
-	});
-	const omitted = !subCommand;
-	const ctx = await createCommandContext({
-		options,
-		values,
-		positionals,
-		rest,
-		args,
-		tokens,
-		omitted,
-		command,
-		commandOptions: resolvedCommandOptions
-	});
-	if (values.version) {
-		showVersion(ctx);
-		return;
-	}
-	const usageBuffer = [];
-	const header = await showHeader(ctx);
-	if (header) usageBuffer.push(header);
-	if (values.help) {
-		const usage = await showUsage(ctx);
-		if (usage) usageBuffer.push(usage);
-		return usageBuffer.join("\n");
-	}
-	if (error) {
-		await showValidationErrors(ctx, error);
-		return;
-	}
-	await command.run(ctx);
-}
-function resolveArgOptions(options) {
-	return Object.assign(create(), options, COMMON_OPTIONS);
-}
-function resolveCommandOptions(options, entry) {
-	const subCommands = new Map(options.subCommands);
-	if (typeof entry === "object" && entry.name && options.subCommands) subCommands.set(entry.name, entry);
-	const resolvedOptions = Object.assign(create(), COMMAND_OPTIONS_DEFAULT, options, { subCommands });
-	return resolvedOptions;
-}
-function getSubCommand(tokens) {
-	const firstToken = tokens[0];
-	return firstToken && firstToken.kind === "positional" && firstToken.index === 0 && firstToken.value ? firstToken.value : "";
-}
-async function showUsage(ctx) {
-	if (ctx.env.renderUsage === null) return;
-	const usage = await (ctx.env.renderUsage || renderUsage)(ctx);
-	if (usage) {
-		ctx.log(usage);
-		return usage;
-	}
-}
-function showVersion(ctx) {
-	ctx.log(ctx.env.version);
-}
-async function showHeader(ctx) {
-	if (ctx.env.renderHeader === null) return;
-	const header = await (ctx.env.renderHeader || renderHeader)(ctx);
-	if (header) {
-		ctx.log(header);
-		ctx.log();
-		return header;
-	}
-}
-async function showValidationErrors(ctx, error) {
-	if (ctx.env.renderValidationErrors === null) return;
-	const render = ctx.env.renderValidationErrors || renderValidationErrors;
-	ctx.log(await render(ctx, error));
-}
-async function resolveCommand(sub, entry, options) {
-	const omitted = !sub;
-	if (typeof entry === "function") return [void 0, { run: entry }];
-	else if (omitted) return typeof entry === "object" ? [resolveEntryName(entry), await resolveLazyCommand(entry)] : [void 0, void 0];
-	else {
-		if (options.subCommands == null || options.subCommands.size === 0) return [resolveEntryName(entry), await resolveLazyCommand(entry)];
-		const cmd = options.subCommands?.get(sub);
-		if (cmd == null) return [sub, void 0];
-		return [sub, await resolveLazyCommand(cmd, sub)];
-	}
-}
-function resolveEntryName(entry) {
-	return entry.name || "(anonymous)";
-}
-
-//#endregion
-export { DefaultTranslation, cli };
+export { DefaultTranslation, createCommandContext };

package/lib/context.d.ts

@@ -0,0 +1,54 @@
+import { Command, CommandContext, CommandOptions } from "./types.d-aDzUZTqM.js";
+import { ArgOptions, ArgToken, ArgValues } from "args-tokens";
+
+//#region src/context.d.ts
+/**
+* Parameters of {@link createCommandContext}
+*/
+interface CommandContextParams<Options extends ArgOptions, Values> {
+    /**
+     * An options of target command
+     */
+    options: Options;
+    /**
+     * A values of target command
+     */
+    values: Values;
+    /**
+     * A positionals arguments, which passed to the target command
+     */
+    positionals: string[];
+    /**
+     * A rest arguments, which passed to the target command
+     */
+    rest: string[];
+    /**
+     * Original command line arguments
+     */
+    args: string[];
+    /**
+     * Argument tokens that are parsed by the `parseArgs` function
+     */
+    tokens: ArgToken[];
+    /**
+     * Whether the command is omitted
+     */
+    omitted: boolean;
+    /**
+     * A target {@link Command | command}
+     */
+    command: Command<Options>;
+    /**
+     * A command options, which is spicialized from `cli` function
+     */
+    commandOptions: CommandOptions<Options>;
+}
+/**
+* Create a {@link CommandContext | command context}
+* @param param A {@link CommandContextParams | parameters} to create a {@link CommandContext | command context}
+* @returns A {@link CommandContext | command context}, which is readonly
+*/
+declare function createCommandContext<Options extends ArgOptions = ArgOptions, Values extends ArgValues<Options> = ArgValues<Options>>({ options, values, positionals, rest, args, tokens, command, commandOptions, omitted }: CommandContextParams<Options, Values>): Promise<Readonly<CommandContext<Options, Values>>>;
+
+//#endregion
+export { createCommandContext };

package/lib/context.js

@@ -0,0 +1,4 @@
+import "./utils-BYPzZy9X.js";
+import { createCommandContext } from "./context-BROXRnNP.js";
+
+export { createCommandContext };

package/lib/definition-VzcnM0si.js

@@ -0,0 +1,12 @@
+//#region src/definition.ts
+/**
+* Define a {@link Command | command} with type inference
+* @param definition A {@link Command | command} definition
+* @returns A {@link Command | command} definition with type inference
+*/
+function define(definition) {
+	return definition;
+}
+
+//#endregion
+export { define };

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

@@ -1,12 +1,12 @@
-import { Command } from "./types.d-zAq1WIpD.js";
+import { Command } from "./types.d-aDzUZTqM.js";
 import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues as ArgValues$1 } from "args-tokens";
 
 //#region src/definition.d.ts
 /**
- * Define a {@link Command | command} with type inference
- * @param definition A {@link Command | command} definition
- * @returns A {@link Command | command} definition with type inference
- */
+* Define a {@link Command | command} with type inference
+* @param definition A {@link Command | command} definition
+* @returns A {@link Command | command} definition with type inference
+*/
 declare function define<Options extends ArgOptions = ArgOptions>(definition: Command<Options>): Command<Options>;
 
 //#endregion

package/lib/definition.d.ts

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

package/lib/definition.js

@@ -1,3 +1,3 @@
-import { define } from "./definition-BAm6f1St.js";
+import { define } from "./definition-VzcnM0si.js";
 
 export { define };

package/lib/generator.d.ts

@@ -1,14 +1,14 @@
-import { Command, CommandOptions } from "./types.d-zAq1WIpD.js";
+import { Command, CommandOptions } from "./types.d-aDzUZTqM.js";
 import { ArgOptions } from "args-tokens";
 
 //#region src/generator.d.ts
 /**
- * Generate the command usage.
- * @param command - usage generate command, if you want to generate the usage of the default command where there are target commands and sub-commands, specify `null`.
- * @param entry - A {@link Command | entry command}
- * @param opts - A {@link CommandOptions | command options}
- * @returns A rendered usage.
- */
+* Generate the command usage.
+* @param command - usage generate command, if you want to generate the usage of the default command where there are target commands and sub-commands, specify `null`.
+* @param entry - A {@link Command | entry command}
+* @param opts - A {@link CommandOptions | command options}
+* @returns A rendered usage.
+*/
 declare function generate<Options extends ArgOptions = ArgOptions>(command: string | null, entry: Command<Options>, opts?: CommandOptions<Options>): Promise<string>;
 
 //#endregion

package/lib/generator.js

@@ -1,7 +1,16 @@
-import { create } from "./renderer-BeuJazdk.js";
-import { cli } from "./cli--6qYDY8U.js";
+import { create } from "./utils-BYPzZy9X.js";
+import "./context-BROXRnNP.js";
+import "./renderer-BNorS8VG.js";
+import { cli } from "./cli-B7eqtqBF.js";
 
 //#region src/generator.ts
+/**
+* Generate the command usage.
+* @param command - usage generate command, if you want to generate the usage of the default command where there are target commands and sub-commands, specify `null`.
+* @param entry - A {@link Command | entry command}
+* @param opts - A {@link CommandOptions | command options}
+* @returns A rendered usage.
+*/
 async function generate(command, entry, opts = {}) {
 	const args = ["-h"];
 	if (command != null) args.unshift(command);

package/lib/index.d.ts

@@ -1,15 +1,15 @@
-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 { Command, CommandBuiltinKeys, CommandBuiltinOptionsKeys, CommandBuiltinResourceKeys, CommandContext, CommandEnvironment, CommandOptionKeys, CommandOptions, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgOptions, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types.d-aDzUZTqM.js";
+import { define$1 as define } from "./definition.d-DllW_uD3.js";
 import { ArgOptionSchema, ArgOptions, ArgOptions as ArgOptions$1, ArgValues, parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/cli.d.ts
 /**
- * Run the command.
- * @param args Command line arguments
- * @param entry A {@link Command | entry command} or an {@link CommandRunner | inline command runner}
- * @param opts A {@link CommandOptions | command options}
- * @returns A rendered usage or undefined. if you will use {@link CommandOptions.usageSilent} option, it will return rendered usage string.
- */
+* Run the command.
+* @param args Command line arguments
+* @param entry A {@link Command | entry command} or an {@link CommandRunner | inline command runner}
+* @param opts A {@link CommandOptions | command options}
+* @returns A rendered usage or undefined. if you will use {@link CommandOptions.usageSilent} option, it will return rendered usage string.
+*/
 declare function cli<Options extends ArgOptions$1 = ArgOptions$1>(args: string[], entry: Command<Options> | CommandRunner<Options>, opts?: CommandOptions<Options>): Promise<string | undefined>;
 
 //#endregion

package/lib/index.js

@@ -1,6 +1,8 @@
-import { define } from "./definition-BAm6f1St.js";
-import { DEFAULT_LOCALE$1 as DEFAULT_LOCALE } from "./renderer-BeuJazdk.js";
-import { DefaultTranslation, cli } from "./cli--6qYDY8U.js";
+import { DEFAULT_LOCALE$1 as DEFAULT_LOCALE } from "./utils-BYPzZy9X.js";
+import { DefaultTranslation } from "./context-BROXRnNP.js";
+import { define } from "./definition-VzcnM0si.js";
+import "./renderer-BNorS8VG.js";
+import { cli } from "./cli-B7eqtqBF.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 export { DEFAULT_LOCALE, DefaultTranslation, cli, define, parseArgs, resolveArgs };

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

@@ -1,74 +1,11 @@
+import { create, resolveBuiltInKey, resolveOptionKey } from "./utils-BYPzZy9X.js";
 
-//#region src/constants.ts
-const DEFAULT_LOCALE = "en-US";
-const BUILT_IN_PREFIX = "_";
-const OPTION_PREFIX = "Option";
-const BUILT_IN_KEY_SEPARATOR = ":";
-const NOOP = () => {};
-const COMMON_OPTIONS = {
-	help: {
-		type: "boolean",
-		short: "h",
-		description: "Display this help message"
-	},
-	version: {
-		type: "boolean",
-		short: "v",
-		description: "Display this version"
-	}
-};
-const COMMAND_OPTIONS_DEFAULT = {
-	name: void 0,
-	description: void 0,
-	version: void 0,
-	cwd: void 0,
-	usageSilent: false,
-	subCommands: void 0,
-	leftMargin: 2,
-	middleMargin: 10,
-	usageOptionType: false,
-	renderHeader: void 0,
-	renderUsage: void 0,
-	renderValidationErrors: void 0,
-	translationAdapterFactory: void 0
-};
-
-//#endregion
-//#region src/utils.ts
-async function resolveLazyCommand(cmd, name) {
-	const resolved = Object.assign(create(), typeof cmd == "function" ? await cmd() : cmd);
-	if (resolved.name == null && name) resolved.name = name;
-	return deepFreeze(resolved);
-}
-function resolveBuiltInKey(key) {
-	return `${BUILT_IN_PREFIX}${BUILT_IN_KEY_SEPARATOR}${key}`;
-}
-function resolveOptionKey(key) {
-	return `${OPTION_PREFIX}${BUILT_IN_KEY_SEPARATOR}${key}`;
-}
-function mapResourceWithBuiltinKey(resource) {
-	return Object.entries(resource).reduce((acc, [key, value]) => {
-		acc[resolveBuiltInKey(key)] = value;
-		return acc;
-	}, create());
-}
-function create(obj = null) {
-	return Object.create(obj);
-}
-function log(...args) {
-	console.log(...args);
-}
-function deepFreeze(obj) {
-	if (obj === null || typeof obj !== "object") return obj;
-	for (const key of Object.keys(obj)) {
-		const value = obj[key];
-		if (typeof value === "object" && value !== null) deepFreeze(value);
-	}
-	return Object.freeze(obj);
-}
-
-//#endregion
 //#region src/renderer/header.ts
+/**
+* Render the header.
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered header.
+*/
 function renderHeader(ctx) {
 	const title = ctx.env.description || ctx.env.name || "";
 	return Promise.resolve(title ? `${title} (${ctx.env.name || ""}${ctx.env.version ? ` v${ctx.env.version}` : ""})` : title);
@@ -76,6 +13,11 @@ function renderHeader(ctx) {
 
 //#endregion
 //#region src/renderer/usage.ts
+/**
+* Render the usage.
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered usage.
+*/
 async function renderUsage(ctx) {
 	const messages = [];
 	if (!ctx.omitted) {
@@ -274,6 +216,12 @@ async function generateOptionsUsage(ctx, optionsPairs) {
 
 //#endregion
 //#region src/renderer/validation.ts
+/**
+* Render the validation errors.
+* @param ctx A {@link CommandContext | command context}
+* @param error An {@link AggregateError} of option in `args-token` validation
+* @returns A rendered validation error.
+*/
 function renderValidationErrors(_ctx, error) {
 	const messages = [];
 	for (const err of error.errors) messages.push(err.message);
@@ -281,4 +229,4 @@ function renderValidationErrors(_ctx, error) {
 }
 
 //#endregion
-export { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE as DEFAULT_LOCALE$1, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, renderHeader, renderUsage, renderValidationErrors, resolveLazyCommand, resolveOptionKey };
+export { renderHeader, renderUsage, renderValidationErrors };

package/lib/renderer.d.ts

@@ -1,31 +1,31 @@
-import { CommandContext } from "./types.d-zAq1WIpD.js";
+import { CommandContext } from "./types.d-aDzUZTqM.js";
 import { ArgOptions } from "args-tokens";
 
 //#region src/renderer/header.d.ts
 /**
- * Render the header.
- * @param ctx A {@link CommandContext | command context}
- * @returns A rendered header.
- */
+* Render the header.
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered header.
+*/
 declare function renderHeader<Options extends ArgOptions = ArgOptions>(ctx: Readonly<CommandContext<Options>>): Promise<string>;
 
 //#endregion
 //#region src/renderer/usage.d.ts
 /**
- * Render the usage.
- * @param ctx A {@link CommandContext | command context}
- * @returns A rendered usage.
- */
+* Render the usage.
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered usage.
+*/
 declare function renderUsage<Options extends ArgOptions = ArgOptions>(ctx: Readonly<CommandContext<Options>>): Promise<string>;
 
 //#endregion
 //#region src/renderer/validation.d.ts
 /**
- * Render the validation errors.
- * @param ctx A {@link CommandContext | command context}
- * @param error An {@link AggregateError} of option in `args-token` validation
- * @returns A rendered validation error.
- */
+* Render the validation errors.
+* @param ctx A {@link CommandContext | command context}
+* @param error An {@link AggregateError} of option in `args-token` validation
+* @returns A rendered validation error.
+*/
 declare function renderValidationErrors<Options extends ArgOptions = ArgOptions>(_ctx: CommandContext<Options>, error: AggregateError): Promise<string>;
 
 //#endregion

package/lib/renderer.js

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

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

@@ -11,8 +11,8 @@ declare namespace constants_d_exports {
   export { BUILT_IN_KEY_SEPARATOR, BUILT_IN_PREFIX, COMMAND_BUILTIN_RESOURCE_KEYS, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE, NOOP, OPTION_PREFIX, }
 }
 /**
- * The default locale string, which format is BCP 47 language tag.
- */
+* The default locale string, which format is BCP 47 language tag.
+*/
 declare const DEFAULT_LOCALE = "en-US";
 declare const BUILT_IN_PREFIX = "_";
 declare const OPTION_PREFIX = "Option";
@@ -41,8 +41,8 @@ type RemoveIndexSignature<T> = {
     [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
 };
 /**
- * Remove index signature from object or record type.
- */
+* Remove index signature from object or record type.
+*/
 type RemovedIndex<T> = RemoveIndexSignature<{
     [K in keyof T]: T[K];
 }>;
@@ -50,30 +50,30 @@ 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.
- */
+* Generate a namespaced key.
+*/
 type GenerateNamespacedKey<Key extends string, Prefixed extends string = typeof BUILT_IN_PREFIX> = `${Prefixed}${typeof BUILT_IN_KEY_SEPARATOR}${Key}`;
 /**
- * Command i18n built-in options keys.
- */
+* Command i18n built-in options keys.
+*/
 type CommandBuiltinOptionsKeys = keyof (typeof constants_d_exports)['COMMON_OPTIONS'];
 /**
- * Command i18n built-in resource keys.
- */
+* Command i18n built-in resource keys.
+*/
 type CommandBuiltinResourceKeys = (typeof constants_d_exports)['COMMAND_BUILTIN_RESOURCE_KEYS'][number];
 /**
- * Command i18n built-in keys.
- * The command i18n built-in keys are used to {@link CommandContext.translate | translate} function.
- */
+* Command i18n built-in keys.
+* The command i18n built-in keys are used to {@link CommandContext.translate | translate} function.
+*/
 type CommandBuiltinKeys = GenerateNamespacedKey<CommandBuiltinOptionsKeys> | GenerateNamespacedKey<CommandBuiltinResourceKeys> | 'description' | 'examples';
 /**
- * Command i18n option keys.
- * The command i18n option keys are used to {@link CommandContext.translate | translate} function.
- */
+* Command i18n option keys.
+* The command i18n option keys are used to {@link CommandContext.translate | translate} function.
+*/
 type CommandOptionKeys<Options extends ArgOptions> = GenerateNamespacedKey<KeyOfArgOptions<RemovedIndex<Options>>, typeof OPTION_PREFIX>;
 /**
- * Command environment.
- */
+* Command environment.
+*/
 interface CommandEnvironment<Options extends ArgOptions = ArgOptions> {
     /**
      * Current working directory.
@@ -139,8 +139,8 @@ interface CommandEnvironment<Options extends ArgOptions = ArgOptions> {
     renderValidationErrors: ((ctx: CommandContext<Options>, error: AggregateError) => Promise<string>) | null | undefined;
 }
 /**
- * Command options.
- */
+* Command options.
+*/
 interface CommandOptions<Options extends ArgOptions = ArgOptions> {
     /**
      * Current working directory.
@@ -201,9 +201,9 @@ interface CommandOptions<Options extends ArgOptions = ArgOptions> {
     translationAdapterFactory?: TranslationAdapterFactory;
 }
 /**
- * Command context.
- * Command context is the context of the command execution.
- */
+* Command context.
+* Command context is the context of the command execution.
+*/
 interface CommandContext<Options extends ArgOptions = ArgOptions, Values = ArgValues<Options>> {
     /**
      * Command name, that is the command that is executed.
@@ -278,8 +278,8 @@ interface CommandContext<Options extends ArgOptions = ArgOptions, Values = ArgVa
     translate: <T extends string = CommandBuiltinKeys, O = CommandOptionKeys<Options>, Key = CommandBuiltinKeys | O | T>(key: Key, values?: Record<string, unknown>) => string;
 }
 /**
- * Command interface.
- */
+* Command interface.
+*/
 interface Command<Options extends ArgOptions = ArgOptions> {
     /**
      * Command name.
@@ -311,8 +311,8 @@ interface Command<Options extends ArgOptions = ArgOptions> {
     resource?: CommandResourceFetcher<Options>;
 }
 /**
- * Command resource.
- */
+* Command resource.
+*/
 type CommandResource<Options extends ArgOptions = ArgOptions> = {
     /**
      * Command description.
@@ -328,18 +328,18 @@ type CommandResource<Options extends ArgOptions = ArgOptions> = {
     [key: string]: string;
 };
 /**
- * Command resource fetcher.
- * @param ctx A {@link CommandContext | command context}
- * @returns A fetched {@link CommandResource | command resource}.
- */
+* Command resource fetcher.
+* @param ctx A {@link CommandContext | command context}
+* @returns A fetched {@link CommandResource | command resource}.
+*/
 type CommandResourceFetcher<Options extends ArgOptions = ArgOptions, Values = ArgValues<Options>> = (ctx: Readonly<CommandContext<Options, Values>>) => Promise<CommandResource<Options>>;
 /**
- * Translation adapter factory.
- */
+* Translation adapter factory.
+*/
 type TranslationAdapterFactory = (options: TranslationAdapterFactoryOptions) => TranslationAdapter;
 /**
- * Translation adapter factory options.
- */
+* Translation adapter factory options.
+*/
 interface TranslationAdapterFactoryOptions {
     /**
      * A locale.
@@ -351,10 +351,10 @@ interface TranslationAdapterFactoryOptions {
     fallbackLocale: string;
 }
 /**
- * Translation adapter.
- * This adapter is used to custom message formatter like {@link https://github.com/intlify/vue-i18n/blob/master/spec/syntax.ebnf | Intlify message format}, {@link https://github.com/tc39/proposal-intl-messageformat | `Intl.MessageFormat` (MF2)}, and etc.
- * This adapter will support localization with your preferred message format.
- */
+* Translation adapter.
+* This adapter is used to custom message formatter like {@link https://github.com/intlify/vue-i18n/blob/master/spec/syntax.ebnf | Intlify message format}, {@link https://github.com/tc39/proposal-intl-messageformat | `Intl.MessageFormat` (MF2)}, and etc.
+* This adapter will support localization with your preferred message format.
+*/
 interface TranslationAdapter<MessageResource = string> {
     /**
      * Get a resource of locale.
@@ -385,18 +385,18 @@ interface TranslationAdapter<MessageResource = string> {
     translate(locale: string, key: string, values?: Record<string, unknown>): string | undefined;
 }
 /**
- * Command runner.
- * @param ctx A {@link CommandContext | command context}
- */
+* Command runner.
+* @param ctx A {@link CommandContext | command context}
+*/
 type CommandRunner<Options extends ArgOptions = ArgOptions> = (ctx: Readonly<CommandContext<Options>>) => Awaitable<void>;
 /**
- * Lazy command interface.
- * Lazy command that's not loaded until it is executed.
- */
+* Lazy command interface.
+* Lazy command that's not loaded until it is executed.
+*/
 type LazyCommand<Options extends ArgOptions = ArgOptions> = () => Awaitable<Command<Options>>;
 /**
- * Define a command type.
- */
+* Define a command type.
+*/
 type Commandable<Options extends ArgOptions> = Command<Options> | LazyCommand<Options>;
 
 //#endregion

package/lib/utils-BYPzZy9X.js

@@ -0,0 +1,73 @@
+//#region src/constants.ts
+/**
+* The default locale string, which format is BCP 47 language tag.
+*/
+const DEFAULT_LOCALE = "en-US";
+const BUILT_IN_PREFIX = "_";
+const OPTION_PREFIX = "Option";
+const BUILT_IN_KEY_SEPARATOR = ":";
+const NOOP = () => {};
+const COMMON_OPTIONS = {
+	help: {
+		type: "boolean",
+		short: "h",
+		description: "Display this help message"
+	},
+	version: {
+		type: "boolean",
+		short: "v",
+		description: "Display this version"
+	}
+};
+const COMMAND_OPTIONS_DEFAULT = {
+	name: void 0,
+	description: void 0,
+	version: void 0,
+	cwd: void 0,
+	usageSilent: false,
+	subCommands: void 0,
+	leftMargin: 2,
+	middleMargin: 10,
+	usageOptionType: false,
+	renderHeader: void 0,
+	renderUsage: void 0,
+	renderValidationErrors: void 0,
+	translationAdapterFactory: void 0
+};
+
+//#endregion
+//#region src/utils.ts
+async function resolveLazyCommand(cmd, name) {
+	const resolved = Object.assign(create(), typeof cmd == "function" ? await cmd() : cmd);
+	if (resolved.name == null && name) resolved.name = name;
+	return deepFreeze(resolved);
+}
+function resolveBuiltInKey(key) {
+	return `${BUILT_IN_PREFIX}${BUILT_IN_KEY_SEPARATOR}${key}`;
+}
+function resolveOptionKey(key) {
+	return `${OPTION_PREFIX}${BUILT_IN_KEY_SEPARATOR}${key}`;
+}
+function mapResourceWithBuiltinKey(resource) {
+	return Object.entries(resource).reduce((acc, [key, value]) => {
+		acc[resolveBuiltInKey(key)] = value;
+		return acc;
+	}, create());
+}
+function create(obj = null) {
+	return Object.create(obj);
+}
+function log(...args) {
+	console.log(...args);
+}
+function deepFreeze(obj) {
+	if (obj === null || typeof obj !== "object") return obj;
+	for (const key of Object.keys(obj)) {
+		const value = obj[key];
+		if (typeof value === "object" && value !== null) deepFreeze(value);
+	}
+	return Object.freeze(obj);
+}
+
+//#endregion
+export { BUILT_IN_PREFIX, COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE as DEFAULT_LOCALE$1, NOOP, create, deepFreeze, log, mapResourceWithBuiltinKey, resolveBuiltInKey, resolveLazyCommand, resolveOptionKey };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gunshi",
   "description": "Modern javascript command-line library",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -47,6 +47,12 @@
       "require": "./lib/definition.js",
       "default": "./lib/definition.js"
     },
+    "./context": {
+      "types": "./lib/context.d.ts",
+      "import": "./lib/context.js",
+      "require": "./lib/context.js",
+      "default": "./lib/context.js"
+    },
     "./renderer": {
       "types": "./lib/renderer.d.ts",
       "import": "./lib/renderer.js",
@@ -97,14 +103,14 @@
     "eslint-plugin-yml": "^1.17.0",
     "gh-changelogen": "^0.2.8",
     "jsr": "^0.13.4",
+    "jsr-exports-lint": "^0.2.0",
     "knip": "^5.50.2",
     "lint-staged": "^15.5.0",
     "messageformat": "4.0.0-10",
     "pkg-pr-new": "^0.0.43",
     "prettier": "^3.5.3",
     "publint": "^0.3.11",
-    "tsdown": "^0.9.1",
-    "tsdown-jsr-exports-lint": "^0.1.4",
+    "tsdown": "^0.9.6",
     "typedoc": "^0.28.2",
     "typedoc-plugin-markdown": "^4.6.2",
     "typedoc-vitepress-theme": "^1.1.2",

package/lib/definition-BAm6f1St.js

@@ -1,8 +0,0 @@
-
-//#region src/definition.ts
-function define(definition) {
-	return definition;
-}
-
-//#endregion
-export { define };