Updated arg-parser help output

bump 0.23.4
Added default help argument to arg-parser
2024-11-29 18:26:09 -05:00 · 2024-11-29 17:41:20 -05:00 · 2024-11-29 17:41:00 -05:00 · 2024-11-29 17:26:07 -05:00 · 2024-11-24 11:08:17 -05:00 · 2024-11-20 11:03:15 -05:00
6 changed files with 227 additions and 20 deletions
--- a/index.html
+++ b/index.html
@ -6,10 +6,31 @@
 	</head>
 	<body>
 		<script type="module">
-			import {adjustTz, formatDate} from './dist/index.mjs';
+			import {ArgParser} from './dist/index.mjs';

-			console.log(formatDate(new Date(), 'HH:mm:ss z'));
-			console.log(formatDate(adjustTz(new Date(), 0), 'HH:mm:ss z', 'UTC'));
+			const hostname = 'test';
+			const argParser = new ArgParser('botnet-manager.js', 'Connect & manage a network of servers to launch distributed attacks.', [
+				new ArgParser('copy', 'Copy file & dependencies to botnet', [
+					{name: 'file', desc: 'File to copy', default: false},
+					{name: 'control', desc: 'Copy to master server', flags: ['-c', '--control'], default: false},
+					{name: 'noDeps', desc: 'Skip copying dependencies', flags: ['-d', '--no-deps'], default: false},
+					{name: 'slave', desc: 'Copy to slave servers', flags: ['-s', '--slave'], default: false},
+				]),
+				new ArgParser('join', 'Connect server as a botnet slave', [
+					{name: 'device', desc: 'Device to connect, defaults to the current machine', optional: true, default: hostname}
+				]),
+				new ArgParser('kill', 'Kill any scripts running on the botnet'),
+				new ArgParser('leave', 'Disconnect worker node from swarm', [
+					{name: 'device', desc: 'Device to disconnect, defaults to the current machine', optional: true, default: hostname}
+				]),
+				new ArgParser('run', 'Copy & run script on the botnet', [
+					{name: 'script', desc: 'Script to copy & execute', type: 'string'},
+					{name: 'args', desc: 'Arguments for script. Forward the current target with: {{TARGET}}', optional: true, extras: true},
+				]),
+				new ArgParser('start', 'Start this server as the botnet manager'),
+				{name: 'silent', desc: 'Suppress program output', flags: ['-s', '--silent'], default: false},
+			]);
+			console.log(argParser.help({}));
 		</script>
 	</body>
 </html>
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.22.9",
+	"version": "0.23.5",
 	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",
