clerc 1.0.2 → 1.1.0

package/README.md

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

package/dist/{chunk-CYeTv9WL.js → chunk-BwXVQOgl.mjs}

@@ -3,7 +3,7 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (all, symbols) => {
+var __exportAll = (all, symbols) => {
 	let target = {};
 	for (var name in all) {
 		__defProp(target, name, {
@@ -30,13 +30,7 @@ var __copyProps = (to, from, except, desc) => {
 	}
 	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");
-};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 
 //#endregion
-export { __reExport as n, __export as t };
+export { __reExport as n, __exportAll as t };

package/dist/index.d.mts

@@ -0,0 +1,18 @@
+import { n as __reExport, t as __exportAll } from "./chunk-BwXVQOgl.mjs";
+import { Clerc, CreateOptions } from "@clerc/core";
+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-not-found";
+export * from "@clerc/plugin-strict-flags";
+export * from "@clerc/plugin-update-notifier";
+
+//#region src/index.d.ts
+declare namespace index_d_exports {
+  export { Cli };
+}
+declare const Cli: (options?: CreateOptions) => Clerc;
+//#endregion
+export { Cli };

package/dist/{index.js → index.mjs}

@@ -1,4 +1,4 @@
-import { n as __reExport, t as __export } from "./chunk-CYeTv9WL.js";
+import { n as __reExport, t as __exportAll } from "./chunk-BwXVQOgl.mjs";
 import { Clerc } from "@clerc/core";
 import { helpPlugin } from "@clerc/plugin-help";
 import { versionPlugin } from "@clerc/plugin-version";
@@ -17,8 +17,10 @@ export * from "@clerc/plugin-not-found"
 
 export * from "@clerc/plugin-strict-flags"
 
+export * from "@clerc/plugin-update-notifier"
+
 //#region src/index.ts
-var src_exports = /* @__PURE__ */ __export({ Cli: () => Cli });
+var src_exports = /* @__PURE__ */ __exportAll({ Cli: () => Cli });
 const Cli = (options) => Clerc.create(options).use(versionPlugin()).use(helpPlugin());
 
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clerc",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc: The full-featured cli library.",
@@ -24,19 +24,12 @@
   "license": "MIT",
   "sideEffects": false,
   "exports": {
-    ".": "./dist/index.js"
-  },
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "dist/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "./dist/*",
-        "./dist/index.d.ts"
-      ]
-    }
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
   },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "files": [
     "dist"
   ],
@@ -44,12 +37,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@clerc/plugin-completions": "1.0.2",
-    "@clerc/core": "1.0.2",
-    "@clerc/plugin-friendly-error": "1.0.2",
-    "@clerc/plugin-help": "1.0.2",
-    "@clerc/plugin-strict-flags": "1.0.2",
-    "@clerc/plugin-version": "1.0.2",
-    "@clerc/plugin-not-found": "1.0.2"
+    "@clerc/core": "1.1.0",
+    "@clerc/plugin-completions": "1.1.0",
+    "@clerc/plugin-help": "1.1.0",
+    "@clerc/plugin-strict-flags": "1.1.0",
+    "@clerc/plugin-friendly-error": "1.1.0",
+    "@clerc/plugin-not-found": "1.1.0",
+    "@clerc/plugin-version": "1.1.0",
+    "@clerc/plugin-update-notifier": "1.1.0"
   }
 }

package/dist/index.d.ts

@@ -1,249 +0,0 @@
-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
-declare module "@clerc/core" {
-  interface CommandCustomOptions {
-    /**
-    * Completions options for the command.
-    */
-    completions?: {
-      /**
-      * Whether to show the command in completions output.
-      *
-      * @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;
-    };
-  }
-}
-declare const completionsPlugin: () => Plugin;
-//#endregion
-//#region ../plugin-friendly-error/src/index.d.ts
-interface FriendlyErrorPluginOptions {
-  target?: (str: string) => void;
-}
-declare const friendlyErrorPlugin: ({
-  target
-}?: 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.
-*/
-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 TypeValue<T = unknown> = TypeFunction<T> | readonly [TypeFunction<T>];
-//#endregion
-//#region ../plugin-help/src/types.d.ts
-interface Formatters {
-  formatTypeValue: (type: TypeValue) => 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 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][];
-  /**
-  * Header to show before the help output.
-  */
-  header?: string;
-  /**
-  * Footer to show after the help output.
-  */
-  footer?: 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,
-  flag,
-  showHelpWhenNoCommandSpecified,
-  notes,
-  examples,
-  header,
-  footer,
-  formatters,
-  groups
-}?: HelpPluginOptions) => Plugin;
-//#endregion
-//#region ../plugin-not-found/src/index.d.ts
-declare const notFoundPlugin: () => Plugin;
-//#endregion
-//#region ../plugin-strict-flags/src/index.d.ts
-declare const strictFlagsPlugin: () => Plugin;
-//#endregion
-//#region ../plugin-version/src/index.d.ts
-interface VersionPluginOptions {
-  /**
-  * Whether to register the version command.
-  *
-  * @default true
-  */
-  command?: boolean;
-  /**
-  * Whether to register the global version flag.
-  *
-  * @default true
-  */
-  flag?: boolean;
-}
-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 { Cli, CommandHelpOptions, FriendlyErrorPluginOptions, type GroupDefinition, type GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };