@clerc/plugin-help 0.28.1 → 0.30.0

package/dist/index.d.ts

@@ -1,6 +1,31 @@
 import * as _clerc_core from '@clerc/core';
 import { Clerc } from '@clerc/core';
 
+interface BlockSection {
+    type?: "block";
+    title: string;
+    body: string[];
+}
+interface InlineSection {
+    type: "inline";
+    items: {
+        title: string;
+        body: string;
+    }[];
+}
+type Section = BlockSection | InlineSection;
+interface Renderers {
+    renderSections?: (sections: Section[]) => Section[];
+    renderFlagName?: (name: string) => string;
+    renderType?: (type: any, hasDefault: boolean) => string;
+    renderDefault?: (default_: any) => string;
+}
+
+declare module "@clerc/core" {
+    interface CommandCustomProperties {
+        help?: Renderers;
+    }
+}
 interface HelpPluginOptions {
     /**
      * Whether to registr the help command.
@@ -24,11 +49,7 @@ interface HelpPluginOptions {
      * Banner
      */
     banner?: string;
-    /**
-     * Render type
-     */
-    renderer?: "cliffy";
 }
-declare const helpPlugin: ({ command, showHelpWhenNoCommand, notes, examples, banner, renderer, }?: HelpPluginOptions) => _clerc_core.Plugin<Clerc<{}>, Clerc<{}>>;
+declare const helpPlugin: ({ command, showHelpWhenNoCommand, notes, examples, banner, }?: HelpPluginOptions) => _clerc_core.Plugin<Clerc<{}>, Clerc<{}>>;
 
 export { HelpPluginOptions, helpPlugin };

package/dist/index.js