--- a/src/arg-parser.ts
+++ b/src/arg-parser.ts
@ -0,0 +1,141 @@
+export type Arg<T = any> = {
+	/** Argument/property name */
+	name: string;
+	/** Argument description for help page */
+	desc: string;
+	/** Available shorthands */
+	flags?: string[];
+	/** Argument is not required */
+	optional?: boolean;
+	/** Default value if argument is not used */
+	default?: T;
+	/** Collects any unmatched arguments */
+	extras?: boolean;
+}
+
+export class ArgParser {
+	commands: ArgParser[] = [];
+	args: Arg[] = [];
+	flags: Arg[] = [];
+	defaults!: {[key: string]: any};
+
+	/**
+	 * Create a unix-like argument parser to extract flags from the argument list. Can also create help messages.
+	 *
+	 * @param {string} name Script name
+	 * @param {string} desc Help description
+	 * @param {(ArgParser | Arg[]} argList Array of CLI arguments
+	 * @param {string[]} examples Additional examples to display
+	 */
+	constructor(public readonly name: string,
+				public readonly desc: string,
+				public readonly argList: (ArgParser | Arg)[] = [],
+				public readonly examples: string[] = []
+	) {
+		// Arguments
+		this.commands = argList.filter(arg => arg instanceof ArgParser);
+		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),
+			{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
+		this.examples = <string[]>[
+			...examples,
+			`[OPTIONS] ${this.args.map(arg => (arg.optional ? `[${arg.name.toUpperCase()}]` : arg.name.toUpperCase()) + (arg.extras ? '...' : '')).join(' ')}`,
+			this.commands.length ? `[OPTIONS] COMMAND` : null,
+			`--help ${this.commands.length ? '[COMMAND]' : ''}`
+		].filter(e => !!e);
+	}
+
+	/**
+	 * Parse an array into an arguments dictionary using the configuration.
+	 *
+	 * @param {string[]} args Array of arguments to be parsed
+	 * @returns {object} Dictionary of arguments with defaults applied
+	 */
+	parse(args: string[]) {
+		// Parse arguments
+		let extras = [], parsed: any = {...this.defaults, '_error': []}, queue = [...args];
+		while(queue.length) {
+			let arg = queue.splice(0, 1)[0];
+			if(arg[0] == '-') { // Flags
+				// Check for combined shorthand
+				if(arg[1] != '-' && arg.length > 2) {
+					queue = [...arg.substring(2).split('').map(a => `-${a}`), ...queue];
+					arg = `-${arg[1]}`;
+				}
+				// Find & add flag
+				const combined = arg.split('=');
+				const argDef = this.flags.find(flag => flag.flags?.includes(combined[0] || arg));
+				if(argDef == null) { // Not found, add to extras
+					extras.push(arg);
+					continue;
+				}
+				const value = argDef.default === false ? true :
+							  argDef.default === true ? false :
+							  queue.splice(queue.findIndex(q => q[0] != '-'), 1)[0] ||
+							  argDef.default;
+				if(value == null) parsed['_error'].push(`Option missing value: ${argDef.name || combined[0]}`);
+				parsed[argDef.name] = value;
+			} else { // Command
+				const c = this.commands.find(command => command.name == arg);
+				if(!!c) {
+					const parsedCommand = c.parse(queue.splice(0, queue.length));
+					Object.keys(parsedCommand).forEach(key => {
+						if(parsed[key] != parsedCommand[key] && parsedCommand[key] == c.defaults[key])
+							delete parsedCommand[key];
+					});
+					parsed = {
+						...parsed,
+						...parsedCommand,
+						_command: c.name
+					};
+				} else extras.push(arg); // Not found, add to extras
+			}
+		}
+		// Arguments
+		this.args.filter(arg => !arg.extras).forEach(arg => {
+			if(!arg.optional && !extras.length) parsed['_error'].push(`Argument missing: ${arg.name.toUpperCase()}`);
+			if(extras.length) parsed[arg.name] = extras.splice(0, 1)[0];
+		});
+		// Extras
+		const extraKey = this.args.find(arg => arg.extras)?.name || '_extra';
+		parsed[extraKey] = extras;
+		return parsed;
+	}
+
+	/**
+	 * Create help message from the provided description & argument list.
+	 *
+	 * @returns {string} Help message
+	 * @param opts Help options: command - display a commands help, message - override help description
+	 */
+	help(opts: {command?: string, message?: string} = {}): string {
+		const spacer = (text: string) => Array(24 - text.length || 1).fill(' ').join('');
+
+		// Help with specific command
+		if(opts.command) {
+			const argParser = this.commands.find(parser => parser.name == opts.command);
+			if(!argParser) throw new Error(`${opts.command.toUpperCase()} is not a command`)
+			return argParser.help({...opts, command: undefined});
+		}
+
+		// Description
+		let msg = `\n\n${opts.message || this.desc}`;
+		// Examples
+		msg += '\n\nUsage:\t' + this.examples.map(ex => `${this.name} ${ex}`).join('\n\t');
+		// Arguments
+		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' + this.flags.map(flag => {
+			const flags = flag.flags?.join(', ') || '';
+			return `${flags}${spacer(flags)}${flag.desc}`;
+		}).join('\n\t');
+		// Commands
+		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`;
+	}
+}
--- a/src/index.ts
+++ b/src/index.ts
@ -1,3 +1,4 @@
+export * from './arg-parser';
 export * from './array';
 export * from './aset';
 export * from './cache';
--- a/src/objects.ts
+++ b/src/objects.ts
@ -224,6 +224,17 @@ export function JSONAttemptParse<T1, T2>(json: T2): T1 | T2 {
 	catch { return json; }
 }

+/**
+ * Stringifies objects & skips primitives
+ *
+ * @param {any} obj Object to convert to serializable value
+ * @return {string | T} Serialized value
+ */
+export function JSONSerialize<T1>(obj: T1): T1 | string {
+	if(typeof obj == 'object' && obj != null) return JSONSanitize(obj);
+	return obj;
+}
+
 /**
 * Convert an object to a JSON string avoiding any circular references.
 *
--- a/src/time.ts
+++ b/src/time.ts
@ -20,12 +20,6 @@ export function adjustedInterval(cb: Function, ms: number) {
 	}
 }

-export function adjustTz(date: Date, offset: number) {
-	const currentOffset = date.getTimezoneOffset();
-	offset = currentOffset - offset * 60;
-	return new Date(date.getTime() + offset * 60000);
-}
-
 /**
 * Format date
 *
@ -34,8 +28,43 @@ export function adjustTz(date: Date, offset: number) {
 * @param tz Override timezone, can be either string or number
 * @return {string} Formated date
 */
-export function formatDate(date: Date | number | string, format = 'YYYY-MM-DD H:mm', tz?: any): string {
-	if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
+export function formatDate(date: Date | number | string, format = 'YYYY-MM-DD H:mm', tz?: string | number): string {
+	const timezones = [
+		['IDLW', -12],
+		['SST', -11],
+		['HST', -10],
+		['AKST', -9],
+		['PST', -8],
+		['MST', -7],
+		['CST', -6],
+		['EST', -5],
+		['AST', -4],
+		['BRT', -3],
+		['MAT', -2],
+		['AZOT', -1],
+		['UTC', 0],
+		['CET', 1],
+		['EET', 2],
+		['MSK', 3],
+		['AST', 4],
+		['PKT', 5],
+		['IST', 5.5],
+		['BST', 6],
+		['ICT', 7],
+		['CST', 8],
+		['JST', 9],
+		['AEST', 10],
+		['SBT', 11],
+		['FJT', 12],
+		['TOT', 13],
+		['LINT', 14]
+	];
+
+	function adjustTz(date: Date, gmt: number) {
+		const currentOffset = date.getTimezoneOffset();
+		const adjustedOffset = gmt * 60;
+		return new Date(date.getTime() + (adjustedOffset + currentOffset) * 60000);
+	}

 	function day(num: number): string {
 		switch(num) {
@ -89,10 +118,14 @@ export function formatDate(date: Date | number | string, format = 'YYYY-MM-DD H:
 		return (offset > 0 ? '-' : '') + `${hours}:${minutes.toString().padStart(2, '0')}`;
 	}

-	function timezone(date: Date): string {
-		return new Intl.DateTimeFormat('en-US', {timeZoneName: 'short'})
-			.format(date).split(' ').pop() || '';
-	}
+	if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
+
+	// Handle timezones
+	let t!: [string, number];
+	if(tz == null) tz = -(date.getTimezoneOffset() / 60);
+	t = <any>timezones.find(t => isNaN(<any>tz) ? t[0] == tz : t[1] == tz);
+	if(!t) throw new Error(`Unknown timezone: ${tz}`);
+	date = adjustTz(date, t[1]);

 	return format
 		// Year
@ -100,7 +133,7 @@ export function formatDate(date: Date | number | string, format = 'YYYY-MM-DD H:
 		.replaceAll('YY', date.getFullYear().toString().slice(2))
 		// Month
 		.replaceAll('MMMM', month(date.getMonth()))
-		.replaceAll('MMM', month(date.getMonth()).slice(0, 2))
+		.replaceAll('MMM', month(date.getMonth()).slice(0, 3))
 		.replaceAll('MM', (date.getMonth() + 1).toString().padStart(2, '0'))
 		.replaceAll('M', (date.getMonth() + 1).toString())
 		// Day
@ -131,9 +164,9 @@ export function formatDate(date: Date | number | string, format = 'YYYY-MM-DD H:
 		.replaceAll('A', date.getHours() >= 12 ? 'PM' : 'AM')
 		.replaceAll('a', date.getHours() >= 12 ? 'pm' : 'am')
 		// Timezone
-		.replaceAll('ZZ', tzOffset(isNaN(tz) ? date.getTimezoneOffset() : tz).replace(':', ''))
-		.replaceAll('Z', tzOffset(isNaN(tz) ? date.getTimezoneOffset() : tz))
-		.replaceAll('z', typeof tz == 'string' ? tz : timezone(date));
+		.replaceAll('ZZ', tzOffset(t[1] * 60).replace(':', ''))
+		.replaceAll('Z', tzOffset(t[1] * 60))
+		.replaceAll('z', typeof tz == 'string' ? tz : (<any>t)[0]);
 }

 /**
Author	SHA1	Message	Date
ztimson	446b1aa9db	Updated arg-parser help output All checks were successful Build / Build NPM Project (push) Successful in 1m2s Details Build / Tag Version (push) Successful in 16s Details Build / Publish Documentation (push) Successful in 57s Details	2024-11-29 18:26:09 -05:00
ztimson	30be1c5a91	bump 0.23.4 All checks were successful Build / Build NPM Project (push) Successful in 1m2s Details Build / Tag Version (push) Successful in 14s Details Build / Publish Documentation (push) Successful in 56s Details	2024-11-29 17:41:20 -05:00
ztimson	6b328e64ba	Added default help argument to arg-parser Some checks failed Build / Tag Version (push) Blocked by required conditions Details Build / Publish Documentation (push) Blocked by required conditions Details Build / Build NPM Project (push) Has been cancelled Details	2024-11-29 17:41:00 -05:00
ztimson	435be31347	Added arg-parser All checks were successful Build / Build NPM Project (push) Successful in 1m46s Details Build / Tag Version (push) Successful in 19s Details Build / Publish Documentation (push) Successful in 1m10s Details	2024-11-29 17:26:07 -05:00
ztimson	2522635815	Added JSONSerialize All checks were successful Build / Build NPM Project (push) Successful in 1m12s Details Build / Tag Version (push) Successful in 12s Details Build / Publish Documentation (push) Successful in 48s Details	2024-11-24 11:08:17 -05:00
ztimson	e8fdca8236	bump 0.23.1 All checks were successful Build / Build NPM Project (push) Successful in 38s Details Build / Tag Version (push) Successful in 7s Details Build / Publish Documentation (push) Successful in 1m40s Details	2024-11-20 11:03:15 -05:00
ztimson	67ae86d69b	Added India Standard Time to formatDate All checks were successful Build / Build NPM Project (push) Successful in 33s Details Build / Tag Version (push) Successful in 7s Details Build / Publish Documentation (push) Successful in 1m42s Details	2024-11-20 10:58:31 -05:00
ztimson	87db4d4755	Combined adjustTz into formatDate Some checks failed Build / Tag Version (push) Has been cancelled Details Build / Publish Documentation (push) Has been cancelled Details Build / Build NPM Project (push) Has been cancelled Details	2024-11-20 10:56:51 -05:00
ztimson	0fb1e13ba0	Fixed timezone adjust All checks were successful Build / Build NPM Project (push) Successful in 1m12s Details Build / Tag Version (push) Successful in 11s Details Build / Publish Documentation (push) Successful in 2m4s Details	2024-11-20 10:04:17 -05:00
ztimson	ff4401934c	Fixed formatDate month shortform All checks were successful Build / Build NPM Project (push) Successful in 1m21s Details Build / Tag Version (push) Successful in 13s Details Build / Publish Documentation (push) Successful in 1m57s Details	2024-11-16 11:02:32 -05:00