gunshi 0.5.2 → 0.5.3

package/lib/{context-B5z7lnoV.js → context-DmZAeiph.js}

@@ -1,3 +1,4 @@
+import { create, deepFreeze, resolveLazyCommand } from "./utils-NHs5DuHk.js";
 
 //#region locales/en-US.json
 var COMMAND = "COMMAND";
@@ -56,28 +57,6 @@ const COMMAND_I18N_RESOURCE_KEYS = [
 	"FORMORE"
 ];
 
-//#endregion
-//#region src/utils.ts
-async function resolveLazyCommand(cmd, name, entry = false) {
-	const resolved = Object.assign(create(), typeof cmd == "function" ? await cmd() : cmd, { default: entry });
-	if (resolved.name == null && name) resolved.name = name;
-	return deepFreeze(resolved);
-}
-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/context.ts
 const DEFAULT_LOCALE = "en-US";
@@ -196,4 +175,4 @@ async function loadCommandResource(ctx, command) {
 }
 
 //#endregion
-export { COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE, create, createCommandContext, log, resolveLazyCommand };
+export { COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, DEFAULT_LOCALE, createCommandContext };

package/lib/context.js

@@ -1,3 +1,4 @@
-import { DEFAULT_LOCALE, createCommandContext } from "./context-B5z7lnoV.js";
+import { DEFAULT_LOCALE, createCommandContext } from "./context-DmZAeiph.js";
+import "./utils-NHs5DuHk.js";
 
 export { DEFAULT_LOCALE, createCommandContext };

package/lib/index.js

