clerc 1.0.0-beta.2 → 1.0.0-beta.21

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,7 +1,23 @@
-import { Plugin } from "@clerc/core";
+import { n as __reExport, t as __export } from "./chunk-CYeTv9WL.js";
+import { Clerc, CreateOptions, Plugin } from "@clerc/core";
 export * from "@clerc/core";
 
 //#region ../plugin-completions/src/index.d.ts
+declare module "@clerc/core" {
+  interface CommandCustomOptions {
+    /**
+    * Completions options for the command.
+    */
+    completions?: {
+      /**
+      * Whether to show the command in completions output.
+      *
+      * @default true
+      */
+      show?: boolean;
+    };
+  }
+}
 interface CompletionsPluginOptions {
   /**
   * Whether to register the `completions install` and `completions uninstall` commands.
@@ -20,40 +36,143 @@ 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;
-type FlagType<T = unknown> = FlagTypeFunction<T> | readonly [FlagTypeFunction<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.
+  */
+  display?: string;
+}
+type FlagType<T = unknown> = TypeFunction<T> | readonly [TypeFunction<T>];
 //#endregion
 //#region ../plugin-help/src/types.d.ts
 interface Formatters {
   formatFlagType: (type: FlagType) => string;
+  formatFlagDefault: <T>(value: FlagDefaultValue<T>) => string;
+}
+/**
+* A group definition as a tuple of [key, displayName].
+* The key is used in help options to assign items to groups.
+* The displayName is shown in the help output.
+*/
+type GroupDefinition = [key: string, name: string];
+/**
+* Options for defining groups in help output.
+*/
+interface GroupsOptions {
+  /**
+  * Groups for commands.
+  * Each group is defined as `[key, name]`.
+  */
+  commands?: GroupDefinition[];
+  /**
+  * Groups for command-specific flags.
+  * Each group is defined as `[key, name]`.
+  */
+  flags?: GroupDefinition[];
+  /**
+  * Groups for global flags.
+  * Each group is defined as `[key, name]`.
+  */
+  globalFlags?: GroupDefinition[];
 }
 //#endregion
 //#region ../plugin-help/src/formatters.d.ts
 declare const defaultFormatters: Formatters;
 //#endregion
 //#region ../plugin-help/src/index.d.ts
+interface HelpOptions {
+  /**
+  * The group this item belongs to.
+  * The group must be defined in the `groups` option of `helpPlugin()`.
+  */
+  group?: string;
+}
+interface CommandHelpOptions extends HelpOptions {
+  /**
+  * Whether to show the command in help output.
+  *
+  * @default true
+  */
+  show?: boolean;
+  /**
+  * Notes to show in the help output.
+  */
+  notes?: string[];
+  /**
+  * Examples to show in the help output.
+  * Each example is a tuple of `[command, description]`.
+  */
+  examples?: [string, string][];
+}
 declare module "@clerc/core" {
   interface CommandCustomOptions {
-    help?: {
-      showInHelp?: boolean;
-      notes?: string[];
-      examples?: [string, string][];
-    };
+    /**
+    * Help options for the command.
+    */
+    help?: CommandHelpOptions;
+  }
+  interface FlagCustomOptions {
+    /**
+    * Help options for the flag.
+    */
+    help?: HelpOptions;
   }
 }
 interface HelpPluginOptions {
+  /**
+  * Whether to register the `help` command.
+  *
+  * @default true
+  */
   command?: boolean;
+  /**
+  * Whether to register the `--help` global flag.
+  *
+  * @default true
+  */
   flag?: boolean;
+  /**
+  * Whether to show help when no command is specified.
+  *
+  * @default true
+  */
   showHelpWhenNoCommandSpecified?: boolean;
+  /**
+  * Notes to show in the help output.
+  */
   notes?: string[];
+  /**
+  * Examples to show in the help output.
+  * Each example is a tuple of `[command, description]`.
+  */
   examples?: [string, string][];
+  /**
+  * A banner to show before the help output.
+  */
   banner?: string;
+  /**
+  * Custom formatters for rendering help.
+  */
   formatters?: Partial<Formatters>;
+  /**
+  * Group definitions for commands and flags.
+  * Groups allow organizing commands and flags into logical sections in help output.
+  * Each group is defined as `[key, name]` where `key` is the identifier used in help options
+  * and `name` is the display name shown in help output.
+  */
+  groups?: GroupsOptions;
 }
 declare const helpPlugin: ({
   command,
@@ -62,7 +181,8 @@ declare const helpPlugin: ({
   notes,
   examples,
   banner,
-  formatters
+  formatters,
+  groups
 }?: HelpPluginOptions) => Plugin;
 //#endregion
 //#region ../plugin-not-found/src/index.d.ts
@@ -90,5 +210,9 @@ declare const versionPlugin: ({
   command,
   flag
 }?: VersionPluginOptions) => Plugin;
+declare namespace index_d_exports {
+  export { Cli, CommandHelpOptions, CompletionsPluginOptions, FriendlyErrorPluginOptions, GroupDefinition, GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
+}
+declare const Cli: (options?: CreateOptions) => Clerc;
 //#endregion
-export { CompletionsPluginOptions, FriendlyErrorPluginOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
+export { Cli, CommandHelpOptions, CompletionsPluginOptions, 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.2",
+  "version": "1.0.0-beta.21",
   "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.2",
-    "@clerc/plugin-help": "1.0.0-beta.2",
-    "@clerc/plugin-completions": "1.0.0-beta.2",
-    "@clerc/plugin-not-found": "1.0.0-beta.2",
-    "@clerc/plugin-friendly-error": "1.0.0-beta.2",
-    "@clerc/plugin-strict-flags": "1.0.0-beta.2",
-    "@clerc/plugin-version": "1.0.0-beta.2"
-  },
-  "scripts": {
-    "build": "tsdown",
-    "watch": "tsdown --watch"
+    "@clerc/core": "1.0.0-beta.21",
+    "@clerc/plugin-friendly-error": "1.0.0-beta.21",
+    "@clerc/plugin-not-found": "1.0.0-beta.21",
+    "@clerc/plugin-version": "1.0.0-beta.21",
+    "@clerc/plugin-strict-flags": "1.0.0-beta.21",
+    "@clerc/plugin-completions": "1.0.0-beta.21",
+    "@clerc/plugin-help": "1.0.0-beta.21"
   }
 }