@clerc/plugin-help 1.0.2 → 1.1.0

package/README.md

@@ -2,23 +2,9 @@
 
 [![NPM version](https://img.shields.io/npm/v/@clerc/plugin-help?color=a1b858&label=)](https://www.npmjs.com/package/@clerc/plugin-help)
 
-Clerc plugin to add help command to your cli.
+## Documenation
 
-## 📦 Installation
-
-```bash
-$ npm install @clerc/plugin-help
-$ yarn add @clerc/plugin-help
-$ pnpm add @clerc/plugin-help
-```
-
-## 🚀 Usage
-
-```ts
-import { helpPlugin } from "@clerc/plugin-help";
-
-cli.use(helpPlugin());
-```
+Read the [documentation](https://clerc.so1ve.dev/official-plugins/plugin-help.html) for more details.
 
 ## 📝 License
 

package/dist/{index.d.ts → index.d.mts}

@@ -1,35 +1,15 @@
 import { Plugin } from "@clerc/core";
+import { FlagDefaultValue, TypeValue } from "@clerc/parser";
 
-//#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 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.
+* 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];
 /**
@@ -37,18 +17,15 @@ type GroupDefinition = [key: string, name: string];
 */
 interface GroupsOptions {
   /**
-  * Groups for commands.
-  * Each group is defined as `[key, name]`.
+  * Groups for commands. Each group is defined as `[key, name]`.
   */
   commands?: GroupDefinition[];
   /**
-  * Groups for command-specific flags.
-  * Each group is defined as `[key, name]`.
+  * 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]`.
+  * Groups for global flags. Each group is defined as `[key, name]`.
   */
   globalFlags?: GroupDefinition[];
 }
@@ -59,8 +36,8 @@ declare const defaultFormatters: Formatters;
 //#region src/index.d.ts
 interface HelpOptions {
   /**
-  * The group this item belongs to.
-  * The group must be defined in the `groups` option of `helpPlugin()`.
+  * The group this item belongs to. The group must be defined in the `groups`
+  * option of `helpPlugin()`.
   */
   group?: string;
 }
@@ -76,8 +53,8 @@ interface CommandHelpOptions extends HelpOptions {
   */
   notes?: string[];
   /**
-  * Examples to show in the help output.
-  * Each example is a tuple of `[command, description]`.
+  * Examples to show in the help output. Each example is a tuple of `[command,
+  * description]`.
   */
   examples?: [string, string][];
 }
@@ -119,8 +96,8 @@ interface HelpPluginOptions {
   */
   notes?: string[];
   /**
-  * Examples to show in the help output.
-  * Each example is a tuple of `[command, description]`.
+  * Examples to show in the help output. Each example is a tuple of `[command,
+  * description]`.
   */
   examples?: [string, string][];
   /**
@@ -136,10 +113,10 @@ interface HelpPluginOptions {
   */
   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.
+  * 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;
 }

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

@@ -1,17 +1,9 @@
 import { DOUBLE_DASH, NoSuchCommandError, definePlugin, normalizeFlagValue, normalizeParameterValue, resolveCommand } from "@clerc/core";
+import { formatFlagName, formatVersion, isTruthy, objectIsEmpty, toArray } from "@clerc/utils";
 import * as tint from "@uttr/tint";
 import stringWidth from "string-width";
 import textTable from "text-table";
 
-//#region ../utils/src/index.ts
-const toArray = (a) => Array.isArray(a) ? a : [a];
-const kebabCase = (s) => s.replace(/([A-Z])/g, (_, c) => `-${c.toLowerCase()}`);
-const formatFlagName = (n) => n.length <= 1 ? `-${n}` : `--${kebabCase(n)}`;
-const formatVersion = (v) => v.length === 0 ? "" : v.startsWith("v") ? v : `v${v}`;
-const isTruthy = Boolean;
-const objectIsEmpty = (obj) => Object.keys(obj).length === 0;
-
-//#endregion
 //#region src/utils.ts
 function formatTypeValue(type) {
 	if (typeof type === "function") return type.display ?? type.name;
@@ -122,7 +114,7 @@ var HelpRenderer = class {
 				});
 				usage += ` ${items.join(" ")}`;
 			}
-		} else if (this._cli._commands.size > 0 && !(this._cli._commands.has("") && this._cli._commands.size === 1)) usage += this._cli._commands.has("") ? ` ${tint.dim("[command]")}` : ` ${tint.dim("<command>")}`;
+		} else if (this._cli._commands.size > 0 && (!this._cli._commands.has("") || this._cli._commands.size !== 1)) usage += this._cli._commands.has("") ? ` ${tint.dim("[command]")}` : ` ${tint.dim("<command>")}`;
 		if (command?.flags && !objectIsEmpty(command.flags) || !objectIsEmpty(this._globalFlags)) usage += ` ${tint.dim("[flags]")}`;
 		return {
 			title: "Usage",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-help",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc plugin help",
@@ -25,19 +25,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"
   ],
@@ -45,16 +38,16 @@
     "access": "public"
   },
   "dependencies": {
-    "@types/text-table": "^0.2.5",
     "@uttr/tint": "^0.1.3",
     "string-width": "^8.1.0",
-    "text-table": "^0.2.0"
+    "text-table": "^0.2.0",
+    "@clerc/utils": "1.1.0"
   },
   "devDependencies": {
+    "@types/text-table": "^0.2.5",
     "kons": "^0.7.1",
-    "@clerc/core": "1.0.2",
-    "@clerc/parser": "1.0.2",
-    "@clerc/utils": "1.0.2"
+    "@clerc/parser": "1.1.0",
+    "@clerc/core": "1.1.0"
   },
   "peerDependencies": {
     "@clerc/core": "*"