✨ feat(core): add i18n for parameter errors

Author: so1ve

packages/core/src/cli.ts

@@ -356,7 +356,7 @@ export class Clerc<C extends CommandRecord = {}> {
           argv: resolveArgv(),
           ...optionsOrArgv,
         };
-    this.#argv = argv;
+    this.#argv = [...argv];
     this.#validateMeta();
     if (run) {
       this.runMatchedCommand();
@@ -379,6 +379,7 @@ export class Clerc<C extends CommandRecord = {}> {
 
   #getContext(getCommand: () => ReturnType<typeof resolveCommand>) {
     const argv = this.#argv!;
+    const { t } = this.i18n;
     const [command, called] = getCommand();
     const isCommandResolved = !!command;
     // [...argv] is a workaround since TypeFlag modifies argv
@@ -398,19 +399,22 @@ export class Clerc<C extends CommandRecord = {}> {
 
       mapParametersToArguments(
         mapping,
-        parseParameters(commandParameters),
+        parseParameters(commandParameters, t),
         parameters,
+        t,
       );
       mapParametersToArguments(
         mapping,
-        parseParameters(eofParameters),
+        parseParameters(eofParameters, t),
         eofArguments,
+        t,
       );
     } else {
       mapParametersToArguments(
         mapping,
-        parseParameters(commandParameters),
+        parseParameters(commandParameters, t),
         parameters,
+        t,
       );
     }
     const mergedFlags = { ...flags, ...unknownFlags };

packages/core/src/locales.ts

@@ -12,6 +12,11 @@ export const locales: Locales = {
     "core.badNameFormat": "Bad name format: %s.",
     "core.localeMustBeCalledFirst": "locale() or fallbackLocale() must be called at first.",
     "core.cliParseMustBeCalled": "cli.parse() must be called.",
+    "core.spreadParameterMustBeLast": "Invalid Parameter: Spread parameter %s must be last.",
+    "core.requiredParameterCannotComeAfterOptionalParameter": "Invalid Parameter: Required parameter %s cannot come after optional parameter %s.",
+    "core.parameterMustBeWrappedInBrackets": "Invalid Parameter: Parameter %s must be wrapped in <> (required parameter) or [] (optional parameter).",
+    "core.parameterIsUsedMoreThanOnce": "Invalid Parameter: Parameter %s is used more than once.",
+    "core.missingRequiredParameter": "Missing required parameter %s.",
   },
   "zh-CN": {
     "core.commandExists": "命令 \"%s\" 已存在。",
@@ -24,5 +29,10 @@ export const locales: Locales = {
     "core.badNameFormat": "错误的命令名字格式: %s。",
     "core.localeMustBeCalledFirst": "locale() 或 fallbackLocale() 必须在最开始调用。",
     "core.cliParseMustBeCalled": "cli.parse() 必须被调用。",
+    "core.spreadParameterMustBeLast": "不合法的参数: 展开参数 %s 必须在最后。",
+    "core.requiredParameterCannotComeAfterOptionalParameter": "不合法的参数: 必填参数 %s 不能在可选参数 %s 之后。",
+    "core.parameterMustBeWrappedInBrackets": "不合法的参数: 参数 %s 必须被 <> (必填参数) 或 [] (可选参数) 包裹。",
+    "core.parameterIsUsedMoreThanOnce": "不合法的参数: 参数 %s 被使用了多次。",
+    "core.missingRequiredParameter": "缺少必填参数 %s。",
   },
 };

packages/core/src/parameters.ts

@@ -2,6 +2,8 @@
 // Thanks for his awesome work!
 import { camelCase } from "@clerc/utils";
 
+import type { TranslateFn } from "./types";
+
 const { stringify } = JSON;
 
 interface ParsedParameter {
@@ -10,15 +12,15 @@ interface ParsedParameter {
   spread: boolean
 }
 
-export function parseParameters(parameters: string[]) {
+export function parseParameters(parameters: string[], t: TranslateFn) {
   const parsedParameters: ParsedParameter[] = [];
 
   let hasOptional: string | undefined;
   let hasSpread: string | undefined;
 
   for (const parameter of parameters) {
     if (hasSpread) {
-      throw new Error(`Invalid parameter: Spread parameter ${stringify(hasSpread)} must be last`);
+      throw new Error (t("core.spreadParameterMustBeLast", stringify(hasSpread)));
     }
 
     const firstCharacter = parameter[0];
@@ -29,7 +31,7 @@ export function parseParameters(parameters: string[]) {
       required = true;
 
       if (hasOptional) {
-        throw new Error(`Invalid parameter: Required parameter ${stringify(parameter)} cannot come after optional parameter ${stringify(hasOptional)}`);
+        throw new Error(t("core.requiredParameterMustBeBeforeOptional", stringify(parameter), stringify(hasOptional)));
       }
     }
 
@@ -39,7 +41,7 @@ export function parseParameters(parameters: string[]) {
     }
 
     if (required === undefined) {
-      throw new Error(`Invalid parameter: ${stringify(parameter)}. Must be wrapped in <> (required parameter) or [] (optional parameter)`);
+      throw new Error(t("core.parameterMustBeWrappedInBrackets", stringify(parameter)));
     }
 
     let name = parameter.slice(1, -1);
@@ -65,12 +67,13 @@ export function mapParametersToArguments(
   mapping: Record<string, string | string[]>,
   parameters: ParsedParameter[],
   cliArguments: string[],
+  t: TranslateFn,
 ) {
   for (let i = 0; i < parameters.length; i += 1) {
     const { name, required, spread } = parameters[i];
     const camelCaseName = camelCase(name);
     if (camelCaseName in mapping) {
-      throw new Error(`Invalid parameter: ${stringify(name)} is used more than once.`);
+      throw new Error(t("core.parameterIsUsedMoreThanOnce", stringify(name)));
     }
 
     const value = spread ? cliArguments.slice(i) : cliArguments[i];
@@ -83,7 +86,7 @@ export function mapParametersToArguments(
       required
       && (!value || (spread && value.length === 0))
     ) {
-      throw new Error(`Missing required parameter ${stringify(name)}`);
+      throw new Error(t("core.missingRequiredParameter", stringify(name)));
     }
 
     mapping[camelCaseName] = value;