cleye 1.1.0 → 1.2.0

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.
package/README.md CHANGED
@@ -65,7 +65,12 @@ if (argv.flags.time === 'morning') {
65
65
 
66
66
  🛠 In development, type hints are provided on parsed flags and parameters:
67
67
  <p align="center">
68
+ <br>
68
69
  <img src=".github/typed-flags.png" width="600">
70
+ <br>
71
+ <i>Type hints for Cleye's output are very verbose and readable</i>
72
+ <br>
73
+ <br>
69
74
  </p>
70
75
 
71
76
  📖 Generated help documentation can be viewed with the `--help` flag:
package/dist/index.d.ts CHANGED
@@ -64,8 +64,8 @@ declare class Renderers {
64
64
  tableBreakpoints?: Record<string, Options>;
65
65
  }): string;
66
66
  flagParameter(typeFunction: TypeFunction | readonly [TypeFunction]): string;
67
- flagOperator(): string;
68
- flagName({ flag, flagFormatted, aliasesEnabled, aliasFormatted, }: FlagData): string;
67
+ flagOperator(_: FlagData): string;
68
+ flagName(flagData: FlagData): string;
69
69
  flagDefault(value: any): string;
70
70
  flagDescription({ flag }: FlagData): string;
71
71
  render(nodes: (HelpDocumentNodeOrString<keyof this> | HelpDocumentNodeOrString<keyof this>[])): string;