@@ -1,195 +1,8 @@
-import { COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, create, createCommandContext, log, resolveLazyCommand } from "./context-B5z7lnoV.js";
+import { COMMAND_OPTIONS_DEFAULT, COMMON_OPTIONS, createCommandContext } from "./context-DmZAeiph.js";
+import { create, log, resolveLazyCommand } from "./utils-NHs5DuHk.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-MpQ9U28q.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
-//#region src/renderer/header.ts
-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);
-}
-
-//#endregion
-//#region src/renderer/usage.ts
-async function renderUsage(ctx) {
-	const messages = [];
-	if (!ctx.omitted && hasDescription(ctx)) messages.push(ctx.description, "");
-	messages.push(...await renderUsageSection(ctx), "");
-	if (ctx.omitted && await hasCommands(ctx)) messages.push(...await renderCommandsSection(ctx), "");
-	if (hasOptions(ctx)) messages.push(...await renderOptionsSection(ctx), "");
-	if (hasExamples(ctx)) messages.push(...renderExamplesSection(ctx), "");
-	return messages.join("\n");
-}
-/**
-* Render the options section
-* @param ctx A {@link CommandContext | command context}
-* @returns A rendered options section
-*/
-async function renderOptionsSection(ctx) {
-	const messages = [];
-	messages.push(`${ctx.translation("OPTIONS")}:`);
-	const optionsPairs = getOptionsPairs(ctx);
-	messages.push(await generateOptionsUsage(ctx, optionsPairs));
-	return messages;
-}
-/**
-* Render the examples section
-* @param ctx A {@link CommandContext | command context}
-* @returns A rendered examples section
-*/
-function renderExamplesSection(ctx) {
-	const messages = [];
-	const examples = ctx.usage.examples.split("\n").map((example) => example.padStart(ctx.env.leftMargin + example.length));
-	messages.push(`${ctx.translation("EXAMPLES")}:`, ...examples);
-	return messages;
-}
-/**
-* Render the usage section
-* @param ctx A {@link CommandContext | command context}
-* @returns A rendered usage section
-*/
-async function renderUsageSection(ctx) {
-	const messages = [`${ctx.translation("USAGE")}:`];
-	if (ctx.omitted) {
-		const defaultCommand = `${resolveEntry(ctx)}${await hasCommands(ctx) ? ` [${resolveSubCommand(ctx)}]` : ""} ${hasOptions(ctx) ? `<${ctx.translation("OPTIONS")}>` : ""} `;
-		messages.push(defaultCommand.padStart(ctx.env.leftMargin + defaultCommand.length));
-		if (await hasCommands(ctx)) {
-			const commandsUsage = `${resolveEntry(ctx)} <${ctx.translation("COMMANDS")}>`;
-			messages.push(commandsUsage.padStart(ctx.env.leftMargin + commandsUsage.length));
-		}
-	} else {
-		const usageStr = `${resolveEntry(ctx)} ${resolveSubCommand(ctx)} ${generateOptionsSymbols(ctx)}`;
-		messages.push(usageStr.padStart(ctx.env.leftMargin + usageStr.length));
-	}
-	return messages;
-}
-/**
-* Render the commands section
-* @param ctx A {@link CommandContext | command context}
-* @returns A rendered commands section
-*/
-async function renderCommandsSection(ctx) {
-	const messages = [`${ctx.translation("COMMANDS")}:`];
-	const loadedCommands = await ctx.loadCommands();
-	const commandMaxLength = Math.max(...loadedCommands.map((cmd) => (cmd.name || "").length));
-	const commandsStr = await Promise.all(loadedCommands.map((cmd) => {
-		const key = cmd.name || "";
-		const desc = cmd.description || "";
-		const command = `${key.padEnd(commandMaxLength + ctx.env.middleMargin)}${desc} `;
-		return `${command.padStart(ctx.env.leftMargin + command.length)} `;
-	}));
-	messages.push(...commandsStr, "", ctx.translation("FORMORE"));
-	messages.push(...loadedCommands.map((cmd) => {
-		const commandHelp = `${ctx.env.name} ${cmd.name} --help`;
-		return `${commandHelp.padStart(ctx.env.leftMargin + commandHelp.length)}`;
-	}));
-	return messages;
-}
-/**
-* Resolve the entry command name
-* @param ctx A {@link CommandContext | command context}
-* @returns The entry command name
-*/
-function resolveEntry(ctx) {
-	return ctx.env.name || ctx.translation("COMMAND");
-}
-/**
-* Resolve the sub command name
-* @param ctx A {@link CommandContext | command context}
-* @returns The sub command name
-*/
-function resolveSubCommand(ctx) {
-	return ctx.name || ctx.translation("SUBCOMMAND");
-}
-/**
-* Check if the command has a description
-* @param ctx A {@link CommandContext | command context}
-* @returns True if the command has a description
-*/
-function hasDescription(ctx) {
-	return !!ctx.description;
-}
-/**
-* Check if the command has sub commands
-* @param ctx A {@link CommandContext | command context}
-* @returns True if the command has sub commands
-*/
-async function hasCommands(ctx) {
-	const loadedCommands = await ctx.loadCommands();
-	return loadedCommands.length > 1;
-}
-/**
-* Check if the command has options
-* @param ctx A {@link CommandContext | command context}
-* @returns True if the command has options
-*/
-function hasOptions(ctx) {
-	return !!(ctx.options && Object.keys(ctx.options).length > 0);
-}
-/**
-* Check if the command has examples
-* @param ctx A {@link CommandContext | command context}
-* @returns True if the command has examples
-*/
-function hasExamples(ctx) {
-	return !!ctx.usage.examples;
-}
-/**
-* Check if all options have default values
-* @param ctx A {@link CommandContext | command context}
-* @returns True if all options have default values
-*/
-function hasAllDefaultOptions(ctx) {
-	return !!(ctx.options && Object.values(ctx.options).every((opt) => opt.default));
-}
-/**
-* Generate options symbols for usage
-* @param ctx A {@link CommandContext | command context}
-* @returns Options symbols for usage
-*/
-function generateOptionsSymbols(ctx) {
-	return hasOptions(ctx) ? hasAllDefaultOptions(ctx) ? `[${ctx.translation("OPTIONS")}]` : `<${ctx.translation("OPTIONS")}>` : "";
-}
-/**
-* Get options pairs for usage
-* @param ctx A {@link CommandContext | command context}
-* @returns Options pairs for usage
-*/
-function getOptionsPairs(ctx) {
-	return Object.entries(ctx.options).reduce((acc, [name, value]) => {
-		let key = `--${name}`;
-		if (value.short) key = `-${value.short}, ${key}`;
-		if (value.type !== "boolean") key = value.default ? `${key} [${name}]` : `${key} <${name}>`;
-		acc[name] = key;
-		return acc;
-	}, create());
-}
-/**
-* Generate options usage
-* @param ctx A {@link CommandContext | command context}
-* @param optionsPairs Options pairs for usage
-* @returns Generated options usage
-*/
-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 usages = await Promise.all(Object.entries(optionsPairs).map(([key, value]) => {
-		const rawDesc = ctx.translation(key);
-		const optionsSchema = ctx.env.usageOptionType ? `[${ctx.options[key].type}] ` : "";
-		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)}`;
-	}));
-	return usages.join("\n");
-}
-
-//#endregion
-//#region src/renderer/validation.ts
-function renderValidationErrors(_ctx, error) {
-	const messages = [];
-	for (const err of error.errors) messages.push(err.message);
-	return Promise.resolve(messages.join("\n"));
-}
-
-//#endregion
 //#region src/cli.ts
 async function cli(args, entry, opts = {}) {
 	const tokens = parseArgs(args);

package/lib/renderer/index.d.ts

@@ -0,0 +1,26 @@
+import { ArgOptions } from 'args-tokens';
+import { b as CommandContext } from '../types.d-veidyA82.js';
+
+/**
+* Render the header
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered header
+*/
+declare function renderHeader<Options extends ArgOptions>(ctx: Readonly<CommandContext<Options>>): Promise<string>;
+
+/**
+* Render the usage
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered usage
+*/
+declare function renderUsage<Options extends ArgOptions>(ctx: Readonly<CommandContext<Options>>): Promise<string>;
+
+/**
+* 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>(_ctx: CommandContext<Options>, error: AggregateError): Promise<string>;
+
+export { renderHeader, renderUsage, renderValidationErrors };

package/lib/renderer/index.js

@@ -0,0 +1,4 @@
+import "../utils-NHs5DuHk.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "../renderer-MpQ9U28q.js";
+
+export { renderHeader, renderUsage, renderValidationErrors };

package/lib/renderer-MpQ9U28q.js

@@ -0,0 +1,192 @@
+import { create } from "./utils-NHs5DuHk.js";
+
+//#region src/renderer/header.ts
+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);
+}
+
+//#endregion
+//#region src/renderer/usage.ts
+async function renderUsage(ctx) {
+	const messages = [];
+	if (!ctx.omitted && hasDescription(ctx)) messages.push(ctx.description, "");
+	messages.push(...await renderUsageSection(ctx), "");
+	if (ctx.omitted && await hasCommands(ctx)) messages.push(...await renderCommandsSection(ctx), "");
+	if (hasOptions(ctx)) messages.push(...await renderOptionsSection(ctx), "");
+	if (hasExamples(ctx)) messages.push(...renderExamplesSection(ctx), "");
+	return messages.join("\n");
+}
+/**
+* Render the options section
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered options section
+*/
+async function renderOptionsSection(ctx) {
+	const messages = [];
+	messages.push(`${ctx.translation("OPTIONS")}:`);
+	const optionsPairs = getOptionsPairs(ctx);
+	messages.push(await generateOptionsUsage(ctx, optionsPairs));
+	return messages;
+}
+/**
+* Render the examples section
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered examples section
+*/
+function renderExamplesSection(ctx) {
+	const messages = [];
+	const examples = ctx.usage.examples.split("\n").map((example) => example.padStart(ctx.env.leftMargin + example.length));
+	messages.push(`${ctx.translation("EXAMPLES")}:`, ...examples);
+	return messages;
+}
+/**
+* Render the usage section
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered usage section
+*/
+async function renderUsageSection(ctx) {
+	const messages = [`${ctx.translation("USAGE")}:`];
+	if (ctx.omitted) {
+		const defaultCommand = `${resolveEntry(ctx)}${await hasCommands(ctx) ? ` [${resolveSubCommand(ctx)}]` : ""} ${hasOptions(ctx) ? `<${ctx.translation("OPTIONS")}>` : ""} `;
+		messages.push(defaultCommand.padStart(ctx.env.leftMargin + defaultCommand.length));
+		if (await hasCommands(ctx)) {
+			const commandsUsage = `${resolveEntry(ctx)} <${ctx.translation("COMMANDS")}>`;
+			messages.push(commandsUsage.padStart(ctx.env.leftMargin + commandsUsage.length));
+		}
+	} else {
+		const usageStr = `${resolveEntry(ctx)} ${resolveSubCommand(ctx)} ${generateOptionsSymbols(ctx)}`;
+		messages.push(usageStr.padStart(ctx.env.leftMargin + usageStr.length));
+	}
+	return messages;
+}
+/**
+* Render the commands section
+* @param ctx A {@link CommandContext | command context}
+* @returns A rendered commands section
+*/
+async function renderCommandsSection(ctx) {
+	const messages = [`${ctx.translation("COMMANDS")}:`];
+	const loadedCommands = await ctx.loadCommands();
+	const commandMaxLength = Math.max(...loadedCommands.map((cmd) => (cmd.name || "").length));
+	const commandsStr = await Promise.all(loadedCommands.map((cmd) => {
+		const key = cmd.name || "";
+		const desc = cmd.description || "";
+		const command = `${key.padEnd(commandMaxLength + ctx.env.middleMargin)}${desc} `;
+		return `${command.padStart(ctx.env.leftMargin + command.length)} `;
+	}));
+	messages.push(...commandsStr, "", ctx.translation("FORMORE"));
+	messages.push(...loadedCommands.map((cmd) => {
+		const commandHelp = `${ctx.env.name} ${cmd.name} --help`;
+		return `${commandHelp.padStart(ctx.env.leftMargin + commandHelp.length)}`;
+	}));
+	return messages;
+}
+/**
+* Resolve the entry command name
+* @param ctx A {@link CommandContext | command context}
+* @returns The entry command name
+*/
+function resolveEntry(ctx) {
+	return ctx.env.name || ctx.translation("COMMAND");
+}
+/**
+* Resolve the sub command name
+* @param ctx A {@link CommandContext | command context}
+* @returns The sub command name
+*/
+function resolveSubCommand(ctx) {
+	return ctx.name || ctx.translation("SUBCOMMAND");
+}
+/**
+* Check if the command has a description
+* @param ctx A {@link CommandContext | command context}
+* @returns True if the command has a description
+*/
+function hasDescription(ctx) {
+	return !!ctx.description;
+}
+/**
+* Check if the command has sub commands
+* @param ctx A {@link CommandContext | command context}
+* @returns True if the command has sub commands
+*/
+async function hasCommands(ctx) {
+	const loadedCommands = await ctx.loadCommands();
+	return loadedCommands.length > 1;
+}
+/**
+* Check if the command has options
+* @param ctx A {@link CommandContext | command context}
+* @returns True if the command has options
+*/
+function hasOptions(ctx) {
+	return !!(ctx.options && Object.keys(ctx.options).length > 0);
+}
+/**
+* Check if the command has examples
+* @param ctx A {@link CommandContext | command context}
+* @returns True if the command has examples
+*/
+function hasExamples(ctx) {
+	return !!ctx.usage.examples;
+}
+/**
+* Check if all options have default values
+* @param ctx A {@link CommandContext | command context}
+* @returns True if all options have default values
+*/
+function hasAllDefaultOptions(ctx) {
+	return !!(ctx.options && Object.values(ctx.options).every((opt) => opt.default));
+}
+/**
+* Generate options symbols for usage
+* @param ctx A {@link CommandContext | command context}
+* @returns Options symbols for usage
+*/
+function generateOptionsSymbols(ctx) {
+	return hasOptions(ctx) ? hasAllDefaultOptions(ctx) ? `[${ctx.translation("OPTIONS")}]` : `<${ctx.translation("OPTIONS")}>` : "";
+}
+/**
+* Get options pairs for usage
+* @param ctx A {@link CommandContext | command context}
+* @returns Options pairs for usage
+*/
+function getOptionsPairs(ctx) {
+	return Object.entries(ctx.options).reduce((acc, [name, value]) => {
+		let key = `--${name}`;
+		if (value.short) key = `-${value.short}, ${key}`;
+		if (value.type !== "boolean") key = value.default ? `${key} [${name}]` : `${key} <${name}>`;
+		acc[name] = key;
+		return acc;
+	}, create());
+}
+/**
+* Generate options usage
+* @param ctx A {@link CommandContext | command context}
+* @param optionsPairs Options pairs for usage
+* @returns Generated options usage
+*/
+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 usages = await Promise.all(Object.entries(optionsPairs).map(([key, value]) => {
+		const rawDesc = ctx.translation(key);
+		const optionsSchema = ctx.env.usageOptionType ? `[${ctx.options[key].type}] ` : "";
+		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)}`;
+	}));
+	return usages.join("\n");
+}
+
+//#endregion
+//#region src/renderer/validation.ts
+function renderValidationErrors(_ctx, error) {
+	const messages = [];
+	for (const err of error.errors) messages.push(err.message);
+	return Promise.resolve(messages.join("\n"));
+}
+
+//#endregion
+export { renderHeader, renderUsage, renderValidationErrors };

package/lib/utils-NHs5DuHk.js

@@ -0,0 +1,24 @@
+
+//#region src/utils.ts
+async function resolveLazyCommand(cmd, name, entry = false) {
+	const resolved = Object.assign(create(), typeof cmd == "function" ? await cmd() : cmd, { default: entry });
+	if (resolved.name == null && name) resolved.name = name;
+	return deepFreeze(resolved);
+}
+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 { create, deepFreeze, log, resolveLazyCommand };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gunshi",
   "description": "Modern javascript command-line library",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -49,10 +49,10 @@
       "default": "./lib/context.js"
     },
     "./renderer": {
-      "types": "./lib/renderer.d.ts",
-      "import": "./lib/renderer.js",
-      "require": "./lib/renderer.js",
-      "default": "./lib/renderer.js"
+      "types": "./lib/renderer/index.d.ts",
+      "import": "./lib/renderer/index.js",
+      "require": "./lib/renderer/index.js",
+      "default": "./lib/renderer/index.js"
     },
     "./package.json": "./package.json",
     "./*": "./*"