From 446b1aa9db6b22d2320fb7745ae64206686fa477 Mon Sep 17 00:00:00 2001 From: ztimson Date: Fri, 29 Nov 2024 18:26:09 -0500 Subject: [PATCH] Updated arg-parser help output --- package.json | 2 +- src/arg-parser.ts | 19 +++++++++---------- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/package.json b/package.json index 361696c..ccfbf79 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ztimson/utils", - "version": "0.23.4", + "version": "0.23.5", "description": "Utility library", "author": "Zak Timson", "license": "MIT", diff --git a/src/arg-parser.ts b/src/arg-parser.ts index e44cdce..da7111b 100644 --- a/src/arg-parser.ts +++ b/src/arg-parser.ts @@ -14,8 +14,6 @@ export type Arg = { } export class ArgParser { - static readonly helpArg: Arg = {name: 'help', desc: 'Display command\'s help message', flags: ['-h', '--help'], default: false}; - commands: ArgParser[] = []; args: Arg[] = []; flags: Arg[] = []; @@ -37,7 +35,8 @@ export class ArgParser { // Arguments this.commands = argList.filter(arg => arg instanceof ArgParser); this.args = argList.filter(arg => !(arg instanceof ArgParser) && !arg.flags?.length); - this.flags = [...argList.filter(arg => !(arg instanceof ArgParser) && arg.flags && arg.flags.length), ...this.flags]; + this.flags = [...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)}), {}); // Examples @@ -125,18 +124,18 @@ export class ArgParser { // Description let msg = `\n\n${opts.message || this.desc}`; // 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 - if(this.args.length) msg += '\n\n\t\t' + this.args.map(arg => - `${arg.name.toUpperCase()}${spacer(arg.name)}${arg.desc}`).join('\n\t\t'); + if(this.args.length) msg += '\n\n\t' + this.args.map(arg => + `${arg.name.toUpperCase()}${spacer(arg.name)}${arg.desc}`).join('\n\t'); // 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(', ') || ''; return `${flags}${spacer(flags)}${flag.desc}`; - }).join('\n\t\t'); + }).join('\n\t'); // Commands - if(this.commands.length) msg += '\n\nCommands:\n\t\t' + this.commands.map(command => - `${command.name}${spacer(command.name)}${command.desc}`).join('\n\t\t'); + if(this.commands.length) msg += '\n\nCommands:\n\t' + this.commands.map(command => + `${command.name}${spacer(command.name)}${command.desc}`).join('\n\t'); return `${msg}\n\n`; } }