package/dist/index.js CHANGED
@@ -1,10 +1,10 @@
1
- var W=Object.create;var h=Object.defineProperty,Z=Object.defineProperties,z=Object.getOwnPropertyDescriptor,G=Object.getOwnPropertyDescriptors,Q=Object.getOwnPropertyNames,D=Object.getOwnPropertySymbols,X=Object.getPrototypeOf,T=Object.prototype.hasOwnProperty,Y=Object.prototype.propertyIsEnumerable;var E=(t,e,n)=>e in t?h(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,f=(t,e)=>{for(var n in e||(e={}))T.call(e,n)&&E(t,n,e[n]);if(D)for(var n of D(e))Y.call(e,n)&&E(t,n,e[n]);return t},b=(t,e)=>Z(t,G(e)),S=t=>h(t,"__esModule",{value:!0});var ee=(t,e)=>{for(var n in e)h(t,n,{get:e[n],enumerable:!0})},B=(t,e,n,a)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of Q(e))!T.call(t,r)&&(n||r!=="default")&&h(t,r,{get:()=>e[r],enumerable:!(a=z(e,r))||a.enumerable});return t},v=(t,e)=>B(S(h(t!=null?W(X(t)):{},"default",!e&&t&&t.__esModule?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t),te=(t=>(e,n)=>t&&t.get(e)||(n=B(S({}),e,1),t&&t.set(e,n),n))(typeof WeakMap!="undefined"?new WeakMap:0);var ue={};ee(ue,{cli:()=>_,command:()=>J});var V=v(require("type-flag"));var R=t=>t.replace(/[-_ ](\w)/g,(e,n)=>n.toUpperCase()),I=t=>t.replace(/\B([A-Z])/g,"-$1").toLowerCase();var ne={"> 80":[{width:"content-width",paddingLeft:2,paddingRight:8},{width:"auto"}],"> 40":[{width:"auto",paddingLeft:2,paddingRight:8,preprocess:t=>t.trim()},{width:"100%",paddingLeft:2,paddingBottom:1}],"> 0":{stdoutColumns:1e3,columns:[{width:"content-width",paddingLeft:2,paddingRight:8},{width:"content-width"}]}};function j(t){let e=!1,a=Object.keys(t).sort((r,s)=>r.localeCompare(s)).map(r=>{let s=t[r],i="alias"in s;return i&&(e=!0),{name:r,flag:s,flagFormatted:`--${I(r)}`,aliasesEnabled:e,aliasFormatted:i?`-${s.alias}`:void 0}}).map(r=>(r.aliasesEnabled=e,[{type:"flagName",data:r},{type:"flagDescription",data:r}]));return{type:"table",data:{tableData:a,tableBreakpoints:ne}}}var K=t=>{var e;return!t||((e=t.version)!=null?e:t.help?t.help.version:void 0)},q=t=>{var n;let e="parent"in t&&((n=t.parent)==null?void 0:n.name);return(e?`${e} `:"")+t.name};function re(t){var a;let e=[];t.name&&e.push(q(t));let n=(a=K(t))!=null?a:"parent"in t&&K(t.parent);if(n&&e.push(`v${n}`),e.length!==0)return{id:"name",type:"text",data:`${e.join(" ")}
2
- `}}function ae(t){let{help:e}=t;if(!(!e||!e.description))return{id:"description",type:"text",data:`${e.description}
3
- `}}function se(t){var n;let e=t.help||{};if("usage"in e)return e.usage?{id:"usage",type:"section",data:{title:"Usage:",body:Array.isArray(e.usage)?e.usage.join(`
4
- `):e.usage}}:void 0;if(t.name){let a=[],r=[q(t)];if(t.flags&&Object.keys(t.flags).length>0&&r.push("[flags...]"),t.parameters&&t.parameters.length>0){let{parameters:s}=t,i=s.indexOf("--"),m=i>-1&&s.slice(i+1).some(o=>o.startsWith("<"));r.push(s.map(o=>o!=="--"?o:m?"--":"[--]").join(" "))}if(r.length>1&&a.push(r.join(" ")),"commands"in t&&((n=t.commands)==null?void 0:n.length)&&a.push(`${t.name} <command>`),a.length>0)return{id:"usage",type:"section",data:{title:"Usage:",body:a.join(`
5
- `)}}}}function ie(t){var a;if(!("commands"in t)||!((a=t.commands)==null?void 0:a.length))return;let e=t.commands.map(r=>[r.options.name,r.options.help?r.options.help.description:""]);return{id:"commands",type:"section",data:{title:"Commands:",body:{type:"table",data:{tableData:e,tableOptions:[{width:"content-width",paddingLeft:2,paddingRight:8}]}},indentBody:0}}}function oe(t){if(!(!t.flags||Object.keys(t.flags).length===0))return{id:"flags",type:"section",data:{title:"Flags:",body:j(t.flags),indentBody:0}}}function me(t){let{help:e}=t;if(!e||!e.examples||e.examples.length===0)return;let{examples:n}=e;if(Array.isArray(n)&&(n=n.join(`
6
- `)),n)return{id:"examples",type:"section",data:{title:"Examples:",body:n}}}function le(t){if(!("alias"in t)||!t.alias)return;let{alias:e}=t,n=Array.isArray(e)?e.join(", "):e;return{id:"aliases",type:"section",data:{title:"Aliases:",body:n}}}var A=t=>[re,ae,se,ie,oe,me,le].map(e=>e(t)).filter(e=>Boolean(e));var L=v(require("tty")),P=v(require("terminal-columns")),pe=L.default.WriteStream.prototype.hasColors(),x=class{text(e){return e}bold(e){return pe?`${e}`:e.toLocaleUpperCase()}indentText({text:e,spaces:n}){return e.replace(/^/gm," ".repeat(n))}heading(e){return this.bold(e)}section({title:e,body:n,indentBody:a=2}){return`${(e?`${this.heading(e)}
7
- `:"")+(n?this.indentText({text:this.render(n),spaces:a}):"")}
8
- `}table({tableData:e,tableOptions:n,tableBreakpoints:a}){return(0,P.default)(e.map(r=>r.map(s=>this.render(s))),a?(0,P.breakpoints)(a):n)}flagParameter(e){return e===Boolean?"":e===String?"<string>":e===Number?"<number>":Array.isArray(e)?this.flagParameter(e[0]):"<value>"}flagOperator(){return" "}flagName({flag:e,flagFormatted:n,aliasesEnabled:a,aliasFormatted:r}){let s="";if(r?s+=`${r}, `:a&&(s+=" "),s+=n,"placeholder"in e&&typeof e.placeholder=="string")s+=`${this.flagOperator()}${e.placeholder}`;else{let i=this.flagParameter("type"in e?e.type:e);i&&(s+=`${this.flagOperator()}${i}`)}return s}flagDefault(e){return JSON.stringify(e)}flagDescription({flag:e}){var a;let n="description"in e&&(a=e.description)!=null?a:"";if("default"in e){let{default:r}=e;typeof r=="function"&&(r=r()),r&&(n+=` (default: ${this.flagDefault(r)})`)}return n}render(e){if(typeof e=="string")return e;if(Array.isArray(e))return e.map(n=>this.render(n)).join(`
9
- `);if("type"in e&&this[e.type]){let n=this[e.type];if(typeof n=="function")return n.call(this,e.data)}throw new Error(`Invalid node type: ${JSON.stringify(e)}`)}};var O=/^[\w.-]+$/;var{stringify:p}=JSON,de=/[|\\{}()[\]^$+*?.]/;function $(t){let e=[],n,a;for(let r of t){if(a)throw new Error(`Invalid parameter: Spread parameter ${p(a)} must be last`);let s=r[0],i=r[r.length-1],m;if(s==="<"&&i===">"&&(m=!0,n))throw new Error(`Invalid parameter: Required parameter ${p(r)} cannot come after optional parameter ${p(n)}`);if(s==="["&&i==="]"&&(m=!1,n=r),m===void 0)throw new Error(`Invalid parameter: ${p(r)}. Must be wrapped in <> (required parameter) or [] (optional parameter)`);let o=r.slice(1,-1),d=o.slice(-3)==="...";d&&(a=r,o=o.slice(0,-3));let g=o.match(de);if(g)throw new Error(`Invalid parameter: ${p(r)}. Invalid character found ${p(g[0])}`);e.push({name:o,required:m,spread:d})}return e}function N(t,e,n,a){for(let r=0;r<e.length;r+=1){let{name:s,required:i,spread:m}=e[r],o=R(s);if(o in t)throw new Error(`Invalid parameter: ${p(s)} is used more than once.`);let d=m?n.slice(r):n[r];if(m&&(r=e.length),i&&(!d||m&&d.length===0))return console.error(`Error: Missing required parameter ${p(s)}
10
- `),a(),process.exit(1);t[o]=d}}function ce(t){return t===void 0||t!==!1}function U(t,e,n,a){let r=f({},e.flags),s=e.version;s&&(r.version={type:Boolean,description:"Show version"});let{help:i}=e,m=ce(i);m&&!("help"in r)&&(r.help={type:Boolean,alias:"h",description:"Show help"});let o=(0,V.default)(r,a),d=()=>{console.log(e.version)};if(s&&o.flags.version===!0)return d(),process.exit(0);let g=new x,M=m&&(i==null?void 0:i.render)?i.render:l=>g.render(l),y=l=>{let u=A(b(f(f({},e),l?{help:l}:{}),{flags:r}));console.log(M(u,g))};if(m&&o.flags.help===!0)return y(),process.exit(0);if(e.parameters){let{parameters:l}=e,u=o._,w=l.indexOf("--"),F=l.slice(w+1),C=Object.create(null);if(w>-1&&F.length>0){l=l.slice(0,w);let k=o._["--"];u=u.slice(0,-k.length||void 0),N(C,$(l),u,y),N(C,$(F),k,y)}else N(C,$(l),u,y);Object.assign(o._,C)}let H=b(f({},o),{showVersion:d,showHelp:y});return typeof n=="function"&&n(H),f({command:t},H)}function fe(t,e){let n=new Map;for(let a of e){let r=[a.options.name],{alias:s}=a.options;s&&(Array.isArray(s)?r.push(...s):r.push(s));for(let i of r){if(n.has(i))throw new Error(`Duplicate command name found: ${p(i)}`);n.set(i,a)}}return n.get(t)}function _(t,e,n=process.argv.slice(2)){if(!t)throw new Error("Options is required");if("name"in t&&(!t.name||!O.test(t.name)))throw new Error(`Invalid script name: ${p(t.name)}`);let a=n[0];if(t.commands&&O.test(a)){let r=fe(a,t.commands);if(r)return U(r.options.name,b(f({},r.options),{parent:t}),r.callback,n.slice(1))}return U(void 0,t,e,n)}function J(t,e){if(!t)throw new Error("Command options are required");let{name:n}=t;if(t.name===void 0)throw new Error("Command name is required");if(!O.test(n))throw new Error(`Invalid command name ${JSON.stringify(n)}. Command names must be one word.`);return{options:t,callback:e}}module.exports=te(ue);0&&(module.exports={cli,command});
1
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0});var B=require("type-flag"),I=require("tty"),C=require("terminal-columns");function v(r){return r&&typeof r=="object"&&"default"in r?r:{default:r}}var D=v(B),L=v(I),R=v(C);const T=r=>r.replace(/[-_ ](\w)/g,(e,t)=>t.toUpperCase()),F=r=>r.replace(/\B([A-Z])/g,"-$1").toLowerCase(),H={"> 80":[{width:"content-width",paddingLeft:2,paddingRight:8},{width:"auto"}],"> 40":[{width:"auto",paddingLeft:2,paddingRight:8,preprocess:r=>r.trim()},{width:"100%",paddingLeft:2,paddingBottom:1}],"> 0":{stdoutColumns:1e3,columns:[{width:"content-width",paddingLeft:2,paddingRight:8},{width:"content-width"}]}};function M(r){let e=!1;const n=Object.keys(r).sort((a,i)=>a.localeCompare(i)).map(a=>{const i=r[a],s="alias"in i;return s&&(e=!0),{name:a,flag:i,flagFormatted:`--${F(a)}`,aliasesEnabled:e,aliasFormatted:s?`-${i.alias}`:void 0}}).map(a=>(a.aliasesEnabled=e,[{type:"flagName",data:a},{type:"flagDescription",data:a}]));return{type:"table",data:{tableData:n,tableBreakpoints:H}}}const A=r=>{var e;return!r||((e=r.version)!=null?e:r.help?r.help.version:void 0)},x=r=>{var e;const t="parent"in r&&((e=r.parent)==null?void 0:e.name);return(t?`${t} `:"")+r.name};function U(r){var e;const t=[];r.name&&t.push(x(r));const n=(e=A(r))!=null?e:"parent"in r&&A(r.parent);if(n&&t.push(`v${n}`),t.length!==0)return{id:"name",type:"text",data:`${t.join(" ")}
2
+ `}}function V(r){const{help:e}=r;if(!(!e||!e.description))return{id:"description",type:"text",data:`${e.description}
3
+ `}}function J(r){var e;const t=r.help||{};if("usage"in t)return t.usage?{id:"usage",type:"section",data:{title:"Usage:",body:Array.isArray(t.usage)?t.usage.join(`
4
+ `):t.usage}}:void 0;if(r.name){const n=[],a=[x(r)];if(r.flags&&Object.keys(r.flags).length>0&&a.push("[flags...]"),r.parameters&&r.parameters.length>0){const{parameters:i}=r,s=i.indexOf("--"),l=s>-1&&i.slice(s+1).some(o=>o.startsWith("<"));a.push(i.map(o=>o!=="--"?o:l?"--":"[--]").join(" "))}if(a.length>1&&n.push(a.join(" ")),"commands"in r&&((e=r.commands)==null?void 0:e.length)&&n.push(`${r.name} <command>`),n.length>0)return{id:"usage",type:"section",data:{title:"Usage:",body:n.join(`
5
+ `)}}}}function k(r){var e;if(!("commands"in r)||!((e=r.commands)!=null&&e.length))return;const t=r.commands.map(a=>[a.options.name,a.options.help?a.options.help.description:""]);return{id:"commands",type:"section",data:{title:"Commands:",body:{type:"table",data:{tableData:t,tableOptions:[{width:"content-width",paddingLeft:2,paddingRight:8}]}},indentBody:0}}}function W(r){if(!(!r.flags||Object.keys(r.flags).length===0))return{id:"flags",type:"section",data:{title:"Flags:",body:M(r.flags),indentBody:0}}}function Z(r){const{help:e}=r;if(!e||!e.examples||e.examples.length===0)return;let{examples:t}=e;if(Array.isArray(t)&&(t=t.join(`
6
+ `)),t)return{id:"examples",type:"section",data:{title:"Examples:",body:t}}}function z(r){if(!("alias"in r)||!r.alias)return;const{alias:e}=r,t=Array.isArray(e)?e.join(", "):e;return{id:"aliases",type:"section",data:{title:"Aliases:",body:t}}}const G=r=>[U,V,J,k,W,Z,z].map(e=>e(r)).filter(e=>Boolean(e)),K=L.default.WriteStream.prototype.hasColors();class Q{text(e){return e}bold(e){return K?`\x1B[1m${e}\x1B[22m`:e.toLocaleUpperCase()}indentText({text:e,spaces:t}){return e.replace(/^/gm," ".repeat(t))}heading(e){return this.bold(e)}section({title:e,body:t,indentBody:n=2}){return`${(e?`${this.heading(e)}
7
+ `:"")+(t?this.indentText({text:this.render(t),spaces:n}):"")}
8
+ `}table({tableData:e,tableOptions:t,tableBreakpoints:n}){return R.default(e.map(a=>a.map(i=>this.render(i))),n?C.breakpoints(n):t)}flagParameter(e){return e===Boolean?"":e===String?"<string>":e===Number?"<number>":Array.isArray(e)?this.flagParameter(e[0]):"<value>"}flagOperator(e){return" "}flagName(e){const{flag:t,flagFormatted:n,aliasesEnabled:a,aliasFormatted:i}=e;let s="";if(i?s+=`${i}, `:a&&(s+=" "),s+=n,"placeholder"in t&&typeof t.placeholder=="string")s+=`${this.flagOperator(e)}${t.placeholder}`;else{const l=this.flagParameter("type"in t?t.type:t);l&&(s+=`${this.flagOperator(e)}${l}`)}return s}flagDefault(e){return JSON.stringify(e)}flagDescription({flag:e}){var t;let n="description"in e&&(t=e.description)!=null?t:"";if("default"in e){let{default:a}=e;typeof a=="function"&&(a=a()),a&&(n+=` (default: ${this.flagDefault(a)})`)}return n}render(e){if(typeof e=="string")return e;if(Array.isArray(e))return e.map(t=>this.render(t)).join(`
9
+ `);if("type"in e&&this[e.type]){const t=this[e.type];if(typeof t=="function")return t.call(this,e.data)}throw new Error(`Invalid node type: ${JSON.stringify(e)}`)}}const w=/^[\w.-]+$/;var X=Object.defineProperty,Y=Object.defineProperties,ee=Object.getOwnPropertyDescriptors,j=Object.getOwnPropertySymbols,re=Object.prototype.hasOwnProperty,te=Object.prototype.propertyIsEnumerable,N=(r,e,t)=>e in r?X(r,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[e]=t,m=(r,e)=>{for(var t in e||(e={}))re.call(e,t)&&N(r,t,e[t]);if(j)for(var t of j(e))te.call(e,t)&&N(r,t,e[t]);return r},b=(r,e)=>Y(r,ee(e));const{stringify:d}=JSON,ae=/[|\\{}()[\]^$+*?.]/;function _(r){const e=[];let t,n;for(const a of r){if(n)throw new Error(`Invalid parameter: Spread parameter ${d(n)} must be last`);const i=a[0],s=a[a.length-1];let l;if(i==="<"&&s===">"&&(l=!0,t))throw new Error(`Invalid parameter: Required parameter ${d(a)} cannot come after optional parameter ${d(t)}`);if(i==="["&&s==="]"&&(l=!1,t=a),l===void 0)throw new Error(`Invalid parameter: ${d(a)}. Must be wrapped in <> (required parameter) or [] (optional parameter)`);let o=a.slice(1,-1);const f=o.slice(-3)==="...";f&&(n=a,o=o.slice(0,-3));const p=o.match(ae);if(p)throw new Error(`Invalid parameter: ${d(a)}. Invalid character found ${d(p[0])}`);e.push({name:o,required:l,spread:f})}return e}function $(r,e,t,n){for(let a=0;a<e.length;a+=1){const{name:i,required:s,spread:l}=e[a],o=T(i);if(o in r)throw new Error(`Invalid parameter: ${d(i)} is used more than once.`);const f=l?t.slice(a):t[a];if(l&&(a=e.length),s&&(!f||l&&f.length===0))return console.error(`Error: Missing required parameter ${d(i)}
10
+ `),n(),process.exit(1);r[o]=f}}function ne(r){return r===void 0||r!==!1}function S(r,e,t,n){const a=m({},e.flags),i=e.version;i&&(a.version={type:Boolean,description:"Show version"});const{help:s}=e,l=ne(s);l&&!("help"in a)&&(a.help={type:Boolean,alias:"h",description:"Show help"});const o=D.default(a,n),f=()=>{console.log(e.version)};if(i&&o.flags.version===!0)return f(),process.exit(0);const p=new Q,q=l&&(s==null?void 0:s.render)?s.render:c=>p.render(c),h=c=>{const u=G(b(m(m({},e),c?{help:c}:{}),{flags:a}));console.log(q(u,p))};if(l&&o.flags.help===!0)return h(),process.exit(0);if(e.parameters){let{parameters:c}=e,u=o._;const y=c.indexOf("--"),E=c.slice(y+1),g=Object.create(null);if(y>-1&&E.length>0){c=c.slice(0,y);const P=o._["--"];u=u.slice(0,-P.length||void 0),$(g,_(c),u,h),$(g,_(E),P,h)}else $(g,_(c),u,h);Object.assign(o._,g)}const O=b(m({},o),{showVersion:f,showHelp:h});return typeof t=="function"&&t(O),m({command:r},O)}function ie(r,e){const t=new Map;for(const n of e){const a=[n.options.name],{alias:i}=n.options;i&&(Array.isArray(i)?a.push(...i):a.push(i));for(const s of a){if(t.has(s))throw new Error(`Duplicate command name found: ${d(s)}`);t.set(s,n)}}return t.get(r)}function se(r,e,t=process.argv.slice(2)){if(!r)throw new Error("Options is required");if("name"in r&&(!r.name||!w.test(r.name)))throw new Error(`Invalid script name: ${d(r.name)}`);const n=t[0];if(r.commands&&w.test(n)){const a=ie(n,r.commands);if(a)return S(a.options.name,b(m({},a.options),{parent:r}),a.callback,t.slice(1))}return S(void 0,r,e,t)}function oe(r,e){if(!r)throw new Error("Command options are required");const{name:t}=r;if(r.name===void 0)throw new Error("Command name is required");if(!w.test(t))throw new Error(`Invalid command name ${JSON.stringify(t)}. Command names must be one word.`);return{options:r,callback:e}}exports.cli=se,exports.command=oe;
package/dist/index.mjs CHANGED
@@ -1,10 +1,10 @@
1
- var j=Object.defineProperty,K=Object.defineProperties;var q=Object.getOwnPropertyDescriptors;var F=Object.getOwnPropertySymbols;var L=Object.prototype.hasOwnProperty,V=Object.prototype.propertyIsEnumerable;var k=(t,e,n)=>e in t?j(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,u=(t,e)=>{for(var n in e||(e={}))L.call(e,n)&&k(t,n,e[n]);if(F)for(var n of F(e))V.call(e,n)&&k(t,n,e[n]);return t},b=(t,e)=>K(t,q(e));import te from"type-flag";var D=t=>t.replace(/[-_ ](\w)/g,(e,n)=>n.toUpperCase()),T=t=>t.replace(/\B([A-Z])/g,"-$1").toLowerCase();var U={"> 80":[{width:"content-width",paddingLeft:2,paddingRight:8},{width:"auto"}],"> 40":[{width:"auto",paddingLeft:2,paddingRight:8,preprocess:t=>t.trim()},{width:"100%",paddingLeft:2,paddingBottom:1}],"> 0":{stdoutColumns:1e3,columns:[{width:"content-width",paddingLeft:2,paddingRight:8},{width:"content-width"}]}};function E(t){let e=!1,a=Object.keys(t).sort((r,s)=>r.localeCompare(s)).map(r=>{let s=t[r],i="alias"in s;return i&&(e=!0),{name:r,flag:s,flagFormatted:`--${T(r)}`,aliasesEnabled:e,aliasFormatted:i?`-${s.alias}`:void 0}}).map(r=>(r.aliasesEnabled=e,[{type:"flagName",data:r},{type:"flagDescription",data:r}]));return{type:"table",data:{tableData:a,tableBreakpoints:U}}}var S=t=>{var e;return!t||((e=t.version)!=null?e:t.help?t.help.version:void 0)},B=t=>{var n;let e="parent"in t&&((n=t.parent)==null?void 0:n.name);return(e?`${e} `:"")+t.name};function _(t){var a;let e=[];t.name&&e.push(B(t));let n=(a=S(t))!=null?a:"parent"in t&&S(t.parent);if(n&&e.push(`v${n}`),e.length!==0)return{id:"name",type:"text",data:`${e.join(" ")}
2
- `}}function J(t){let{help:e}=t;if(!(!e||!e.description))return{id:"description",type:"text",data:`${e.description}
3
- `}}function M(t){var n;let e=t.help||{};if("usage"in e)return e.usage?{id:"usage",type:"section",data:{title:"Usage:",body:Array.isArray(e.usage)?e.usage.join(`
4
- `):e.usage}}:void 0;if(t.name){let a=[],r=[B(t)];if(t.flags&&Object.keys(t.flags).length>0&&r.push("[flags...]"),t.parameters&&t.parameters.length>0){let{parameters:s}=t,i=s.indexOf("--"),m=i>-1&&s.slice(i+1).some(o=>o.startsWith("<"));r.push(s.map(o=>o!=="--"?o:m?"--":"[--]").join(" "))}if(r.length>1&&a.push(r.join(" ")),"commands"in t&&((n=t.commands)==null?void 0:n.length)&&a.push(`${t.name} <command>`),a.length>0)return{id:"usage",type:"section",data:{title:"Usage:",body:a.join(`
5
- `)}}}}function W(t){var a;if(!("commands"in t)||!((a=t.commands)==null?void 0:a.length))return;let e=t.commands.map(r=>[r.options.name,r.options.help?r.options.help.description:""]);return{id:"commands",type:"section",data:{title:"Commands:",body:{type:"table",data:{tableData:e,tableOptions:[{width:"content-width",paddingLeft:2,paddingRight:8}]}},indentBody:0}}}function Z(t){if(!(!t.flags||Object.keys(t.flags).length===0))return{id:"flags",type:"section",data:{title:"Flags:",body:E(t.flags),indentBody:0}}}function z(t){let{help:e}=t;if(!e||!e.examples||e.examples.length===0)return;let{examples:n}=e;if(Array.isArray(n)&&(n=n.join(`
6
- `)),n)return{id:"examples",type:"section",data:{title:"Examples:",body:n}}}function G(t){if(!("alias"in t)||!t.alias)return;let{alias:e}=t,n=Array.isArray(e)?e.join(", "):e;return{id:"aliases",type:"section",data:{title:"Aliases:",body:n}}}var w=t=>[_,J,M,W,Z,z,G].map(e=>e(t)).filter(e=>Boolean(e));import Q from"tty";import X,{breakpoints as Y}from"terminal-columns";var ee=Q.WriteStream.prototype.hasColors(),P=class{text(e){return e}bold(e){return ee?`${e}`:e.toLocaleUpperCase()}indentText({text:e,spaces:n}){return e.replace(/^/gm," ".repeat(n))}heading(e){return this.bold(e)}section({title:e,body:n,indentBody:a=2}){return`${(e?`${this.heading(e)}
7
- `:"")+(n?this.indentText({text:this.render(n),spaces:a}):"")}
8
- `}table({tableData:e,tableOptions:n,tableBreakpoints:a}){return X(e.map(r=>r.map(s=>this.render(s))),a?Y(a):n)}flagParameter(e){return e===Boolean?"":e===String?"<string>":e===Number?"<number>":Array.isArray(e)?this.flagParameter(e[0]):"<value>"}flagOperator(){return" "}flagName({flag:e,flagFormatted:n,aliasesEnabled:a,aliasFormatted:r}){let s="";if(r?s+=`${r}, `:a&&(s+=" "),s+=n,"placeholder"in e&&typeof e.placeholder=="string")s+=`${this.flagOperator()}${e.placeholder}`;else{let i=this.flagParameter("type"in e?e.type:e);i&&(s+=`${this.flagOperator()}${i}`)}return s}flagDefault(e){return JSON.stringify(e)}flagDescription({flag:e}){var a;let n="description"in e&&(a=e.description)!=null?a:"";if("default"in e){let{default:r}=e;typeof r=="function"&&(r=r()),r&&(n+=` (default: ${this.flagDefault(r)})`)}return n}render(e){if(typeof e=="string")return e;if(Array.isArray(e))return e.map(n=>this.render(n)).join(`
9
- `);if("type"in e&&this[e.type]){let n=this[e.type];if(typeof n=="function")return n.call(this,e.data)}throw new Error(`Invalid node type: ${JSON.stringify(e)}`)}};var O=/^[\w.-]+$/;var{stringify:p}=JSON,ne=/[|\\{}()[\]^$+*?.]/;function v(t){let e=[],n,a;for(let r of t){if(a)throw new Error(`Invalid parameter: Spread parameter ${p(a)} must be last`);let s=r[0],i=r[r.length-1],m;if(s==="<"&&i===">"&&(m=!0,n))throw new Error(`Invalid parameter: Required parameter ${p(r)} cannot come after optional parameter ${p(n)}`);if(s==="["&&i==="]"&&(m=!1,n=r),m===void 0)throw new Error(`Invalid parameter: ${p(r)}. Must be wrapped in <> (required parameter) or [] (optional parameter)`);let o=r.slice(1,-1),d=o.slice(-3)==="...";d&&(a=r,o=o.slice(0,-3));let y=o.match(ne);if(y)throw new Error(`Invalid parameter: ${p(r)}. Invalid character found ${p(y[0])}`);e.push({name:o,required:m,spread:d})}return e}function A(t,e,n,a){for(let r=0;r<e.length;r+=1){let{name:s,required:i,spread:m}=e[r],o=D(s);if(o in t)throw new Error(`Invalid parameter: ${p(s)} is used more than once.`);let d=m?n.slice(r):n[r];if(m&&(r=e.length),i&&(!d||m&&d.length===0))return console.error(`Error: Missing required parameter ${p(s)}
10
- `),a(),process.exit(1);t[o]=d}}function re(t){return t===void 0||t!==!1}function R(t,e,n,a){let r=u({},e.flags),s=e.version;s&&(r.version={type:Boolean,description:"Show version"});let{help:i}=e,m=re(i);m&&!("help"in r)&&(r.help={type:Boolean,alias:"h",description:"Show help"});let o=te(r,a),d=()=>{console.log(e.version)};if(s&&o.flags.version===!0)return d(),process.exit(0);let y=new P,I=m&&(i==null?void 0:i.render)?i.render:l=>y.render(l),h=l=>{let g=w(b(u(u({},e),l?{help:l}:{}),{flags:r}));console.log(I(g,y))};if(m&&o.flags.help===!0)return h(),process.exit(0);if(e.parameters){let{parameters:l}=e,g=o._,x=l.indexOf("--"),N=l.slice(x+1),C=Object.create(null);if(x>-1&&N.length>0){l=l.slice(0,x);let H=o._["--"];g=g.slice(0,-H.length||void 0),A(C,v(l),g,h),A(C,v(N),H,h)}else A(C,v(l),g,h);Object.assign(o._,C)}let $=b(u({},o),{showVersion:d,showHelp:h});return typeof n=="function"&&n($),u({command:t},$)}function ae(t,e){let n=new Map;for(let a of e){let r=[a.options.name],{alias:s}=a.options;s&&(Array.isArray(s)?r.push(...s):r.push(s));for(let i of r){if(n.has(i))throw new Error(`Duplicate command name found: ${p(i)}`);n.set(i,a)}}return n.get(t)}function se(t,e,n=process.argv.slice(2)){if(!t)throw new Error("Options is required");if("name"in t&&(!t.name||!O.test(t.name)))throw new Error(`Invalid script name: ${p(t.name)}`);let a=n[0];if(t.commands&&O.test(a)){let r=ae(a,t.commands);if(r)return R(r.options.name,b(u({},r.options),{parent:t}),r.callback,n.slice(1))}return R(void 0,t,e,n)}function ie(t,e){if(!t)throw new Error("Command options are required");let{name:n}=t;if(t.name===void 0)throw new Error("Command name is required");if(!O.test(n))throw new Error(`Invalid command name ${JSON.stringify(n)}. Command names must be one word.`);return{options:t,callback:e}}export{se as cli,ie as command};
1
+ import S from"type-flag";import B from"tty";import I,{breakpoints as q}from"terminal-columns";const D=r=>r.replace(/[-_ ](\w)/g,(e,t)=>t.toUpperCase()),R=r=>r.replace(/\B([A-Z])/g,"-$1").toLowerCase(),L={"> 80":[{width:"content-width",paddingLeft:2,paddingRight:8},{width:"auto"}],"> 40":[{width:"auto",paddingLeft:2,paddingRight:8,preprocess:r=>r.trim()},{width:"100%",paddingLeft:2,paddingBottom:1}],"> 0":{stdoutColumns:1e3,columns:[{width:"content-width",paddingLeft:2,paddingRight:8},{width:"content-width"}]}};function T(r){let e=!1;const n=Object.keys(r).sort((a,i)=>a.localeCompare(i)).map(a=>{const i=r[a],s="alias"in i;return s&&(e=!0),{name:a,flag:i,flagFormatted:`--${R(a)}`,aliasesEnabled:e,aliasFormatted:s?`-${i.alias}`:void 0}}).map(a=>(a.aliasesEnabled=e,[{type:"flagName",data:a},{type:"flagDescription",data:a}]));return{type:"table",data:{tableData:n,tableBreakpoints:L}}}const P=r=>{var e;return!r||((e=r.version)!=null?e:r.help?r.help.version:void 0)},C=r=>{var e;const t="parent"in r&&((e=r.parent)==null?void 0:e.name);return(t?`${t} `:"")+r.name};function F(r){var e;const t=[];r.name&&t.push(C(r));const n=(e=P(r))!=null?e:"parent"in r&&P(r.parent);if(n&&t.push(`v${n}`),t.length!==0)return{id:"name",type:"text",data:`${t.join(" ")}
2
+ `}}function H(r){const{help:e}=r;if(!(!e||!e.description))return{id:"description",type:"text",data:`${e.description}
3
+ `}}function U(r){var e;const t=r.help||{};if("usage"in t)return t.usage?{id:"usage",type:"section",data:{title:"Usage:",body:Array.isArray(t.usage)?t.usage.join(`
4
+ `):t.usage}}:void 0;if(r.name){const n=[],a=[C(r)];if(r.flags&&Object.keys(r.flags).length>0&&a.push("[flags...]"),r.parameters&&r.parameters.length>0){const{parameters:i}=r,s=i.indexOf("--"),l=s>-1&&i.slice(s+1).some(o=>o.startsWith("<"));a.push(i.map(o=>o!=="--"?o:l?"--":"[--]").join(" "))}if(a.length>1&&n.push(a.join(" ")),"commands"in r&&((e=r.commands)==null?void 0:e.length)&&n.push(`${r.name} <command>`),n.length>0)return{id:"usage",type:"section",data:{title:"Usage:",body:n.join(`
5
+ `)}}}}function V(r){var e;if(!("commands"in r)||!((e=r.commands)!=null&&e.length))return;const t=r.commands.map(a=>[a.options.name,a.options.help?a.options.help.description:""]);return{id:"commands",type:"section",data:{title:"Commands:",body:{type:"table",data:{tableData:t,tableOptions:[{width:"content-width",paddingLeft:2,paddingRight:8}]}},indentBody:0}}}function J(r){if(!(!r.flags||Object.keys(r.flags).length===0))return{id:"flags",type:"section",data:{title:"Flags:",body:T(r.flags),indentBody:0}}}function M(r){const{help:e}=r;if(!e||!e.examples||e.examples.length===0)return;let{examples:t}=e;if(Array.isArray(t)&&(t=t.join(`
6
+ `)),t)return{id:"examples",type:"section",data:{title:"Examples:",body:t}}}function k(r){if(!("alias"in r)||!r.alias)return;const{alias:e}=r,t=Array.isArray(e)?e.join(", "):e;return{id:"aliases",type:"section",data:{title:"Aliases:",body:t}}}const W=r=>[F,H,U,V,J,M,k].map(e=>e(r)).filter(e=>Boolean(e)),Z=B.WriteStream.prototype.hasColors();class z{text(e){return e}bold(e){return Z?`\x1B[1m${e}\x1B[22m`:e.toLocaleUpperCase()}indentText({text:e,spaces:t}){return e.replace(/^/gm," ".repeat(t))}heading(e){return this.bold(e)}section({title:e,body:t,indentBody:n=2}){return`${(e?`${this.heading(e)}
7
+ `:"")+(t?this.indentText({text:this.render(t),spaces:n}):"")}
8
+ `}table({tableData:e,tableOptions:t,tableBreakpoints:n}){return I(e.map(a=>a.map(i=>this.render(i))),n?q(n):t)}flagParameter(e){return e===Boolean?"":e===String?"<string>":e===Number?"<number>":Array.isArray(e)?this.flagParameter(e[0]):"<value>"}flagOperator(e){return" "}flagName(e){const{flag:t,flagFormatted:n,aliasesEnabled:a,aliasFormatted:i}=e;let s="";if(i?s+=`${i}, `:a&&(s+=" "),s+=n,"placeholder"in t&&typeof t.placeholder=="string")s+=`${this.flagOperator(e)}${t.placeholder}`;else{const l=this.flagParameter("type"in t?t.type:t);l&&(s+=`${this.flagOperator(e)}${l}`)}return s}flagDefault(e){return JSON.stringify(e)}flagDescription({flag:e}){var t;let n="description"in e&&(t=e.description)!=null?t:"";if("default"in e){let{default:a}=e;typeof a=="function"&&(a=a()),a&&(n+=` (default: ${this.flagDefault(a)})`)}return n}render(e){if(typeof e=="string")return e;if(Array.isArray(e))return e.map(t=>this.render(t)).join(`
9
+ `);if("type"in e&&this[e.type]){const t=this[e.type];if(typeof t=="function")return t.call(this,e.data)}throw new Error(`Invalid node type: ${JSON.stringify(e)}`)}}const w=/^[\w.-]+$/;var G=Object.defineProperty,K=Object.defineProperties,Q=Object.getOwnPropertyDescriptors,x=Object.getOwnPropertySymbols,X=Object.prototype.hasOwnProperty,Y=Object.prototype.propertyIsEnumerable,A=(r,e,t)=>e in r?G(r,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[e]=t,p=(r,e)=>{for(var t in e||(e={}))X.call(e,t)&&A(r,t,e[t]);if(x)for(var t of x(e))Y.call(e,t)&&A(r,t,e[t]);return r},v=(r,e)=>K(r,Q(e));const{stringify:d}=JSON,ee=/[|\\{}()[\]^$+*?.]/;function b(r){const e=[];let t,n;for(const a of r){if(n)throw new Error(`Invalid parameter: Spread parameter ${d(n)} must be last`);const i=a[0],s=a[a.length-1];let l;if(i==="<"&&s===">"&&(l=!0,t))throw new Error(`Invalid parameter: Required parameter ${d(a)} cannot come after optional parameter ${d(t)}`);if(i==="["&&s==="]"&&(l=!1,t=a),l===void 0)throw new Error(`Invalid parameter: ${d(a)}. Must be wrapped in <> (required parameter) or [] (optional parameter)`);let o=a.slice(1,-1);const f=o.slice(-3)==="...";f&&(n=a,o=o.slice(0,-3));const u=o.match(ee);if(u)throw new Error(`Invalid parameter: ${d(a)}. Invalid character found ${d(u[0])}`);e.push({name:o,required:l,spread:f})}return e}function $(r,e,t,n){for(let a=0;a<e.length;a+=1){const{name:i,required:s,spread:l}=e[a],o=D(i);if(o in r)throw new Error(`Invalid parameter: ${d(i)} is used more than once.`);const f=l?t.slice(a):t[a];if(l&&(a=e.length),s&&(!f||l&&f.length===0))return console.error(`Error: Missing required parameter ${d(i)}
10
+ `),n(),process.exit(1);r[o]=f}}function re(r){return r===void 0||r!==!1}function j(r,e,t,n){const a=p({},e.flags),i=e.version;i&&(a.version={type:Boolean,description:"Show version"});const{help:s}=e,l=re(s);l&&!("help"in a)&&(a.help={type:Boolean,alias:"h",description:"Show help"});const o=S(a,n),f=()=>{console.log(e.version)};if(i&&o.flags.version===!0)return f(),process.exit(0);const u=new z,N=l&&(s==null?void 0:s.render)?s.render:c=>u.render(c),h=c=>{const m=W(v(p(p({},e),c?{help:c}:{}),{flags:a}));console.log(N(m,u))};if(l&&o.flags.help===!0)return h(),process.exit(0);if(e.parameters){let{parameters:c}=e,m=o._;const y=c.indexOf("--"),O=c.slice(y+1),g=Object.create(null);if(y>-1&&O.length>0){c=c.slice(0,y);const E=o._["--"];m=m.slice(0,-E.length||void 0),$(g,b(c),m,h),$(g,b(O),E,h)}else $(g,b(c),m,h);Object.assign(o._,g)}const _=v(p({},o),{showVersion:f,showHelp:h});return typeof t=="function"&&t(_),p({command:r},_)}function te(r,e){const t=new Map;for(const n of e){const a=[n.options.name],{alias:i}=n.options;i&&(Array.isArray(i)?a.push(...i):a.push(i));for(const s of a){if(t.has(s))throw new Error(`Duplicate command name found: ${d(s)}`);t.set(s,n)}}return t.get(r)}function ae(r,e,t=process.argv.slice(2)){if(!r)throw new Error("Options is required");if("name"in r&&(!r.name||!w.test(r.name)))throw new Error(`Invalid script name: ${d(r.name)}`);const n=t[0];if(r.commands&&w.test(n)){const a=te(n,r.commands);if(a)return j(a.options.name,v(p({},a.options),{parent:r}),a.callback,t.slice(1))}return j(void 0,r,e,t)}function ne(r,e){if(!r)throw new Error("Command options are required");const{name:t}=r;if(r.name===void 0)throw new Error("Command name is required");if(!w.test(t))throw new Error(`Invalid command name ${JSON.stringify(t)}. Command names must be one word.`);return{options:r,callback:e}}export{ae as cli,ne as command};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cleye",
3
- "version": "1.1.0",
3
+ "version": "1.2.0",
4
4
  "description": "The intuitive CLI development tool",
5
5
  "keywords": [
6
6
  "cli",
@@ -25,15 +25,14 @@
25
25
  "module": "./dist/index.mjs",
26
26
  "types": "./dist/index.d.ts",
27
27
  "exports": {
28
- ".": {
29
- "require": "./dist/index.js",
30
- "import": "./dist/index.mjs",
31
- "types": "./dist/index.d.ts"
32
- }
28
+ "require": "./dist/index.js",
29
+ "import": "./dist/index.mjs",
30
+ "types": "./dist/index.d.ts"
33
31
  },
34
32
  "scripts": {
35
- "build": "tsup src/index.ts --dts --format esm,cjs --minify",
33
+ "build": "pkgroll --minify",
36
34
  "lint": "eslint .",
35
+ "pretest": "npm run build",
37
36
  "test": "CI=true jest",
38
37
  "test:dts": "tsd"
39
38
  },
@@ -52,19 +51,19 @@
52
51
  "type-flag": "^2.1.0"
53
52
  },
54
53
  "devDependencies": {
55
- "@pvtnbr/eslint-config": "^0.11.0",
56
- "@types/jest": "^27.4.0",
57
- "@types/node": "^17.0.8",
54
+ "@pvtnbr/eslint-config": "^0.19.1",
55
+ "@types/jest": "^27.4.1",
56
+ "@types/node": "^17.0.29",
58
57
  "colorette": "^2.0.16",
59
58
  "es-jest": "^1.5.0",
60
- "eslint": "^8.6.0",
59
+ "eslint": "^8.14.0",
61
60
  "esno": "^0.13.0",
62
61
  "husky": "^4.3.8",
63
62
  "jest": "^27.4.7",
64
63
  "lint-staged": "^12.1.2",
65
- "tsd": "^0.19.1",
66
- "tsup": "^5.11.10",
67
- "typescript": "^4.5.4"
64
+ "pkgroll": "^1.0.5",
65
+ "tsd": "^0.20.0",
66
+ "typescript": "^4.6.3"
68
67
  },
69
68
  "eslintConfig": {
70
69
  "extends": "@pvtnbr",