clerc 1.0.0-beta.27 → 1.0.0-beta.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +41 -3
  2. package/package.json +8 -8
package/dist/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { n as __reExport, t as __export } from "./chunk-CYeTv9WL.js";
2
2
  import { Clerc, CreateOptions, Plugin } from "@clerc/core";
3
+ import { ArgumentHandler, Command, OptionHandler } from "@bomb.sh/tab";
3
4
  export * from "@clerc/core";
4
5
 
5
6
  //#region ../plugin-completions/src/index.d.ts
@@ -15,6 +16,38 @@ declare module "@clerc/core" {
15
16
  * @default true
16
17
  */
17
18
  show?: boolean;
19
+ /**
20
+ * Handler to provide custom completions for the command.
21
+ */
22
+ handler?: (command: Command) => void;
23
+ };
24
+ }
25
+ interface FlagCustomOptions {
26
+ /**
27
+ * Completions options for the flag.
28
+ */
29
+ completions?: {
30
+ /**
31
+ * Whether to show the flag in completions output.
32
+ *
33
+ * @default true
34
+ */
35
+ show?: boolean;
36
+ /**
37
+ * Handler to provide custom completions for the flag.
38
+ */
39
+ handler?: OptionHandler;
40
+ };
41
+ }
42
+ interface ParameterCustomOptions {
43
+ /**
44
+ * Completions options for the parameter.
45
+ */
46
+ completions?: {
47
+ /**
48
+ * Handler to provide custom completions for the parameter.
49
+ */
50
+ handler?: ArgumentHandler;
18
51
  };
19
52
  }
20
53
  }
@@ -152,9 +185,13 @@ interface HelpPluginOptions {
152
185
  */
153
186
  examples?: [string, string][];
154
187
  /**
155
- * A banner to show before the help output.
188
+ * Header to show before the help output.
189
+ */
190
+ header?: string;
191
+ /**
192
+ * Footer to show after the help output.
156
193
  */
157
- banner?: string;
194
+ footer?: string;
158
195
  /**
159
196
  * Custom formatters for rendering help.
160
197
  */
@@ -173,7 +210,8 @@ declare const helpPlugin: ({
173
210
  showHelpWhenNoCommandSpecified,
174
211
  notes,
175
212
  examples,
176
- banner,
213
+ header,
214
+ footer,
177
215
  formatters,
178
216
  groups
179
217
  }?: HelpPluginOptions) => Plugin;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "clerc",
3
- "version": "1.0.0-beta.27",
3
+ "version": "1.0.0-beta.29",
4
4
  "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
5
5
  "type": "module",
6
6
  "description": "Clerc: The full-featured cli library.",
@@ -44,12 +44,12 @@
44
44
  "access": "public"
45
45
  },
46
46
  "dependencies": {
47
- "@clerc/plugin-friendly-error": "1.0.0-beta.27",
48
- "@clerc/plugin-not-found": "1.0.0-beta.27",
49
- "@clerc/plugin-strict-flags": "1.0.0-beta.27",
50
- "@clerc/core": "1.0.0-beta.27",
51
- "@clerc/plugin-help": "1.0.0-beta.27",
52
- "@clerc/plugin-version": "1.0.0-beta.27",
53
- "@clerc/plugin-completions": "1.0.0-beta.27"
47
+ "@clerc/plugin-friendly-error": "1.0.0-beta.29",
48
+ "@clerc/plugin-help": "1.0.0-beta.29",
49
+ "@clerc/core": "1.0.0-beta.29",
50
+ "@clerc/plugin-completions": "1.0.0-beta.29",
51
+ "@clerc/plugin-strict-flags": "1.0.0-beta.29",
52
+ "@clerc/plugin-not-found": "1.0.0-beta.29",
53
+ "@clerc/plugin-version": "1.0.0-beta.29"
54
54
  }
55
55
  }