@breadc/core 1.0.0-beta.3 → 1.0.0-beta.5

package/dist/index.d.mts

@@ -614,7 +614,7 @@ type Command<Spec extends string = string, Init extends CommandInit<Spec> = Comm
    */
   action<R extends unknown>(fn: (...args: [...Arguments, Prettify<Options & {
     '--': string[];
-  }>]) => Promise<R> | R): Command<Spec, Init, Data, Options, Arguments, R>;
+  }>, Context<Data>]) => Promise<R> | R): Command<Spec, Init, Data, Options, Arguments, R>;
   /**
    * Run command directly
    */
@@ -657,6 +657,7 @@ declare function printVersion(context: Context): string;
 //#region src/error.d.ts
 declare abstract class BreadcError extends Error {}
 type BreadcAppErrorCause = {
+  group?: InternalGroup;
   command?: InternalCommand;
   commands?: (InternalCommand | InternalGroup)[];
 };
@@ -665,6 +666,7 @@ type BreadcAppErrorInput = BreadcAppErrorCause & {
 };
 declare class BreadcAppError extends BreadcError {
   static DUPLICATED_DEFAULT_COMMAND: string;
+  static DUPLICATED_DEFAULT_GROUP_COMMAND: string;
   static DUPLICATED_GROUP: string;
   static DUPLICATED_COMMAND: string;
   static NO_ACTION_BOUND: string;

package/dist/index.mjs

@@ -38,6 +38,7 @@ function rawOption(spec, type, long, short, init) {
 //#region src/error.ts
 var BreadcError = class extends Error {};
 var RuntimeError = class extends BreadcError {
+	static UNEXPECTED_ARGUMENTS = "Detect unexpected redundant arguments";
 	static REQUIRED_ARGUMENT_MISSING = "Missing required argument";
 	static OPTIONAL_ARGUMENT_ACCEPT_ONCE = "Optional argument can only be assigned once";
 	static REQUIRED_ARGUMENT_ACCEPT_ONCE = "Required argument can only be assigned once";
@@ -60,6 +61,7 @@ var RuntimeError = class extends BreadcError {
 };
 var BreadcAppError = class extends BreadcError {
 	static DUPLICATED_DEFAULT_COMMAND = `Find duplicated default commands`;
+	static DUPLICATED_DEFAULT_GROUP_COMMAND = `Find duplicated default group commands`;
 	static DUPLICATED_GROUP = `Find duplicated groups`;
 	static DUPLICATED_COMMAND = `Find duplicated commands`;
 	static NO_ACTION_BOUND = `There is no action function bound in this command`;
@@ -117,12 +119,10 @@ var ResolveOptionError = class extends BreadcError {
 function resolveOptionInput(spec, description, init) {
 	return typeof spec === "string" ? option(spec, description, init) : spec;
 }
-function defaultUnknownOptionMiddleware() {
-	return (_ctx, key, value) => ({
-		name: key,
-		value
-	});
-}
+const defaultUnknownOptionMiddleware = (_ctx, key, value) => ({
+	name: key,
+	value
+});
 
 //#endregion
 //#region src/breadc/command.ts
@@ -157,7 +157,7 @@ function command(spec, init) {
 	run.allowUnknownOption = (middleware) => {
 		if (!run._unknownOptionMiddlewares) run._unknownOptionMiddlewares = [];
 		if (typeof middleware === "function") run._unknownOptionMiddlewares.push(middleware);
-		else run._unknownOptionMiddlewares.push(defaultUnknownOptionMiddleware());
+		else run._unknownOptionMiddlewares.push(defaultUnknownOptionMiddleware);
 		return run;
 	};
 	run.action = (fn) => {
@@ -783,6 +783,8 @@ function buildGroup(group) {
 //#endregion
 //#region src/breadc/builtin/i18n.ts
 const en = {
+	OPTIONS: "OPTIONS",
+	COMMAND: "COMMAND",
 	"Usage:": "Usage:",
 	"Commands:": "Commands:",
 	"Options:": "Options:",
@@ -790,7 +792,9 @@ const en = {
 	"Print version": "Print version"
 };
 const zh = {
-	"Usage:": "使用:",
+	OPTIONS: "选项",
+	COMMAND: "子命令",
+	"Usage:": "用法:",
 	"Commands:": "命令:",
 	"Options:": "选项:",
 	"Print help": "显示帮助信息",
@@ -928,7 +932,7 @@ function buildHelpOption(context) {
 function printHelp(context) {
 	const { breadc, pieces } = context;
 	const { allCommands, commands, options } = collect(context, pieces);
-	const usage = allCommands.length === 0 ? "[OPTIONS]" : allCommands.length === 1 ? `[OPTIONS] ${formatCommand(allCommands[0])}` : allCommands.some((command) => command._default) ? "[OPTIONS] [COMMAND]" : "[OPTIONS] <COMMAND>";
+	const usage = allCommands.length === 0 ? `[${i18n(context, "OPTIONS")}]` : allCommands.length === 1 ? `[${i18n(context, "OPTIONS")}] ${formatCommand(allCommands[0])}` : allCommands.some((command) => command._default) ? `[${i18n(context, "OPTIONS")}] [${i18n(context, "COMMAND")}]` : `[${i18n(context, "OPTIONS")}] <${i18n(context, "COMMAND")}>`;
 	const text = expandMessage([
 		`${breadc.name}/${breadc._init.version ?? "unknown"}`,
 		() => {
@@ -970,10 +974,14 @@ function parse(app, argv) {
 		commands: defaultCommands
 	});
 	const defaultCommand = defaultCommands[0];
-	doParse(context$1, defaultCommand !== void 0 && context$1.breadc._commands.length === 1 ? defaultCommand : void 0);
-	if (context$1.command || isVersion(context$1) || isHelp(context$1)) {} else if (defaultCommand) {
+	doParse(context$1, void 0, defaultCommand !== void 0 && context$1.breadc._commands.length === 1 ? defaultCommand : void 0);
+	if (context$1.command || isVersion(context$1) || isHelp(context$1)) {} else if (context$1.group) {
+		const matchedGroup = context$1.group;
+		reset(context$1);
+		doParse(context$1, matchedGroup, void 0);
+	} else if (defaultCommand) {
 		reset(context$1);
-		doParse(context$1, defaultCommand);
+		doParse(context$1, void 0, defaultCommand);
 	}
 	return context$1;
 }
@@ -993,7 +1001,7 @@ function isVersion(context) {
 	if (version && context.options.get(version.long)?.value()) return true;
 	else return false;
 }
-function doParse(context, defaultCommand) {
+function doParse(context, defaultGroup, defaultCommand) {
 	const { breadc, tokens, options: matchedOptions } = context;
 	let index = 0;
 	let matchedGroup = void 0;
@@ -1030,10 +1038,8 @@ function doParse(context, defaultCommand) {
 	}
 	if (defaultCommand) {
 		matchedCommand = defaultCommand;
-		for (const command of breadc._commands) if (command._default) {
-			buildCommand(command);
-			addPendingOptions(command._options);
-		}
+		buildCommand(defaultCommand);
+		addPendingOptions(defaultCommand._options);
 	} else for (const command of breadc._commands) if (!command._default) for (let alias = 0; alias < command._pieces.length; alias++) addPendingCommand(command, alias);
 	while (!tokens.isEnd) {
 		const token = tokens.next();
@@ -1055,7 +1061,22 @@ function doParse(context, defaultCommand) {
 					});
 					buildGroup(group);
 					addPendingOptions(group._options);
-					for (const command of group._commands) for (let alias = 0; alias < command._pieces.length; alias++) addPendingCommand(command, alias);
+					if (matchedGroup && matchedGroup === defaultGroup) {
+						const defaultCommands = matchedGroup._commands.filter((command) => command._pieces.some((p) => p.length === index));
+						if (defaultCommands.length === 1) {
+							const defaultCommand = defaultCommands[0];
+							matchedCommand = defaultCommand;
+							buildCommand(defaultCommand);
+							addPendingOptions(defaultCommand._options);
+						} else if (defaultCommands.length > 1) throw new BreadcAppError(BreadcAppError.DUPLICATED_DEFAULT_GROUP_COMMAND, {
+							context,
+							group: matchedGroup,
+							commands: defaultCommands
+						});
+					} else for (const command of group._commands) for (let alias = 0; alias < command._pieces.length; alias++) {
+						if (command._pieces[alias].length === index) continue;
+						addPendingCommand(command, alias);
+					}
 				} else {
 					if (!matchedCommand || matchedCommand === command) matchedCommand = command;
 					else throw new BreadcAppError(BreadcAppError.DUPLICATED_COMMAND, {
@@ -1095,6 +1116,7 @@ function doParse(context, defaultCommand) {
 	context.group = matchedGroup;
 	context.command = matchedCommand;
 	if (matchedCommand) {
+		if (unknown.length > 0) throw new RuntimeError(RuntimeError.UNEXPECTED_ARGUMENTS, { context });
 		let i = 0;
 		for (; i < matchedCommand._arguments.length; i++) {
 			const argument = matchedCommand._arguments[i];
@@ -1144,7 +1166,7 @@ async function run(app, argv) {
 	options["--"] = context.remaining;
 	if (context.command._actionFn) {
 		const actionFn = context.command._actionFn;
-		if (actionMiddlewares.length === 0) return await actionFn(...args, options);
+		if (actionMiddlewares.length === 0) return await actionFn(...args, options, context);
 		else {
 			const invoked = [];
 			const makeNextFn = (index) => {
@@ -1154,7 +1176,7 @@ async function run(app, argv) {
 						...nextContext?.data
 					};
 					invoked[index] = true;
-					if (index === actionMiddlewares.length) context.output = await actionFn(...args, options);
+					if (index === actionMiddlewares.length) context.output = await actionFn(...args, options, context);
 					else {
 						const next = makeNextFn(index + 1);
 						await actionMiddlewares[index](context, next);
@@ -1192,8 +1214,11 @@ function group(spec, init) {
 			options.push(resolveOptionInput(spec, description, init));
 			return group;
 		},
-		command(spec, init) {
-			const command$2 = typeof spec === "string" ? command(spec, init) : spec;
+		command(spec, description, init) {
+			const command$2 = typeof spec === "string" ? command(spec, description || init ? {
+				description,
+				...init
+			} : void 0) : spec;
 			command$2._group = group;
 			commands.push(command$2);
 			return command$2;
@@ -1204,7 +1229,7 @@ function group(spec, init) {
 		},
 		allowUnknownOption(middleware) {
 			if (typeof middleware === "function") unknownOptionMiddlewares.push(middleware);
-			else unknownOptionMiddlewares.push(defaultUnknownOptionMiddleware());
+			else unknownOptionMiddlewares.push(defaultUnknownOptionMiddleware);
 			return group;
 		}
 	};
@@ -1255,7 +1280,7 @@ function breadc(name, init = {}) {
 		},
 		allowUnknownOption(middleware) {
 			if (typeof middleware === "function") unknownOptionMiddlewares.push(middleware);
-			else unknownOptionMiddlewares.push(defaultUnknownOptionMiddleware());
+			else unknownOptionMiddlewares.push(defaultUnknownOptionMiddleware);
 			return app;
 		},
 		parse(argv) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breadc/core",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.5",
   "description": "Yet another Command Line Application Framework with fully strong TypeScript support",
   "keywords": [
     "breadc",
@@ -33,7 +33,7 @@
     "dist"
   ],
   "dependencies": {
-    "@breadc/color": "1.0.0-beta.3"
+    "@breadc/color": "1.0.0-beta.5"
   },
   "size-limit": [
     {