@@ -1,9 +1,9 @@
-import{definePlugin as B,Root as h,withBrackets as k,resolveCommand as P,NoSuchCommandError as G,formatCommandName as d}from"@clerc/core";import H from"tty";const U=t=>Array.isArray(t)?t:[t],W=t=>t.replace(/([A-Z])/g,(r,e)=>`-${e.toLowerCase()}`),_=t=>t.length<=1?`-${t}`:`--${W(t)}`;var f={exports:{}};let z=H,V=!("NO_COLOR"in process.env||process.argv.includes("--no-color"))&&("FORCE_COLOR"in process.env||process.argv.includes("--color")||process.platform==="win32"||z.isatty(1)&&process.env.TERM!=="dumb"||"CI"in process.env),l=(t,r,e=t)=>o=>{let i=""+o,s=i.indexOf(r,t.length);return~s?t+N(i,r,e,s)+r:t+i+r},N=(t,r,e,o)=>{let i=t.substring(0,o)+e,s=t.substring(o+r.length),m=s.indexOf(r);return~m?i+N(s,r,e,m):i+s},A=(t=V)=>({isColorSupported:t,reset:t?r=>`\x1B[0m${r}\x1B[0m`:String,bold:t?l("\x1B[1m","\x1B[22m","\x1B[22m\x1B[1m"):String,dim:t?l("\x1B[2m","\x1B[22m","\x1B[22m\x1B[2m"):String,italic:t?l("\x1B[3m","\x1B[23m"):String,underline:t?l("\x1B[4m","\x1B[24m"):String,inverse:t?l("\x1B[7m","\x1B[27m"):String,hidden:t?l("\x1B[8m","\x1B[28m"):String,strikethrough:t?l("\x1B[9m","\x1B[29m"):String,black:t?l("\x1B[30m","\x1B[39m"):String,red:t?l("\x1B[31m","\x1B[39m"):String,green:t?l("\x1B[32m","\x1B[39m"):String,yellow:t?l("\x1B[33m","\x1B[39m"):String,blue:t?l("\x1B[34m","\x1B[39m"):String,magenta:t?l("\x1B[35m","\x1B[39m"):String,cyan:t?l("\x1B[36m","\x1B[39m"):String,white:t?l("\x1B[37m","\x1B[39m"):String,gray:t?l("\x1B[90m","\x1B[39m"):String,bgBlack:t?l("\x1B[40m","\x1B[49m"):String,bgRed:t?l("\x1B[41m","\x1B[49m"):String,bgGreen:t?l("\x1B[42m","\x1B[49m"):String,bgYellow:t?l("\x1B[43m","\x1B[49m"):String,bgBlue:t?l("\x1B[44m","\x1B[49m"):String,bgMagenta:t?l("\x1B[45m","\x1B[49m"):String,bgCyan:t?l("\x1B[46m","\x1B[49m"):String,bgWhite:t?l("\x1B[47m","\x1B[49m"):String});f.exports=A(),f.exports.createColors=A;var q=Function.prototype.toString,X=/\s*function(?:\s|\s*\/\*[^(?:*\/)]+\*\/\s*)*([^\s\(\/]+)/;function Y(t){if(typeof t!="function")return null;var r="";if(typeof Function.prototype.name=="undefined"&&typeof t.name=="undefined"){var e=q.call(t).match(X);e&&(r=e[1])}else r=t.name;return r}var O=Y,Z=function(t,r){r||(r={});var e=r.hsep===void 0?"  ":r.hsep,o=r.align||[],i=r.stringLength||function(a){return String(a).length},s=j(t,function(a,n){return M(n,function(c,p){var u=E(c);(!a[p]||u>a[p])&&(a[p]=u)}),a},[]),m=y(t,function(a){return y(a,function(n,c){var p=String(n);if(o[c]==="."){var u=E(p),b=s[c]+(/\./.test(p)?1:2)-(i(p)-u);return p+Array(b).join(" ")}else return p})}),g=j(m,function(a,n){return M(n,function(c,p){var u=i(c);(!a[p]||u>a[p])&&(a[p]=u)}),a},[]);return y(m,function(a){return y(a,function(n,c){var p=g[c]-i(n)||0,u=Array(Math.max(p+1,1)).join(" ");return o[c]==="r"||o[c]==="."?u+n:o[c]==="c"?Array(Math.ceil(p/2+1)).join(" ")+n+Array(Math.floor(p/2+1)).join(" "):n+u}).join(e).replace(/\s+$/,"")}).join(`
-`)};function E(t){var r=/\.[^.]*$/.exec(t);return r?r.index+1:t.length}function j(t,r,e){if(t.reduce)return t.reduce(r,e);for(var o=0,i=arguments.length>=3?e:t[o++];o<t.length;o++)r(i,t[o],o);return i}function M(t,r){if(t.forEach)return t.forEach(r);for(var e=0;e<t.length;e++)r.call(t,t[e],e)}function y(t,r){if(t.map)return t.map(r);for(var e=[],o=0;o<t.length;o++)e.push(r.call(t,t[o],o));return e}const v=(...t)=>Z(t),$=(...t)=>v(...t).toString().split(`
-`),J=t=>Array.isArray(t)?`Array<${O(t[0])}>`:O(t),K=t=>{const r=[];for(const e of t){if(e.type==="block"||!e.type){const o="    ",i=e.body.map(m=>o+m);i.unshift("");const s=i.join(`
-`);r.push(v([f.exports.bold(`${e.title}:`)],[s]).toString())}else if(e.type==="inline"){const o=e.items.map(s=>[f.exports.bold(`${s.title}:`),s.body]),i=v(...o);r.push(i.toString())}r.push("")}return r.join(`
-`)},w=f.exports.yellow("-"),Q="(No description)",tt="Name",rt="Version",et="Subcommand",nt="Commands",ot="Flags",it="Description",R="Usage",st="Examples",I="Notes",L=t=>{process.stdout.write(t)},F=(t,r,e)=>{const o=[{title:tt,body:f.exports.red(r._name)},{title:rt,body:f.exports.yellow(r._version)}];e&&o.push({title:et,body:f.exports.green(`${r._name} ${d(e.name)}`)}),t.push({type:"inline",items:o}),t.push({title:it,body:[(e==null?void 0:e.description)||r._description]})},T=(t,r)=>{const e=r.map(([o,i])=>[o,w,i]);t.push({title:st,body:$(...e)})},S=(t,r,e,o)=>{const{cli:i}=r,s=[];F(s,i),s.push({title:R,body:[f.exports.magenta(`$ ${i._name} ${k("command",r.hasRootOrAlias)} [flags]`)]});const m=[...r.hasRoot?[i._commands[h]]:[],...Object.values(i._commands)].map(g=>{const a=[typeof g.name=="symbol"?"":g.name,...U(g.alias||[])].sort((n,c)=>n===h?-1:c===h?1:n.length-c.length).map(n=>n===""||typeof n=="symbol"?`${i._name}`:`${i._name} ${n}`).join(", ");return[f.exports.cyan(a),w,g.description]});return s.push({title:nt,body:$(...m)}),e&&s.push({title:I,body:e}),o&&T(s,o),t(s)},C=(t,r,e)=>{var o;const{cli:i}=r,s=P(i._commands,e);if(!s)throw new G(d(e));const m=[];F(m,i,{...s,name:d(e)});const g=((o=s.parameters)==null?void 0:o.join(" "))||void 0,a=` ${d(e)}`,n=g?` ${g}`:"",c=s.flags?" [flags]":"";return m.push({title:R,body:[f.exports.magenta(`$ ${i._name}${a}${n}${c}`)]}),s.flags&&m.push({title:ot,body:$(...Object.entries(s.flags).map(([p,u])=>{const b=[_(p)];u.alias&&b.push(_(u.alias));const x=[f.exports.blue(b.join(", "))];if(x.push(w,u.description||Q),u.type){const D=J(u.type);x.push(f.exports.gray(`(${D})`))}return x}))}),s.notes&&m.push({title:I,body:s.notes}),s.examples&&T(m,s.examples),t(m)},at=({command:t=!0,showHelpWhenNoCommand:r=!0,notes:e,examples:o,banner:i,renderer:s="cliffy"}={})=>B({setup:m=>{const g=s==="cliffy"?K:()=>"",a=n=>{i&&L(`${i}
-`),L(n)};return t&&(m=m.command("help","Show help",{parameters:["[command...]"],notes:["If no command is specified, show help for the CLI.","If a command is specified, show help for the command.","-h is an alias for --help."],examples:[[`$ ${m._name} help`,"Show help"],[`$ ${m._name} help <command>`,"Show help for a specific command"],[`$ ${m._name} <command> --help`,"Show help for a specific command"]]}).on("help",n=>{n.parameters.command.length?a(C(g,n,n.parameters.command)):a(S(g,n,e,o))})),m.inspector((n,c)=>{const p=n.raw.mergedFlags.h||n.raw.mergedFlags.help;if(!n.hasRootOrAlias&&!n.raw._.length&&r&&!p){let u=`No command given.
+import{definePlugin as G,Root as p,withBrackets as H,resolveCommandStrict as q,NoSuchCommandError as J,formatCommandName as f}from"@clerc/core";import U from"tty";const V=D=>Array.isArray(D)?D:[D],Y=D=>D.replace(/([A-Z])/g,(u,F)=>`-${F.toLowerCase()}`),j=D=>D.length<=1?`-${D}`:`--${Y(D)}`;var l={exports:{}};let K=U,Q=!("NO_COLOR"in process.env||process.argv.includes("--no-color"))&&("FORCE_COLOR"in process.env||process.argv.includes("--color")||process.platform==="win32"||K.isatty(1)&&process.env.TERM!=="dumb"||"CI"in process.env),o=(D,u,F=D)=>C=>{let e=""+C,t=e.indexOf(u,D.length);return~t?D+N(e,u,F,t)+u:D+e+u},N=(D,u,F,C)=>{let e=D.substring(0,C)+F,t=D.substring(C+u.length),n=t.indexOf(u);return~n?e+N(t,u,F,n):e+t},O=(D=Q)=>({isColorSupported:D,reset:D?u=>`\x1B[0m${u}\x1B[0m`:String,bold:D?o("\x1B[1m","\x1B[22m","\x1B[22m\x1B[1m"):String,dim:D?o("\x1B[2m","\x1B[22m","\x1B[22m\x1B[2m"):String,italic:D?o("\x1B[3m","\x1B[23m"):String,underline:D?o("\x1B[4m","\x1B[24m"):String,inverse:D?o("\x1B[7m","\x1B[27m"):String,hidden:D?o("\x1B[8m","\x1B[28m"):String,strikethrough:D?o("\x1B[9m","\x1B[29m"):String,black:D?o("\x1B[30m","\x1B[39m"):String,red:D?o("\x1B[31m","\x1B[39m"):String,green:D?o("\x1B[32m","\x1B[39m"):String,yellow:D?o("\x1B[33m","\x1B[39m"):String,blue:D?o("\x1B[34m","\x1B[39m"):String,magenta:D?o("\x1B[35m","\x1B[39m"):String,cyan:D?o("\x1B[36m","\x1B[39m"):String,white:D?o("\x1B[37m","\x1B[39m"):String,gray:D?o("\x1B[90m","\x1B[39m"):String,bgBlack:D?o("\x1B[40m","\x1B[49m"):String,bgRed:D?o("\x1B[41m","\x1B[49m"):String,bgGreen:D?o("\x1B[42m","\x1B[49m"):String,bgYellow:D?o("\x1B[43m","\x1B[49m"):String,bgBlue:D?o("\x1B[44m","\x1B[49m"):String,bgMagenta:D?o("\x1B[45m","\x1B[49m"):String,bgCyan:D?o("\x1B[46m","\x1B[49m"):String,bgWhite:D?o("\x1B[47m","\x1B[49m"):String});l.exports=O(),l.exports.createColors=O;var X=function(D,u){u||(u={});var F=u.hsep===void 0?"  ":u.hsep,C=u.align||[],e=u.stringLength||function(E){return String(E).length},t=I(D,function(E,r){return M(r,function(B,s){var i=L(B);(!E[s]||i>E[s])&&(E[s]=i)}),E},[]),n=g(D,function(E){return g(E,function(r,B){var s=String(r);if(C[B]==="."){var i=L(s),d=t[B]+(/\./.test(s)?1:2)-(e(s)-i);return s+Array(d).join(" ")}else return s})}),a=I(n,function(E,r){return M(r,function(B,s){var i=e(B);(!E[s]||i>E[s])&&(E[s]=i)}),E},[]);return g(n,function(E){return g(E,function(r,B){var s=a[B]-e(r)||0,i=Array(Math.max(s+1,1)).join(" ");return C[B]==="r"||C[B]==="."?i+r:C[B]==="c"?Array(Math.ceil(s/2+1)).join(" ")+r+Array(Math.floor(s/2+1)).join(" "):r+i}).join(F).replace(/\s+$/,"")}).join(`
+`)};function L(D){var u=/\.[^.]*$/.exec(D);return u?u.index+1:D.length}function I(D,u,F){if(D.reduce)return D.reduce(u,F);for(var C=0,e=arguments.length>=3?F:D[C++];C<D.length;C++)u(e,D[C],C);return e}function M(D,u){if(D.forEach)return D.forEach(u);for(var F=0;F<D.length;F++)u.call(D,D[F],F)}function g(D,u){if(D.map)return D.map(u);for(var F=[],C=0;C<D.length;C++)F.push(u.call(D,D[C],C));return F}var v={exports:{}},P=({onlyFirst:D=!1}={})=>{const u=["[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)","(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))"].join("|");return new RegExp(u,D?void 0:"g")};const DD=P;var uD=D=>typeof D=="string"?D.replace(DD(),""):D,y={exports:{}};const T=D=>Number.isNaN(D)?!1:D>=4352&&(D<=4447||D===9001||D===9002||11904<=D&&D<=12871&&D!==12351||12880<=D&&D<=19903||19968<=D&&D<=42182||43360<=D&&D<=43388||44032<=D&&D<=55203||63744<=D&&D<=64255||65040<=D&&D<=65049||65072<=D&&D<=65131||65281<=D&&D<=65376||65504<=D&&D<=65510||110592<=D&&D<=110593||127488<=D&&D<=127569||131072<=D&&D<=262141);y.exports=T,y.exports.default=T;var FD=function(){return/\uD83C\uDFF4\uDB40\uDC67\uDB40\uDC62(?:\uDB40\uDC65\uDB40\uDC6E\uDB40\uDC67|\uDB40\uDC73\uDB40\uDC63\uDB40\uDC74|\uDB40\uDC77\uDB40\uDC6C\uDB40\uDC73)\uDB40\uDC7F|\uD83D\uDC68(?:\uD83C\uDFFC\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68\uD83C\uDFFB|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFF\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFE])|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFE\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFD])|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFD\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB\uDFFC])|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\u200D(?:\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D)?\uD83D\uDC68|(?:\uD83D[\uDC68\uDC69])\u200D(?:\uD83D\uDC66\u200D\uD83D\uDC66|\uD83D\uDC67\u200D(?:\uD83D[\uDC66\uDC67]))|\uD83D\uDC66\u200D\uD83D\uDC66|\uD83D\uDC67\u200D(?:\uD83D[\uDC66\uDC67])|(?:\uD83D[\uDC68\uDC69])\u200D(?:\uD83D[\uDC66\uDC67])|[\u2695\u2696\u2708]\uFE0F|\uD83D[\uDC66\uDC67]|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|(?:\uD83C\uDFFB\u200D[\u2695\u2696\u2708]|\uD83C\uDFFF\u200D[\u2695\u2696\u2708]|\uD83C\uDFFE\u200D[\u2695\u2696\u2708]|\uD83C\uDFFD\u200D[\u2695\u2696\u2708]|\uD83C\uDFFC\u200D[\u2695\u2696\u2708])\uFE0F|\uD83C\uDFFB\u200D(?:\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C[\uDFFB-\uDFFF])|(?:\uD83E\uDDD1\uD83C\uDFFB\u200D\uD83E\uDD1D\u200D\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFC\u200D\uD83E\uDD1D\u200D\uD83D\uDC69)\uD83C\uDFFB|\uD83E\uDDD1(?:\uD83C\uDFFF\u200D\uD83E\uDD1D\u200D\uD83E\uDDD1(?:\uD83C[\uDFFB-\uDFFF])|\u200D\uD83E\uDD1D\u200D\uD83E\uDDD1)|(?:\uD83E\uDDD1\uD83C\uDFFE\u200D\uD83E\uDD1D\u200D\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFF\u200D\uD83E\uDD1D\u200D(?:\uD83D[\uDC68\uDC69]))(?:\uD83C[\uDFFB-\uDFFE])|(?:\uD83E\uDDD1\uD83C\uDFFC\u200D\uD83E\uDD1D\u200D\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFD\u200D\uD83E\uDD1D\u200D\uD83D\uDC69)(?:\uD83C[\uDFFB\uDFFC])|\uD83D\uDC69(?:\uD83C\uDFFE\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFD\uDFFF])|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFC\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB\uDFFD-\uDFFF])|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFB\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFC-\uDFFF])|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFD\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB\uDFFC\uDFFE\uDFFF])|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\u200D(?:\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D(?:\uD83D[\uDC68\uDC69])|\uD83D[\uDC68\uDC69])|\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFF\u200D(?:\uD83C[\uDF3E\uDF73\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD]))|\uD83D\uDC69\u200D\uD83D\uDC69\u200D(?:\uD83D\uDC66\u200D\uD83D\uDC66|\uD83D\uDC67\u200D(?:\uD83D[\uDC66\uDC67]))|(?:\uD83E\uDDD1\uD83C\uDFFD\u200D\uD83E\uDD1D\u200D\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFE\u200D\uD83E\uDD1D\u200D\uD83D\uDC69)(?:\uD83C[\uDFFB-\uDFFD])|\uD83D\uDC69\u200D\uD83D\uDC66\u200D\uD83D\uDC66|\uD83D\uDC69\u200D\uD83D\uDC69\u200D(?:\uD83D[\uDC66\uDC67])|(?:\uD83D\uDC41\uFE0F\u200D\uD83D\uDDE8|\uD83D\uDC69(?:\uD83C\uDFFF\u200D[\u2695\u2696\u2708]|\uD83C\uDFFE\u200D[\u2695\u2696\u2708]|\uD83C\uDFFC\u200D[\u2695\u2696\u2708]|\uD83C\uDFFB\u200D[\u2695\u2696\u2708]|\uD83C\uDFFD\u200D[\u2695\u2696\u2708]|\u200D[\u2695\u2696\u2708])|(?:(?:\u26F9|\uD83C[\uDFCB\uDFCC]|\uD83D\uDD75)\uFE0F|\uD83D\uDC6F|\uD83E[\uDD3C\uDDDE\uDDDF])\u200D[\u2640\u2642]|(?:\u26F9|\uD83C[\uDFCB\uDFCC]|\uD83D\uDD75)(?:\uD83C[\uDFFB-\uDFFF])\u200D[\u2640\u2642]|(?:\uD83C[\uDFC3\uDFC4\uDFCA]|\uD83D[\uDC6E\uDC71\uDC73\uDC77\uDC81\uDC82\uDC86\uDC87\uDE45-\uDE47\uDE4B\uDE4D\uDE4E\uDEA3\uDEB4-\uDEB6]|\uD83E[\uDD26\uDD37-\uDD39\uDD3D\uDD3E\uDDB8\uDDB9\uDDCD-\uDDCF\uDDD6-\uDDDD])(?:(?:\uD83C[\uDFFB-\uDFFF])\u200D[\u2640\u2642]|\u200D[\u2640\u2642])|\uD83C\uDFF4\u200D\u2620)\uFE0F|\uD83D\uDC69\u200D\uD83D\uDC67\u200D(?:\uD83D[\uDC66\uDC67])|\uD83C\uDFF3\uFE0F\u200D\uD83C\uDF08|\uD83D\uDC15\u200D\uD83E\uDDBA|\uD83D\uDC69\u200D\uD83D\uDC66|\uD83D\uDC69\u200D\uD83D\uDC67|\uD83C\uDDFD\uD83C\uDDF0|\uD83C\uDDF4\uD83C\uDDF2|\uD83C\uDDF6\uD83C\uDDE6|[#\*0-9]\uFE0F\u20E3|\uD83C\uDDE7(?:\uD83C[\uDDE6\uDDE7\uDDE9-\uDDEF\uDDF1-\uDDF4\uDDF6-\uDDF9\uDDFB\uDDFC\uDDFE\uDDFF])|\uD83C\uDDF9(?:\uD83C[\uDDE6\uDDE8\uDDE9\uDDEB-\uDDED\uDDEF-\uDDF4\uDDF7\uDDF9\uDDFB\uDDFC\uDDFF])|\uD83C\uDDEA(?:\uD83C[\uDDE6\uDDE8\uDDEA\uDDEC\uDDED\uDDF7-\uDDFA])|\uD83E\uDDD1(?:\uD83C[\uDFFB-\uDFFF])|\uD83C\uDDF7(?:\uD83C[\uDDEA\uDDF4\uDDF8\uDDFA\uDDFC])|\uD83D\uDC69(?:\uD83C[\uDFFB-\uDFFF])|\uD83C\uDDF2(?:\uD83C[\uDDE6\uDDE8-\uDDED\uDDF0-\uDDFF])|\uD83C\uDDE6(?:\uD83C[\uDDE8-\uDDEC\uDDEE\uDDF1\uDDF2\uDDF4\uDDF6-\uDDFA\uDDFC\uDDFD\uDDFF])|\uD83C\uDDF0(?:\uD83C[\uDDEA\uDDEC-\uDDEE\uDDF2\uDDF3\uDDF5\uDDF7\uDDFC\uDDFE\uDDFF])|\uD83C\uDDED(?:\uD83C[\uDDF0\uDDF2\uDDF3\uDDF7\uDDF9\uDDFA])|\uD83C\uDDE9(?:\uD83C[\uDDEA\uDDEC\uDDEF\uDDF0\uDDF2\uDDF4\uDDFF])|\uD83C\uDDFE(?:\uD83C[\uDDEA\uDDF9])|\uD83C\uDDEC(?:\uD83C[\uDDE6\uDDE7\uDDE9-\uDDEE\uDDF1-\uDDF3\uDDF5-\uDDFA\uDDFC\uDDFE])|\uD83C\uDDF8(?:\uD83C[\uDDE6-\uDDEA\uDDEC-\uDDF4\uDDF7-\uDDF9\uDDFB\uDDFD-\uDDFF])|\uD83C\uDDEB(?:\uD83C[\uDDEE-\uDDF0\uDDF2\uDDF4\uDDF7])|\uD83C\uDDF5(?:\uD83C[\uDDE6\uDDEA-\uDDED\uDDF0-\uDDF3\uDDF7-\uDDF9\uDDFC\uDDFE])|\uD83C\uDDFB(?:\uD83C[\uDDE6\uDDE8\uDDEA\uDDEC\uDDEE\uDDF3\uDDFA])|\uD83C\uDDF3(?:\uD83C[\uDDE6\uDDE8\uDDEA-\uDDEC\uDDEE\uDDF1\uDDF4\uDDF5\uDDF7\uDDFA\uDDFF])|\uD83C\uDDE8(?:\uD83C[\uDDE6\uDDE8\uDDE9\uDDEB-\uDDEE\uDDF0-\uDDF5\uDDF7\uDDFA-\uDDFF])|\uD83C\uDDF1(?:\uD83C[\uDDE6-\uDDE8\uDDEE\uDDF0\uDDF7-\uDDFB\uDDFE])|\uD83C\uDDFF(?:\uD83C[\uDDE6\uDDF2\uDDFC])|\uD83C\uDDFC(?:\uD83C[\uDDEB\uDDF8])|\uD83C\uDDFA(?:\uD83C[\uDDE6\uDDEC\uDDF2\uDDF3\uDDF8\uDDFE\uDDFF])|\uD83C\uDDEE(?:\uD83C[\uDDE8-\uDDEA\uDDF1-\uDDF4\uDDF6-\uDDF9])|\uD83C\uDDEF(?:\uD83C[\uDDEA\uDDF2\uDDF4\uDDF5])|(?:\uD83C[\uDFC3\uDFC4\uDFCA]|\uD83D[\uDC6E\uDC71\uDC73\uDC77\uDC81\uDC82\uDC86\uDC87\uDE45-\uDE47\uDE4B\uDE4D\uDE4E\uDEA3\uDEB4-\uDEB6]|\uD83E[\uDD26\uDD37-\uDD39\uDD3D\uDD3E\uDDB8\uDDB9\uDDCD-\uDDCF\uDDD6-\uDDDD])(?:\uD83C[\uDFFB-\uDFFF])|(?:\u26F9|\uD83C[\uDFCB\uDFCC]|\uD83D\uDD75)(?:\uD83C[\uDFFB-\uDFFF])|(?:[\u261D\u270A-\u270D]|\uD83C[\uDF85\uDFC2\uDFC7]|\uD83D[\uDC42\uDC43\uDC46-\uDC50\uDC66\uDC67\uDC6B-\uDC6D\uDC70\uDC72\uDC74-\uDC76\uDC78\uDC7C\uDC83\uDC85\uDCAA\uDD74\uDD7A\uDD90\uDD95\uDD96\uDE4C\uDE4F\uDEC0\uDECC]|\uD83E[\uDD0F\uDD18-\uDD1C\uDD1E\uDD1F\uDD30-\uDD36\uDDB5\uDDB6\uDDBB\uDDD2-\uDDD5])(?:\uD83C[\uDFFB-\uDFFF])|(?:[\u231A\u231B\u23E9-\u23EC\u23F0\u23F3\u25FD\u25FE\u2614\u2615\u2648-\u2653\u267F\u2693\u26A1\u26AA\u26AB\u26BD\u26BE\u26C4\u26C5\u26CE\u26D4\u26EA\u26F2\u26F3\u26F5\u26FA\u26FD\u2705\u270A\u270B\u2728\u274C\u274E\u2753-\u2755\u2757\u2795-\u2797\u27B0\u27BF\u2B1B\u2B1C\u2B50\u2B55]|\uD83C[\uDC04\uDCCF\uDD8E\uDD91-\uDD9A\uDDE6-\uDDFF\uDE01\uDE1A\uDE2F\uDE32-\uDE36\uDE38-\uDE3A\uDE50\uDE51\uDF00-\uDF20\uDF2D-\uDF35\uDF37-\uDF7C\uDF7E-\uDF93\uDFA0-\uDFCA\uDFCF-\uDFD3\uDFE0-\uDFF0\uDFF4\uDFF8-\uDFFF]|\uD83D[\uDC00-\uDC3E\uDC40\uDC42-\uDCFC\uDCFF-\uDD3D\uDD4B-\uDD4E\uDD50-\uDD67\uDD7A\uDD95\uDD96\uDDA4\uDDFB-\uDE4F\uDE80-\uDEC5\uDECC\uDED0-\uDED2\uDED5\uDEEB\uDEEC\uDEF4-\uDEFA\uDFE0-\uDFEB]|\uD83E[\uDD0D-\uDD3A\uDD3C-\uDD45\uDD47-\uDD71\uDD73-\uDD76\uDD7A-\uDDA2\uDDA5-\uDDAA\uDDAE-\uDDCA\uDDCD-\uDDFF\uDE70-\uDE73\uDE78-\uDE7A\uDE80-\uDE82\uDE90-\uDE95])|(?:[#\*0-9\xA9\xAE\u203C\u2049\u2122\u2139\u2194-\u2199\u21A9\u21AA\u231A\u231B\u2328\u23CF\u23E9-\u23F3\u23F8-\u23FA\u24C2\u25AA\u25AB\u25B6\u25C0\u25FB-\u25FE\u2600-\u2604\u260E\u2611\u2614\u2615\u2618\u261D\u2620\u2622\u2623\u2626\u262A\u262E\u262F\u2638-\u263A\u2640\u2642\u2648-\u2653\u265F\u2660\u2663\u2665\u2666\u2668\u267B\u267E\u267F\u2692-\u2697\u2699\u269B\u269C\u26A0\u26A1\u26AA\u26AB\u26B0\u26B1\u26BD\u26BE\u26C4\u26C5\u26C8\u26CE\u26CF\u26D1\u26D3\u26D4\u26E9\u26EA\u26F0-\u26F5\u26F7-\u26FA\u26FD\u2702\u2705\u2708-\u270D\u270F\u2712\u2714\u2716\u271D\u2721\u2728\u2733\u2734\u2744\u2747\u274C\u274E\u2753-\u2755\u2757\u2763\u2764\u2795-\u2797\u27A1\u27B0\u27BF\u2934\u2935\u2B05-\u2B07\u2B1B\u2B1C\u2B50\u2B55\u3030\u303D\u3297\u3299]|\uD83C[\uDC04\uDCCF\uDD70\uDD71\uDD7E\uDD7F\uDD8E\uDD91-\uDD9A\uDDE6-\uDDFF\uDE01\uDE02\uDE1A\uDE2F\uDE32-\uDE3A\uDE50\uDE51\uDF00-\uDF21\uDF24-\uDF93\uDF96\uDF97\uDF99-\uDF9B\uDF9E-\uDFF0\uDFF3-\uDFF5\uDFF7-\uDFFF]|\uD83D[\uDC00-\uDCFD\uDCFF-\uDD3D\uDD49-\uDD4E\uDD50-\uDD67\uDD6F\uDD70\uDD73-\uDD7A\uDD87\uDD8A-\uDD8D\uDD90\uDD95\uDD96\uDDA4\uDDA5\uDDA8\uDDB1\uDDB2\uDDBC\uDDC2-\uDDC4\uDDD1-\uDDD3\uDDDC-\uDDDE\uDDE1\uDDE3\uDDE8\uDDEF\uDDF3\uDDFA-\uDE4F\uDE80-\uDEC5\uDECB-\uDED2\uDED5\uDEE0-\uDEE5\uDEE9\uDEEB\uDEEC\uDEF0\uDEF3-\uDEFA\uDFE0-\uDFEB]|\uD83E[\uDD0D-\uDD3A\uDD3C-\uDD45\uDD47-\uDD71\uDD73-\uDD76\uDD7A-\uDDA2\uDDA5-\uDDAA\uDDAE-\uDDCA\uDDCD-\uDDFF\uDE70-\uDE73\uDE78-\uDE7A\uDE80-\uDE82\uDE90-\uDE95])\uFE0F|(?:[\u261D\u26F9\u270A-\u270D]|\uD83C[\uDF85\uDFC2-\uDFC4\uDFC7\uDFCA-\uDFCC]|\uD83D[\uDC42\uDC43\uDC46-\uDC50\uDC66-\uDC78\uDC7C\uDC81-\uDC83\uDC85-\uDC87\uDC8F\uDC91\uDCAA\uDD74\uDD75\uDD7A\uDD90\uDD95\uDD96\uDE45-\uDE47\uDE4B-\uDE4F\uDEA3\uDEB4-\uDEB6\uDEC0\uDECC]|\uD83E[\uDD0F\uDD18-\uDD1F\uDD26\uDD30-\uDD39\uDD3C-\uDD3E\uDDB5\uDDB6\uDDB8\uDDB9\uDDBB\uDDCD-\uDDCF\uDDD1-\uDDDD])/g};const CD=uD,eD=y.exports,ED=FD,z=D=>{if(typeof D!="string"||D.length===0||(D=CD(D),D.length===0))return 0;D=D.replace(ED(),"  ");let u=0;for(let F=0;F<D.length;F++){const C=D.codePointAt(F);C<=31||C>=127&&C<=159||C>=768&&C<=879||(C>65535&&F++,u+=eD(C)?2:1)}return u};v.exports=z,v.exports.default=z;const S=D=>X(D,{stringLength:v.exports}),$=D=>S(D).split(`
+`),k=new Map([[Boolean,""],[String,"string"],[Number,"number"]]),rD=(D,u=!1)=>{const F=k.has(D)?k.get(D):"value";return u?`[${F}]`:`<${F}>`},A=D=>{const u=[];for(const F of D){if(F.type==="block"||!F.type){const C="    ",e=F.body.map(n=>C+n);e.unshift("");const t=e.join(`
+`);u.push(S([[l.exports.bold(`${F.title}:`)],[t]]).toString())}else if(F.type==="inline"){const C=F.items.map(t=>[l.exports.bold(`${t.title}:`),t.body]),e=S(C);u.push(e.toString())}u.push("")}return u.join(`
+`)},tD={renderFlagName:D=>D,renderSections:D=>D,renderType:(D,u)=>rD(D,u),renderDefault:D=>JSON.stringify(D)},nD={en:{"help.name":"Name","help.version":"Version","help.subcommand":"Subcommand","help.commands":"Commands","help.flags":"Flags","help.description":"Description","help.usage":"Usage","help.examples":"Examples","help.notes":"Notes","help.noDescription":"(No description)","help.notes.1":"If no command is specified, show help for the CLI.","help.notes.2":"If a command is specified, show help for the command.","help.notes.3":"-h is an alias for --help.","help.examples.1":"Show help","help.examples.2":"Show help for a specific command","help.commandDescription":"Show help","help.default":"Default: "},"zh-CN":{"help.name":"\u540D\u79F0","help.version":"\u7248\u672C","help.subcommand":"\u5B50\u547D\u4EE4","help.commands":"\u547D\u4EE4","help.flags":"\u6807\u5FD7","help.description":"\u63CF\u8FF0","help.usage":"\u4F7F\u7528","help.examples":"\u793A\u4F8B","help.notes":"\u5907\u6CE8","help.noDescription":"(\u65E0\u63CF\u8FF0)","help.notes.1":"\u5982\u679C\u6CA1\u6709\u6307\u5B9A\u5C55\u793A\u54EA\u4E2A\u547D\u4EE4\u7684\u5E2E\u52A9\u4FE1\u606F\uFF0C\u9ED8\u8BA4\u5C55\u793ACLI\u7684\u3002","help.notes.2":"\u5982\u679C\u6307\u5B9A\u4E86\u5219\u5C55\u793A\u8BE5\u547D\u4EE4\u5E2E\u52A9\u4FE1\u606F\u3002","help.notes.3":"-h \u662F --help \u7684\u4E00\u4E2A\u522B\u540D\u3002","help.examples.1":"\u5C55\u793A CLI \u7684\u5E2E\u52A9\u4FE1\u606F","help.examples.2":"\u5C55\u793A\u6307\u5B9A\u547D\u4EE4\u7684\u5E2E\u52A9\u4FE1\u606F","help.commandDescription":"\u5C55\u793A\u5E2E\u52A9\u4FE1\u606F","help.default":"\u9ED8\u8BA4\u503C: %s"}},w=l.exports.yellow("-"),W=D=>{process.stdout.write(D)},_=(D,u,F)=>{const{t:C}=u.i18n,e=[{title:C("help.name"),body:l.exports.red(u._name)},{title:C("help.version"),body:l.exports.yellow(u._version)}];F&&e.push({title:C("help.subcommand"),body:l.exports.green(`${u._name} ${f(F.name)}`)}),D.push({type:"inline",items:e}),D.push({title:C("help.description"),body:[(F==null?void 0:F.description)||u._description]})},Z=(D,u,F)=>{const C=u.map(([e,t])=>[e,w,t]);D.push({title:F("help.examples"),body:$(C)})},x=(D,u,F,C)=>{const{cli:e}=u,{t}=e.i18n,n=[];_(n,e),n.push({title:t("help.usage"),body:[l.exports.magenta(`$ ${e._name} ${H("command",u.hasRootOrAlias)} [flags]`)]});const a=[...u.hasRoot?[e._commands[p]]:[],...Object.values(e._commands)].map(E=>{const r=[typeof E.name=="symbol"?"":E.name,...V(E.alias||[])].sort((B,s)=>B===p?-1:s===p?1:B.length-s.length).map(B=>B===""||typeof B=="symbol"?`${e._name}`:`${e._name} ${B}`).join(", ");return[l.exports.cyan(r),w,E.description]});return n.push({title:t("help.commands"),body:$(a)}),F&&n.push({title:t("help.notes"),body:F}),C&&Z(n,C,t),D(n)},c=(D,u,F)=>{var C;const{cli:e}=u,{t}=e.i18n,[n]=q(e._commands,F,t);if(!n)throw new J(f(F),t);const a=Object.assign({},tD,n.help);let E=[];F===p?_(E,e):_(E,e,{...n,name:f(F)});const r=((C=n.parameters)==null?void 0:C.join(" "))||void 0,B=F===p?"":` ${f(F)}`,s=r?` ${r}`:"",i=n.flags?" [flags]":"";return E.push({title:t("help.usage"),body:[l.exports.magenta(`$ ${e._name}${B}${s}${i}`)]}),n.flags&&E.push({title:t("help.flags"),body:$(Object.entries(n.flags).map(([d,m])=>{const R=m.default!==void 0;let h=[j(d)];m.alias&&h.push(j(m.alias)),h=h.map(a.renderFlagName);const b=[l.exports.blue(h.join(", ")),a.renderType(m.type,R)];return b.push(w,m.description||t("help.noDescription")),R&&b.push(`(${t("help.default",a.renderDefault(m.default))})`),b}))}),n.notes&&E.push({title:t("help.notes"),body:n.notes}),n.examples&&Z(E,n.examples,t),E=a.renderSections(E),D(E)},sD=({command:D=!0,showHelpWhenNoCommand:u=!0,notes:F,examples:C,banner:e}={})=>G({setup:t=>{const{add:n,t:a}=t.i18n;n(nD);const E=r=>{e&&W(`${e}
+`),W(r)};return D&&(t=t.command("help",a("help.commandDescription"),{parameters:["[command...]"],notes:[a("help.notes.1"),a("help.notes.2"),a("help.notes.3")],examples:[[`$ ${t._name} help`,a("help.examples.1")],[`$ ${t._name} help <command>`,a("help.examples.2")],[`$ ${t._name} <command> --help`,a("help.examples.2")]]}).on("help",r=>{r.parameters.command.length?E(c(A,r,r.parameters.command)):E(x(A,r,F,C))})),t.inspector((r,B)=>{const s=r.raw.mergedFlags.h||r.raw.mergedFlags.help;if(!r.hasRootOrAlias&&!r.raw._.length&&u&&!s){let i=`${a("core.noCommandGiven")}
 
-`;u+=S(g,n,e,o),u+=`
-`,a(u),process.exit(1)}else p?n.raw._.length?n.called!==h&&n.name===h?a(S(g,n,e,o)):a(C(g,n,n.raw._)):a(S(g,n,e,o)):c()}),m}});export{at as helpPlugin};
+`;i+=x(A,r,F,C),i+=`
+`,E(i),process.exit(1)}else s?r.raw._.length?r.called!==p&&r.name===p?E(x(A,r,F,C)):E(c(A,r,r.raw._)):r.hasRootOrAlias?E(c(A,r,p)):E(x(A,r,F,C)):B()}),t}});export{sD as helpPlugin};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/plugin-help",
-  "version": "0.28.1",
+  "version": "0.30.0",
   "author": "Ray <nn_201312@163.com> (https://github.com/so1ve)",
   "description": "Clerc plugin help",
   "keywords": [
@@ -52,11 +52,11 @@
   },
   "devDependencies": {
     "@types/text-table": "^0.2.2",
-    "get-func-name": "^2.0.0",
     "picocolors": "^1.0.0",
+    "string-width": "^5.1.2",
     "text-table": "^0.2.0",
-    "@clerc/core": "0.28.1",
-    "@clerc/utils": "0.28.1"
+    "@clerc/core": "0.30.0",
+    "@clerc/utils": "0.30.0"
   },
   "scripts": {
     "build": "puild --minify",