@hardfin/cli 0.1.1-dev.75 → 0.1.1-dev.77

package/dist/{program-CuFKCoDH.js → program-CTAOEcIl.js}

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="9993eb69-9e2e-5536-98a5-fb924deec820")}catch(e){}}();
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="0e61ba79-b67a-56d5-a2fd-a7a450bc463c")}catch(e){}}();
 import { a as defineCommand, i as GLOBAL_FLAGS, r as ExitCode, t as toInvocation } from "./scrub-BZ0egWxC.js";
 import { C as Interrupted, S as ExpectedFailure, T as TimedOut, _ as ConfigFailure, a as isShipped, b as toTelemetry, g as CONFIG_FILE, h as writeFailure, i as toUpdateCheckRefusal, l as toStateDirectory, m as writeData, o as toPackageDirectory, p as toText, r as toCheck, s as noteNotices, t as PACKAGE, u as isJSONOutput, v as toSettings, w as LockHeld, x as version$1, y as API_VERSION } from "./check-8Ta7vSnU.js";
 import { n as toAnswer$1, r as toCompletion, t as PATH_VALUES } from "./completion-tree-DLC6ARLR.js";
@@ -1125,7 +1125,8 @@ function toTaken(flag) {
 	return flag.valueName ?? "nothing";
 }
 async function runAgentGuide(input) {
-	const found = toNamed(input.commands, input.args);
+	const words = input.args.flatMap((arg) => arg.split(/\s+/)).filter((word) => word.length > 0);
+	const found = toNamed(input.commands, words);
 	if (found === void 0) {
 		writeFailure("invalid_arguments", `no command is called ${input.args.join(" ")}. Run hardfin --help for the list`, input.isJSON);
 		return ExitCode.USAGE;
@@ -1254,6 +1255,9 @@ function toHelpDescription(flag) {
 function toProgram(root, command, onRun, isSilent) {
 	const program = new Command(command.name).summary(command.summary).description(command.description ?? command.summary);
 	toQuietParser(program, isSilent);
+	program.exitOverride((error) => {
+		throw toSuggested(error, command);
+	});
 	for (const argument of command.arguments) {
 		const name = argument.variadic ? `${argument.name}...` : argument.name;
 		program.argument(argument.required ? `<${name}>` : `[${name}]`, argument.description);
@@ -1299,6 +1303,32 @@ function toQuietParser(program, isSilent) {
 		writeErr: () => void 0
 	});
 }
+/** The most flags an unknown flag's error suggests. */
+const MAX_SUGGESTIONS = 3;
+/**
+* toSuggested names the flags an unknown flag may have meant, when the parser's own spelling
+* check found none, by matching the words of its name.
+*/
+function toSuggested(error, command) {
+	const unknown = /unknown option '--([^']+)'/.exec(error.message)?.[1];
+	if (error.code !== "commander.unknownOption" || unknown === void 0 || error.message.includes("Did you mean")) return error;
+	const words = toWords(unknown);
+	const matches = command.flags.map((flag) => ({
+		name: flag.name,
+		words: toWords(flag.name)
+	})).filter((flag) => words.every((word) => flag.words.some((other) => isSameWord(word, other)))).sort((a, b) => a.words.length - b.words.length || a.name.localeCompare(b.name)).slice(0, MAX_SUGGESTIONS).map((flag) => `--${flag.name}`);
+	if (matches.length === 0) return error;
+	const suggestion = matches.length === 1 ? matches[0] : `one of ${matches.join(", ")}`;
+	return new CommanderError(error.exitCode, error.code, `${error.message}\n(Did you mean ${suggestion}?)`);
+}
+function toWords(name) {
+	return name.split("-").filter((word) => word.length > 0);
+}
+/** isSameWord treats a word and its plural, such as status and statuses, as one. */
+function isSameWord(given, other) {
+	const [shorter, longer] = given.length <= other.length ? [given, other] : [other, given];
+	return longer.startsWith(shorter) && longer.length - shorter.length <= 2;
+}
 function toArgumentList(value) {
 	if (Array.isArray(value)) return value.map(String);
 	return value === void 0 ? [] : [toText(value)];
@@ -9546,7 +9576,7 @@ const surfaceCommands = [
 					{
 						name: "address",
 						jsonPath: ["address"],
-						description: "The site's structured address. Takes only null, which clears it",
+						description: "The site's structured address, which a zone refuses. Takes only null, which clears it",
 						valueName: "null",
 						nullable: true,
 						schema: z.null()
@@ -9610,7 +9640,7 @@ const surfaceCommands = [
 					{
 						name: "consignee",
 						jsonPath: ["consignee"],
-						description: "The ID of the customer a zone is designated for, such as for reservations, provisioning or a 3PL",
+						description: "The ID of the customer a zone is designated for, such as for reservations, provisioning or a 3PL, which a site refuses",
 						valueName: "uuid",
 						nullable: true,
 						schema: z.uuid()
@@ -9618,7 +9648,7 @@ const surfaceCommands = [
 					{
 						name: "customer-id",
 						jsonPath: ["customerId"],
-						description: "The ID of the customer to assign a site to, or null for your organization's own site",
+						description: "The ID of the customer to assign a site to, or null for your organization's own site, which a zone refuses",
 						valueName: "uuid",
 						nullable: true,
 						schema: z.uuid()
@@ -9626,7 +9656,7 @@ const surfaceCommands = [
 					{
 						name: "description",
 						jsonPath: ["description"],
-						description: "A free-form description of a zone",
+						description: "A free-form description of a zone, which a site refuses",
 						valueName: "value",
 						nullable: true,
 						schema: z.string()
@@ -9648,7 +9678,7 @@ const surfaceCommands = [
 					{
 						name: "is-transient",
 						jsonPath: ["isTransient"],
-						description: "Whether assets make only occasional or temporary stops at the location, which hides it from location lists by default",
+						description: "Whether assets make only occasional or temporary stops at the location, which hides it from location lists by default, and which a zone refuses",
 						negatable: true,
 						schema: z.boolean()
 					},
@@ -14483,5 +14513,5 @@ async function toReported(error, isJSON, resolved, level = "error") {
 //#endregion
 export { toCli, toParseExitCode, toReported, wasReportAttempted, writeCrash };
 
-//# sourceMappingURL=program-CuFKCoDH.js.map
-//# debugId=9993eb69-9e2e-5536-98a5-fb924deec820
+//# sourceMappingURL=program-CTAOEcIl.js.map
+//# debugId=0e61ba79-b67a-56d5-a2fd-a7a450bc463c

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hardfin/cli",
-    "version": "0.1.1-dev.75",
+    "version": "0.1.1-dev.77",
     "description": "Command line interface for the Hardfin API",
     "license": "Apache-2.0",
     "author": "Hardfin, Inc.",