clerc 1.0.0-beta.3 → 1.0.0-beta.30

package/dist/chunk-CYeTv9WL.js

@@ -0,0 +1,42 @@
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __reExport = (target, mod, secondTarget, symbols) => {
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+		secondTarget && __defProp(secondTarget, Symbol.toStringTag, { value: "Module" });
+	}
+	__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default");
+};
+
+//#endregion
+export { __reExport as n, __export as t };

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-import { Plugin } from "@clerc/core";
+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
@@ -14,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 {
@@ -35,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].
@@ -151,9 +185,13 @@ interface HelpPluginOptions {
   */
   examples?: [string, string][];
   /**
-  * A banner to show before the help output.
+  * Header to show before the help output.
   */
-  banner?: string;
+  header?: string;
+  /**
+  * Footer to show after the help output.
+  */
+  footer?: string;
   /**
   * Custom formatters for rendering help.
   */
@@ -172,7 +210,8 @@ declare const helpPlugin: ({
   showHelpWhenNoCommandSpecified,
   notes,
   examples,
-  banner,
+  header,
+  footer,
   formatters,
   groups
 }?: HelpPluginOptions) => Plugin;
@@ -202,5 +241,9 @@ declare const versionPlugin: ({
   command,
   flag
 }?: VersionPluginOptions) => Plugin;
+declare namespace index_d_exports {
+  export { Cli, CommandHelpOptions, FriendlyErrorPluginOptions, GroupDefinition, GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
+}
+declare const Cli: (options?: CreateOptions) => Clerc;
 //#endregion
-export { 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/dist/index.js

@@ -1,15 +1,25 @@
+import { n as __reExport, t as __export } from "./chunk-CYeTv9WL.js";
+import { Clerc } from "@clerc/core";
+import { helpPlugin } from "@clerc/plugin-help";
+import { versionPlugin } from "@clerc/plugin-version";
+
 export * from "@clerc/core"
 
+export * from "@clerc/plugin-help"
+
+export * from "@clerc/plugin-version"
+
 export * from "@clerc/plugin-completions"
 
 export * from "@clerc/plugin-friendly-error"
 
-export * from "@clerc/plugin-help"
-
 export * from "@clerc/plugin-not-found"
 
 export * from "@clerc/plugin-strict-flags"
 
-export * from "@clerc/plugin-version"
+//#region src/index.ts
+var src_exports = /* @__PURE__ */ __export({ Cli: () => Cli });
+const Cli = (options) => Clerc.create(options).use(versionPlugin()).use(helpPlugin());
 
-export {  };
+//#endregion
+export { Cli };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clerc",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.30",
   "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.3",
-    "@clerc/plugin-completions": "1.0.0-beta.3",
-    "@clerc/plugin-friendly-error": "1.0.0-beta.3",
-    "@clerc/plugin-help": "1.0.0-beta.3",
-    "@clerc/plugin-not-found": "1.0.0-beta.3",
-    "@clerc/plugin-version": "1.0.0-beta.3",
-    "@clerc/plugin-strict-flags": "1.0.0-beta.3"
-  },
-  "scripts": {
-    "build": "tsdown",
-    "watch": "tsdown --watch"
+    "@clerc/core": "1.0.0-beta.30",
+    "@clerc/plugin-completions": "1.0.0-beta.30",
+    "@clerc/plugin-friendly-error": "1.0.0-beta.30",
+    "@clerc/plugin-not-found": "1.0.0-beta.30",
+    "@clerc/plugin-help": "1.0.0-beta.30",
+    "@clerc/plugin-strict-flags": "1.0.0-beta.30",
+    "@clerc/plugin-version": "1.0.0-beta.30"
   }
 }