@clerc/core 0.41.0 → 0.42.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Ray <https://github.com/so1ve>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Ray <https://github.com/so1ve>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,7 +2,7 @@
 
 [![NPM version](https://img.shields.io/npm/v/@clerc/core?color=a1b858&label=)](https://www.npmjs.com/package/@clerc/core)
 
-See [Clerc](https://github.com/so1ve/clerc) for documentation.
+See [Clerc](https://github.com/clercjs/clerc) for documentation.
 
 ## 📝 License
 

package/dist/index.d.ts

@@ -92,10 +92,10 @@ type ParseRaw<C extends Command, GF extends GlobalFlagOptions = {}> = NonNullabl
 type ParseParameters<C extends Commands = Commands, N extends keyof C = keyof C> = Equals<TransformParameters<C[N]>, {}> extends true ? N extends keyof C ? TransformParameters<C[N]> : Dict<string | string[] | undefined> : TransformParameters<C[N]>;
 
 type Locales = Dict<Dict<string>>;
-type TranslateFn = (name: string, ...args: string[]) => string | undefined;
+type TranslateFunction = (name: string, ...arguments_: string[]) => string | undefined;
 interface I18N {
     add: (locales: Locales) => void;
-    t: TranslateFn;
+    t: TranslateFunction;
 }
 
 interface Plugin<T extends Clerc = Clerc, U extends Clerc = Clerc> {
@@ -148,19 +148,19 @@ interface HandlerContext<C extends Commands = Commands, N extends keyof C = keyo
     flags: Simplify<ParseFlag<C, N, GF> & Record<string, any>>;
     cli: Clerc<C, GF>;
 }
-type Handler<C extends Commands = Commands, K extends keyof C = keyof C, GF extends GlobalFlagOptions = {}> = (ctx: HandlerContext<C, K, GF>) => void;
-type HandlerInCommand<C extends HandlerContext> = (ctx: {
+type Handler<C extends Commands = Commands, K extends keyof C = keyof C, GF extends GlobalFlagOptions = {}> = (context: HandlerContext<C, K, GF>) => void;
+type HandlerInCommand<C extends HandlerContext> = (context: {
     [K in keyof C]: C[K];
 }) => void;
 type FallbackType<T, U> = {} extends T ? U : T;
 type InspectorContext<C extends Commands = Commands> = HandlerContext<C> & {
     flags: FallbackType<TypeFlag<NonNullable<C[keyof C]["flags"]>>["flags"], Dict<any>>;
 };
-type Inspector<C extends Commands = Commands> = InspectorFn<C> | InspectorObject<C>;
-type InspectorFn<C extends Commands = Commands> = (ctx: InspectorContext<C>, next: () => void) => void;
+type Inspector<C extends Commands = Commands> = InspectorFunction<C> | InspectorObject<C>;
+type InspectorFunction<C extends Commands = Commands> = (context: InspectorContext<C>, next: () => void) => void;
 interface InspectorObject<C extends Commands = Commands> {
     enforce?: "pre" | "post";
-    fn: InspectorFn<C>;
+    fn: InspectorFunction<C>;
 }
 
 declare const Root: unique symbol;
@@ -282,14 +282,14 @@ declare class Clerc<C extends Commands = {}, GF extends GlobalFlagOptions = {}>
      *
      * ```ts
      * Clerc.create().errorHandler((err) => {
-     *   console.log(err);
+     * 	console.log(err);
      * });
      * ```
      *
      * @param handler
      * @returns
      */
-    errorHandler(handler: (err: any) => void): this;
+    errorHandler(handler: (error: any) => void): this;
     /**
      * Register a command
      *
@@ -297,13 +297,13 @@ declare class Clerc<C extends Commands = {}, GF extends GlobalFlagOptions = {}>
      *
      * ```ts
      * Clerc.create().command("test", "test command", {
-     *   alias: "t",
-     *   flags: {
-     *     foo: {
-     *       alias: "f",
-     *       description: "foo flag",
-     *     },
-     *   },
+     * 	alias: "t",
+     * 	flags: {
+     * 		foo: {
+     * 			alias: "f",
+     * 			description: "foo flag",
+     * 		},
+     * 	},
      * });
      * ```
      *
@@ -311,12 +311,12 @@ declare class Clerc<C extends Commands = {}, GF extends GlobalFlagOptions = {}>
      *
      * ```ts
      * Clerc.create().command("", "root", {
-     *   flags: {
-     *     foo: {
-     *       alias: "f",
-     *       description: "foo flag",
-     *     },
-     *   },
+     * 	flags: {
+     * 		foo: {
+     * 			alias: "f",
+     * 			description: "foo flag",
+     * 		},
+     * 	},
      * });
      * ```
      *
@@ -334,8 +334,8 @@ declare class Clerc<C extends Commands = {}, GF extends GlobalFlagOptions = {}>
      *
      * ```ts
      * Clerc.create().flag("help", "help", {
-     *   alias: "h",
-     *   type: Boolean,
+     * 	alias: "h",
+     * 	type: Boolean,
      * });
      * ```
      *
@@ -352,10 +352,10 @@ declare class Clerc<C extends Commands = {}, GF extends GlobalFlagOptions = {}>
      *
      * ```ts
      * Clerc.create()
-     *   .command("test", "test command")
-     *   .on("test", (ctx) => {
-     *     console.log(ctx);
-     *   });
+     * 	.command("test", "test command")
+     * 	.on("test", (ctx) => {
+     * 		console.log(ctx);
+     * 	});
      * ```
      *
      * @param name
@@ -383,8 +383,8 @@ declare class Clerc<C extends Commands = {}, GF extends GlobalFlagOptions = {}>
      *
      * ```ts
      * Clerc.create().inspector((ctx, next) => {
-     *   console.log(ctx);
-     *   next();
+     * 	console.log(ctx);
+     * 	next();
      * });
      * ```
      *
@@ -422,35 +422,35 @@ declare class Clerc<C extends Commands = {}, GF extends GlobalFlagOptions = {}>
 
 declare class CommandExistsError extends Error {
     commandName: string;
-    constructor(commandName: string, t: TranslateFn);
+    constructor(commandName: string, t: TranslateFunction);
 }
 declare class NoSuchCommandError extends Error {
     commandName: string;
-    constructor(commandName: string, t: TranslateFn);
+    constructor(commandName: string, t: TranslateFunction);
 }
 declare class NoCommandGivenError extends Error {
-    constructor(t: TranslateFn);
+    constructor(t: TranslateFunction);
 }
 declare class CommandNameConflictError extends Error {
     n1: string;
     n2: string;
-    constructor(n1: string, n2: string, t: TranslateFn);
+    constructor(n1: string, n2: string, t: TranslateFunction);
 }
 declare class ScriptNameNotSetError extends Error {
-    constructor(t: TranslateFn);
+    constructor(t: TranslateFunction);
 }
 declare class DescriptionNotSetError extends Error {
-    constructor(t: TranslateFn);
+    constructor(t: TranslateFunction);
 }
 declare class VersionNotSetError extends Error {
-    constructor(t: TranslateFn);
+    constructor(t: TranslateFunction);
 }
 declare class InvalidCommandNameError extends Error {
     commandName: string;
-    constructor(commandName: string, t: TranslateFn);
+    constructor(commandName: string, t: TranslateFunction);
 }
 declare class LocaleNotCalledFirstError extends Error {
-    constructor(t: TranslateFn);
+    constructor(t: TranslateFunction);
 }
 
 type MaybeArray<T> = T | T[];
@@ -460,14 +460,14 @@ declare const defineHandler: <C extends Clerc<{}, {}>, K extends keyof C["_comma
 declare const defineInspector: <C extends Clerc<{}, {}>>(_cli: C, inspector: Inspector<C["_commands"]>) => Inspector<C["_commands"]>;
 declare const defineCommand: <N extends string | typeof Root, O extends CommandOptions<[...P], MaybeArray<string | typeof Root>, Flags>, P extends string[]>(command: Command<N, O & CommandOptions<[...P], MaybeArray<string | typeof Root>, Flags>>, handler?: HandlerInCommand<HandlerContext<Record<N, Command<N, O>> & Record<never, never>, N, {}>> | undefined) => CommandWithHandler<N, O & CommandOptions<[...P], MaybeArray<string | typeof Root>, Flags>>;
 
-declare function resolveFlattenCommands(commands: Commands, t: TranslateFn): Map<string[] | typeof Root, CommandAlias>;
-declare function resolveCommand(commands: Commands, argv: string[], t: TranslateFn): [Command<string | RootType> | undefined, string[] | RootType | undefined];
+declare function resolveFlattenCommands(commands: Commands, t: TranslateFunction): Map<string[] | typeof Root, CommandAlias>;
+declare function resolveCommand(commands: Commands, argv: string[], t: TranslateFunction): [Command<string | RootType> | undefined, string[] | RootType | undefined];
 declare const resolveArgv: () => string[];
-declare function compose(inspectors: Inspector[]): (ctx: InspectorContext) => void;
+declare function compose(inspectors: Inspector[]): (context: InspectorContext) => void;
 declare const isValidName: (name: CommandType) => boolean;
 declare const withBrackets: (s: string, isOptional?: boolean) => string;
 declare const formatCommandName: (name: string | string[] | RootType) => string;
 declare const detectLocale: () => string;
 declare const stripFlags: (argv: string[]) => string[];
 
-export { Clerc, Command, CommandAlias, CommandCustomProperties, CommandExistsError, CommandNameConflictError, CommandOptions, CommandType, CommandWithHandler, Commands, DescriptionNotSetError, FallbackType, Flag, FlagOptions, Flags, GlobalFlagOption, GlobalFlagOptions, Handler, HandlerContext, HandlerInCommand, I18N, Inspector, InspectorContext, InspectorFn, InspectorObject, InvalidCommandNameError, LocaleNotCalledFirstError, Locales, MakeEventMap, NoCommandGivenError, NoSuchCommandError, ParseOptions, Plugin, Root, RootType, ScriptNameNotSetError, TranslateFn, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, detectLocale, formatCommandName, isValidName, resolveArgv, resolveCommand, resolveFlattenCommands, stripFlags, withBrackets };
+export { Clerc, Command, CommandAlias, CommandCustomProperties, CommandExistsError, CommandNameConflictError, CommandOptions, CommandType, CommandWithHandler, Commands, DescriptionNotSetError, FallbackType, Flag, FlagOptions, Flags, GlobalFlagOption, GlobalFlagOptions, Handler, HandlerContext, HandlerInCommand, I18N, Inspector, InspectorContext, InspectorFunction, InspectorObject, InvalidCommandNameError, LocaleNotCalledFirstError, Locales, MakeEventMap, NoCommandGivenError, NoSuchCommandError, ParseOptions, Plugin, Root, RootType, ScriptNameNotSetError, TranslateFunction, VersionNotSetError, compose, defineCommand, defineHandler, defineInspector, definePlugin, detectLocale, formatCommandName, isValidName, resolveArgv, resolveCommand, resolveFlattenCommands, stripFlags, withBrackets };

package/dist/index.js

@@ -144,15 +144,15 @@ function parseParameters(parameters, t) {
   return parsedParameters;
 }
 function mapParametersToArguments(mapping, parameters, cliArguments, t) {
-  for (let i = 0; i < parameters.length; i += 1) {
-    const { name, required, spread } = parameters[i];
+  for (let index = 0; index < parameters.length; index += 1) {
+    const { name, required, spread } = parameters[index];
     const camelCaseName = camelCase(name);
     if (camelCaseName in mapping) {
       throw new Error(t("core.parameterIsUsedMoreThanOnce", stringify(name)));
     }
-    const value = spread ? cliArguments.slice(i) : cliArguments[i];
+    const value = spread ? cliArguments.slice(index) : cliArguments[index];
     if (spread) {
-      i = parameters.length;
+      index = parameters.length;
     }
     if (required && (!value || spread && value.length === 0)) {
       throw new Error(t("core.missingRequiredParameter", stringify(name)));
@@ -196,11 +196,11 @@ function resolveCommand(commands, argv, t) {
   const commandsMap = resolveFlattenCommands(commands, t);
   for (const [name, command] of commandsMap.entries()) {
     const parsed = typeFlag((_a = command == null ? void 0 : command.flags) != null ? _a : /* @__PURE__ */ Object.create(null), [...argv]);
-    const { _: args } = parsed;
+    const { _: arguments_ } = parsed;
     if (name === Root) {
       continue;
     }
-    if (arrayStartsWith(args, name)) {
+    if (arrayStartsWith(arguments_, name)) {
       return [command, name];
     }
   }
@@ -228,16 +228,16 @@ function compose(inspectors) {
       inspectorMap.normal.push(fn);
     }
   }
-  const mergedInspectorFns = [
+  const mergedInspectorFunctions = [
     ...inspectorMap.pre,
     ...inspectorMap.normal,
     ...inspectorMap.post
   ];
-  return (ctx) => {
+  return (context) => {
     return dispatch(0);
-    function dispatch(i) {
-      const inspector = mergedInspectorFns[i];
-      return inspector(ctx, dispatch.bind(null, i + 1));
+    function dispatch(index) {
+      const inspector = mergedInspectorFunctions[index];
+      return inspector(context, dispatch.bind(null, index + 1));
     }
   };
 }
@@ -247,7 +247,7 @@ const withBrackets = (s, isOptional) => isOptional ? `[${s}]` : `<${s}>`;
 const ROOT = "<Root>";
 const formatCommandName = (name) => Array.isArray(name) ? name.join(" ") : typeof name === "string" ? name : ROOT;
 const detectLocale = () => process.env.CLERC_LOCALE ? process.env.CLERC_LOCALE : Intl.DateTimeFormat().resolvedOptions().locale;
-const stripFlags = (argv) => argv.filter((arg) => !arg.startsWith("-"));
+const stripFlags = (argv) => argv.filter((argument) => !argument.startsWith("-"));
 
 var __accessCheck = (obj, member, msg) => {
   if (!member.has(obj))
@@ -303,10 +303,10 @@ const _Clerc = class {
       add: (locales2) => {
         __privateSet(this, _locales, defu(__privateGet(this, _locales), locales2));
       },
-      t: (name, ...args) => {
+      t: (name, ...arguments_) => {
         const localeObject = __privateGet(this, _locales)[__privateGet(this, _locale)] || __privateGet(this, _locales)[__privateGet(this, _defaultLocale)];
         const defaultLocaleObject = __privateGet(this, _locales)[__privateGet(this, _defaultLocale)];
-        return localeObject[name] ? format(localeObject[name], ...args) : defaultLocaleObject[name] ? format(defaultLocaleObject[name], ...args) : void 0;
+        return localeObject[name] ? format(localeObject[name], ...arguments_) : defaultLocaleObject[name] ? format(defaultLocaleObject[name], ...arguments_) : void 0;
       }
     };
     __privateSet(this, _scriptName, scriptName != null ? scriptName : __privateGet(this, _scriptName));
@@ -472,7 +472,7 @@ const _Clerc = class {
    *
    * ```ts
    * Clerc.create().errorHandler((err) => {
-   *   console.log(err);
+   * 	console.log(err);
    * });
    * ```
    *
@@ -494,8 +494,8 @@ const _Clerc = class {
    *
    * ```ts
    * Clerc.create().flag("help", "help", {
-   *   alias: "h",
-   *   type: Boolean,
+   * 	alias: "h",
+   * 	type: Boolean,
    * });
    * ```
    *
@@ -518,10 +518,10 @@ const _Clerc = class {
    *
    * ```ts
    * Clerc.create()
-   *   .command("test", "test command")
-   *   .on("test", (ctx) => {
-   *     console.log(ctx);
-   *   });
+   * 	.command("test", "test command")
+   * 	.on("test", (ctx) => {
+   * 		console.log(ctx);
+   * 	});
    * ```
    *
    * @param name
@@ -555,8 +555,8 @@ const _Clerc = class {
    *
    * ```ts
    * Clerc.create().inspector((ctx, next) => {
-   *   console.log(ctx);
-   *   next();
+   * 	console.log(ctx);
+   * 	next();
    * });
    * ```
    *
@@ -698,15 +698,15 @@ getContext_fn = function(getCommand) {
     ...command == null ? void 0 : command.flags
   };
   const parsed = typeFlag(flagsMerged, [...argv]);
-  const { _: args, flags, unknownFlags } = parsed;
-  let parameters = !isCommandResolved || command.name === Root ? args : args.slice(command.name.split(" ").length);
+  const { _: arguments_, flags, unknownFlags } = parsed;
+  let parameters = !isCommandResolved || command.name === Root ? arguments_ : arguments_.slice(command.name.split(" ").length);
   let commandParameters = (_a = command == null ? void 0 : command.parameters) != null ? _a : [];
   const hasEof = commandParameters.indexOf("--");
   const eofParameters = commandParameters.slice(hasEof + 1) || [];
   const mapping = /* @__PURE__ */ Object.create(null);
   if (hasEof > -1 && eofParameters.length > 0) {
     commandParameters = commandParameters.slice(0, hasEof);
-    const eofArguments = args["--"];
+    const eofArguments = arguments_["--"];
     parameters = parameters.slice(0, -eofArguments.length || void 0);
     mapParametersToArguments(
       mapping,
@@ -744,16 +744,16 @@ getContext_fn = function(getCommand) {
   return context;
 };
 _callWithErrorHandling = new WeakSet();
-callWithErrorHandling_fn = function(fn) {
+callWithErrorHandling_fn = function(function_) {
   try {
-    fn();
-  } catch (e) {
+    function_();
+  } catch (error) {
     if (__privateGet(this, _errorHandlers).length > 0) {
-      for (const cb of __privateGet(this, _errorHandlers)) {
-        cb(e);
+      for (const callback of __privateGet(this, _errorHandlers)) {
+        callback(error);
       }
     } else {
-      throw e;
+      throw error;
     }
   }
 };
@@ -769,14 +769,14 @@ runMatchedCommand_fn = function() {
   const getContext = () => __privateMethod(this, _getContext, getContext_fn).call(this, getCommand);
   const emitHandler = {
     enforce: "post",
-    fn: (ctx) => {
+    fn: (context) => {
       const [command] = getCommand();
       const stringName = stripFlags(argv).join(" ");
       if (!command) {
         const error = stringName ? new NoSuchCommandError(stringName, t) : new NoCommandGivenError(t);
         throw error;
       }
-      __privateGet(this, _commandEmitter).emit(command.name, ctx);
+      __privateGet(this, _commandEmitter).emit(command.name, context);
     }
   };
   const inspectors = [...__privateGet(this, _inspectors), emitHandler];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/core",
-  "version": "0.41.0",
+  "version": "0.42.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc core",
@@ -12,14 +12,14 @@
     "cli",
     "terminal"
   ],
-  "homepage": "https://github.com/so1ve/clerc/tree/main/packages/core#readme",
+  "homepage": "https://github.com/clercjs/clerc/tree/main/packages/core#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/so1ve/clerc.git",
+    "url": "git+https://github.com/clercjs/clerc.git",
     "directory": "/"
   },
   "bugs": {
-    "url": "https://github.com/so1ve/clerc/issues"
+    "url": "https://github.com/clercjs/clerc/issues"
   },
   "license": "MIT",
   "sideEffects": false,
@@ -50,9 +50,9 @@
     "defu": "^6.1.2",
     "is-platform": "^1.0.0",
     "lite-emit": "^2.2.0",
-    "type-fest": "^3.12.0",
+    "type-fest": "^4.0.0",
     "type-flag": "^3.0.0",
-    "@clerc/utils": "0.41.0"
+    "@clerc/utils": "0.42.0"
   },
   "scripts": {
     "build": "pkgroll",