Compare commits

...

3 Commits

Author SHA1 Message Date
446b1aa9db Updated arg-parser help output
All checks were successful
Build / Build NPM Project (push) Successful in 1m2s
Build / Tag Version (push) Successful in 16s
Build / Publish Documentation (push) Successful in 57s
2024-11-29 18:26:09 -05:00
30be1c5a91 bump 0.23.4
All checks were successful
Build / Build NPM Project (push) Successful in 1m2s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 56s
2024-11-29 17:41:20 -05:00
6b328e64ba Added default help argument to arg-parser
Some checks failed
Build / Tag Version (push) Blocked by required conditions
Build / Publish Documentation (push) Blocked by required conditions
Build / Build NPM Project (push) Has been cancelled
2024-11-29 17:41:00 -05:00
2 changed files with 10 additions and 9 deletions

View File

@ -1,6 +1,6 @@
{ {
"name": "@ztimson/utils", "name": "@ztimson/utils",
"version": "0.23.3", "version": "0.23.5",
"description": "Utility library", "description": "Utility library",
"author": "Zak Timson", "author": "Zak Timson",
"license": "MIT", "license": "MIT",

View File

@ -35,7 +35,8 @@ export class ArgParser {
// Arguments // Arguments
this.commands = argList.filter(arg => arg instanceof ArgParser); this.commands = argList.filter(arg => arg instanceof ArgParser);
this.args = <Arg[]>argList.filter(arg => !(arg instanceof ArgParser) && !arg.flags?.length); this.args = <Arg[]>argList.filter(arg => !(arg instanceof ArgParser) && !arg.flags?.length);
this.flags = <Arg[]>[...argList.filter(arg => !(arg instanceof ArgParser) && arg.flags && arg.flags.length), ...this.flags]; this.flags = <Arg[]>[...argList.filter(arg => !(arg instanceof ArgParser) && arg.flags && arg.flags.length),
{name: 'help', desc: 'Display command\'s help message', flags: ['-h', '--help'], default: false}];
this.defaults = argList.reduce((acc, arg: any) => ({...acc, [arg.name]: arg['extras'] ? [] : (arg.default ?? null)}), {}); this.defaults = argList.reduce((acc, arg: any) => ({...acc, [arg.name]: arg['extras'] ? [] : (arg.default ?? null)}), {});
// Examples // Examples
@ -123,18 +124,18 @@ export class ArgParser {
// Description // Description
let msg = `\n\n${opts.message || this.desc}`; let msg = `\n\n${opts.message || this.desc}`;
// Examples // Examples
msg += '\n\nUsage:\t' + this.examples.map(ex => `run ${this.name} ${ex}`).join('\n\t\t'); msg += '\n\nUsage:\t' + this.examples.map(ex => `${this.name} ${ex}`).join('\n\t');
// Arguments // Arguments
if(this.args.length) msg += '\n\n\t\t' + this.args.map(arg => if(this.args.length) msg += '\n\n\t' + this.args.map(arg =>
`${arg.name.toUpperCase()}${spacer(arg.name)}${arg.desc}`).join('\n\t\t'); `${arg.name.toUpperCase()}${spacer(arg.name)}${arg.desc}`).join('\n\t');
// Flags // Flags
msg += '\n\nOptions:\n\t\t' + this.flags.map(flag => { msg += '\n\nOptions:\n\t' + this.flags.map(flag => {
const flags = flag.flags?.join(', ') || ''; const flags = flag.flags?.join(', ') || '';
return `${flags}${spacer(flags)}${flag.desc}`; return `${flags}${spacer(flags)}${flag.desc}`;
}).join('\n\t\t'); }).join('\n\t');
// Commands // Commands
if(this.commands.length) msg += '\n\nCommands:\n\t\t' + this.commands.map(command => if(this.commands.length) msg += '\n\nCommands:\n\t' + this.commands.map(command =>
`${command.name}${spacer(command.name)}${command.desc}`).join('\n\t\t'); `${command.name}${spacer(command.name)}${command.desc}`).join('\n\t');
return `${msg}\n\n`; return `${msg}\n\n`;
} }
} }