clerc 1.0.0-beta.8 → 1.0.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { n as __reExport, t as __export } from "./chunk-CYeTv9WL.js";
 import { Clerc, CreateOptions, Plugin } from "@clerc/core";
+import { ArgumentHandler, Command, OptionHandler } from "@bomb.sh/tab";
 export * from "@clerc/core";
 
 //#region ../plugin-completions/src/index.d.ts
@@ -15,17 +16,42 @@ declare module "@clerc/core" {
       * @default true
       */
       show?: boolean;
+      /**
+      * Handler to provide custom completions for the command.
+      */
+      handler?: (command: Command) => void;
+    };
+  }
+  interface FlagCustomOptions {
+    /**
+    * Completions options for the flag.
+    */
+    completions?: {
+      /**
+      * Whether to show the flag in completions output.
+      *
+      * @default true
+      */
+      show?: boolean;
+      /**
+      * Handler to provide custom completions for the flag.
+      */
+      handler?: OptionHandler;
+    };
+  }
+  interface ParameterCustomOptions {
+    /**
+    * Completions options for the parameter.
+    */
+    completions?: {
+      /**
+      * Handler to provide custom completions for the parameter.
+      */
+      handler?: ArgumentHandler;
     };
   }
 }
-interface CompletionsPluginOptions {
-  /**
-  * Whether to register the `completions install` and `completions uninstall` commands.
-  * @default true
-  */
-  managementCommands?: boolean;
-}
-declare const completionsPlugin: (options?: CompletionsPluginOptions) => Plugin;
+declare const completionsPlugin: () => Plugin;
 //#endregion
 //#region ../plugin-friendly-error/src/index.d.ts
 interface FriendlyErrorPluginOptions {
@@ -36,23 +62,30 @@ declare const friendlyErrorPlugin: ({
 }?: FriendlyErrorPluginOptions) => Plugin;
 //#endregion
 //#region ../parser/src/types.d.ts
+interface FlagDefaultValueFunction<T> {
+  (): T;
+  display?: string;
+}
+type FlagDefaultValue<T = unknown> = T | FlagDefaultValueFunction<T>;
 /**
 * Defines how a string input is converted to the target type T.
 *
 * @template T The target type.
 */
-type FlagTypeFunction<T = unknown> = ((value: string) => T) & {
+interface TypeFunction<T = unknown> {
+  (value: string): T;
   /**
   * Optional display name for the type, useful in help output.
   * If provided, this will be shown instead of the function name.
   */
-  displayName?: string;
-};
-type FlagType<T = unknown> = FlagTypeFunction<T> | readonly [FlagTypeFunction<T>];
+  display?: string;
+}
+type TypeValue<T = unknown> = TypeFunction<T> | readonly [TypeFunction<T>];
 //#endregion
 //#region ../plugin-help/src/types.d.ts
 interface Formatters {
-  formatFlagType: (type: FlagType) => string;
+  formatTypeValue: (type: TypeValue) => string;
+  formatFlagDefault: <T>(value: FlagDefaultValue<T>) => string;
 }
 /**
 * A group definition as a tuple of [key, displayName].
@@ -152,9 +185,13 @@ interface HelpPluginOptions {
   */
   examples?: [string, string][];
   /**
-  * A banner to show before the help output.
+  * Header to show before the help output.
+  */
+  header?: string;
+  /**
+  * Footer to show after the help output.
   */
-  banner?: string;
+  footer?: string;
   /**
   * Custom formatters for rendering help.
   */
@@ -173,7 +210,8 @@ declare const helpPlugin: ({
   showHelpWhenNoCommandSpecified,
   notes,
   examples,
-  banner,
+  header,
+  footer,
   formatters,
   groups
 }?: HelpPluginOptions) => Plugin;
@@ -204,8 +242,8 @@ declare const versionPlugin: ({
   flag
 }?: VersionPluginOptions) => Plugin;
 declare namespace index_d_exports {
-  export { Cli, CommandHelpOptions, CompletionsPluginOptions, FriendlyErrorPluginOptions, GroupDefinition, GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
+  export { Cli, CommandHelpOptions, FriendlyErrorPluginOptions, GroupDefinition, GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
 }
 declare const Cli: (options?: CreateOptions) => Clerc;
 //#endregion
-export { Cli, CommandHelpOptions, CompletionsPluginOptions, FriendlyErrorPluginOptions, type GroupDefinition, type GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
+export { Cli, CommandHelpOptions, FriendlyErrorPluginOptions, type GroupDefinition, type GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clerc",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc: The full-featured cli library.",
@@ -44,16 +44,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@clerc/core": "1.0.0-beta.8",
-    "@clerc/plugin-help": "1.0.0-beta.8",
-    "@clerc/plugin-completions": "1.0.0-beta.8",
-    "@clerc/plugin-not-found": "1.0.0-beta.8",
-    "@clerc/plugin-friendly-error": "1.0.0-beta.8",
-    "@clerc/plugin-version": "1.0.0-beta.8",
-    "@clerc/plugin-strict-flags": "1.0.0-beta.8"
-  },
-  "scripts": {
-    "build": "tsdown",
-    "watch": "tsdown --watch"
+    "@clerc/core": "1.0.0",
+    "@clerc/plugin-completions": "1.0.0",
+    "@clerc/plugin-friendly-error": "1.0.0",
+    "@clerc/plugin-help": "1.0.0",
+    "@clerc/plugin-not-found": "1.0.0",
+    "@clerc/plugin-version": "1.0.0",
+    "@clerc/plugin-strict-flags": "1.0.0"
   }
 }