ts.ts: finish parity for now

- adds comments
- consistent conventions
- help parity with bash

Author: balupton

commands/ai-sync

@@ -4,25 +4,26 @@ import {
 	HelpError,
 	exitWithError,
 	writeStdoutPlain,
+	heredoc,
 	asString,
 	asError,
 } from '../sources/ts.ts'
 
 // Custom error for this command with help text
 class UsageError extends HelpError {
-	override help = [
-		'USAGE:',
-		'`ai-sync --import-typingmind-json-export=<path> --target=anythingllm`',
-		'',
-		'OPTIONS:',
-		'--import-typingmind-json-export=<typingmind-json-export>',
-		'    Path to the TypingMind export saved as .json file.',
-		'--target=<target>',
-		'    Import target (currently: AnythingLLM)',
-		'',
-		'EXAMPLES:',
-		'`ai-sync --import-typingmind-json-export="$HOME/Downloads/typingmind.json" --target=anythingllm`',
-	].join('\n')
+	override help = heredoc`
+		USAGE:
+		\`ai-sync --import-typingmind-json-export=<path> --target=anythingllm\`
+
+		OPTIONS:
+		--import-typingmind-json-export=<typingmind-json-export>
+		    Path to the TypingMind export saved as .json file.
+		--target=<target>
+		    Import target (currently: AnythingLLM)
+
+		EXAMPLES:
+		\`ai-sync --import-typingmind-json-export="$HOME/Downloads/typingmind.json" --target=anythingllm\`
+	`
 }
 
 // Validate target

commands/brew-installed.ts

@@ -1,61 +1,81 @@
 #!/usr/bin/env -S eval-wsl deno run --quiet --no-config --no-lock --no-npm --no-remote --cached-only
 // deno-lint-ignore-file no-explicit-any
 
-// parse stdin
-const json = await new Response(Deno.stdin.readable).json()
-
-// prepare result
-const names = new Set<string>()
-
-// type
-const type: 'cask' | 'formula' | 'tap' | '' = Deno.args.includes('--type=cask')
-	? 'cask'
-	: Deno.args.includes('--type=formula')
-		? 'formula'
-		: Deno.args.includes('--type=tap')
-			? 'tap'
-			: ''
-
-// add taps if desired
-if (['tap'].includes(type)) {
-	// all taps are by request
-	const taps = json || []
-	for (const tap of taps.filter((i: any) => i.installed)) {
-		names.add(tap.name)
-	}
+import { heredoc, HelpError, exitWithError, wantsHelp } from '../sources/ts.ts'
+
+class UsageError extends HelpError {
+	override help = heredoc`
+		USAGE:
+		\`brew-installed.ts [--type=<cask|formula|tap>] [--requested] <brew.json\`
+	`
 }
 
-// add casks if desired
-if (['', 'cask'].includes(type)) {
-	// all casks are by request
-	const casks = json.casks || []
-	for (const cask of casks.filter((i: any) => i.installed)) {
-		names.add(cask.full_token)
+async function main(...args: string[]) {
+	// parse stdin
+	const json = await new Response(Deno.stdin.readable).json()
+
+	// prepare result
+	const names = new Set<string>()
+
+	// type
+	const type: 'cask' | 'formula' | 'tap' | '' = args.includes('--type=cask')
+		? 'cask'
+		: args.includes('--type=formula')
+			? 'formula'
+			: args.includes('--type=tap')
+				? 'tap'
+				: ''
+
+	// add taps if desired
+	if (['tap'].includes(type)) {
+		// all taps are by request
+		const taps = json || []
+		for (const tap of taps.filter((i: any) => i.installed)) {
+			names.add(tap.name)
+		}
 	}
-}
 
-// add formulas if desired
-if (['', 'formula'].includes(type)) {
-	// formulas could be by request, or by dependency
-	const formulae = json.formulae || []
-	if (Deno.args.includes('--requested')) {
-		// only requested formula
-		for (const formula of formulae) {
-			if (formula.installed.find((i: any) => i.installed_on_request)) {
+	// add casks if desired
+	if (['', 'cask'].includes(type)) {
+		// all casks are by request
+		const casks = json.casks || []
+		for (const cask of casks.filter((i: any) => i.installed)) {
+			names.add(cask.full_token)
+		}
+	}
+
+	// add formulas if desired
+	if (['', 'formula'].includes(type)) {
+		// formulas could be by request, or by dependency
+		const formulae = json.formulae || []
+		if (args.includes('--requested')) {
+			// only requested formula
+			for (const formula of formulae) {
+				if (formula.installed.find((i: any) => i.installed_on_request)) {
+					names.add(formula.full_name)
+				}
+			}
+		} else {
+			// all formula
+			for (const formula of formulae.filter((i: any) => i.installed)) {
 				names.add(formula.full_name)
 			}
 		}
-	} else {
-		// all formula
-		for (const formula of formulae.filter((i: any) => i.installed)) {
-			names.add(formula.full_name)
-		}
+	}
+
+	// output result
+	if (names.size) {
+		await Deno.stdout.write(
+			new TextEncoder().encode(Array.from(names).sort().concat('').join('\n')),
+		)
 	}
 }
 
-// output result
-if (names.size) {
-	await Deno.stdout.write(
-		new TextEncoder().encode(Array.from(names).sort().concat('').join('\n')),
-	)
+try {
+	if (wantsHelp(Deno.args)) {
+		throw new UsageError()
+	}
+	await main(...Deno.args)
+} catch (error) {
+	await exitWithError(error)
 }

commands/echo-help.ts

@@ -5,31 +5,34 @@ import {
 	exitWithError,
 	readStdinWhole,
 	exec,
+	heredoc,
+	wantsHelp,
+	wantsTests,
 } from '../sources/ts.ts'
 
 class UsageError extends HelpError {
-	override help = [
-		'USAGE:',
-		'`echo-help.ts --test`',
-		'`echo-help.ts --help`',
-		'`echo-help.ts [...<styled error messages>] < template.txt`',
-		'',
-		'NOTE:',
-		'This is a test implementation only. Use the bash version `echo-help` for production.',
-	].join('\n')
+	override help = heredoc`
+		USAGE:
+		\`echo-help.ts --test\`
+		\`echo-help.ts --help\`
+		\`echo-help.ts [...<styled error messages>] <template.txt\`
+
+		NOTE:
+		This is a test implementation only. Use the bash version \`echo-help\` for production.
+	`
 }
 
 // Execute
 async function main(...args: string[]) {
 	const help = await readStdinWhole()
-	throw new HelpError({help, code: 0}, ...args)
+	throw new HelpError({ help, code: 0 }, ...args)
 }
 
 // invoke command or tests
 try {
-	if (Deno.args.join('') == '--help' ) {
+	if (wantsHelp(Deno.args)) {
 		throw new UsageError()
-	} else if (Deno.args.join('') == '--test' ) {
+	} else if (wantsTests(Deno.args)) {
 		await exec(['eval-tester', '--fixture=echo-help', '--', 'echo-help.ts'])
 	} else {
 		await main(...Deno.args)

commands/echo-html-coder.ts

@@ -1,6 +1,30 @@
 #!/usr/bin/env -S eval-wsl deno run --quiet --no-config --no-lock --no-npm
+
+import { heredoc, HelpError, exitWithError, wantsHelp } from '../sources/ts.ts'
 import { Html5Entities } from 'https://deno.land/x/html_entities@v1.0/mod.js'
-const coder =
-	Deno.args[0] === 'decode' ? Html5Entities.decode : Html5Entities.encode
-const url = Deno.args[1]
-console.log(coder(url))
+
+class UsageError extends HelpError {
+	override help = heredoc`
+		USAGE:
+		\`echo-html-coder.ts <encode|decode> <text>\`
+	`
+}
+
+function main(...args: string[]) {
+	if (args.length < 2) {
+		throw new UsageError('--help=Expected <encode|decode> and <text>.')
+	}
+	const coder =
+		args[0] === 'decode' ? Html5Entities.decode : Html5Entities.encode
+	const value = args[1]
+	console.log(coder(value))
+}
+
+try {
+	if (wantsHelp(Deno.args)) {
+		throw new UsageError()
+	}
+	main(...Deno.args)
+} catch (error) {
+	await exitWithError(error)
+}

commands/echo-json.ts

@@ -1,12 +1,14 @@
 #!/usr/bin/env -S eval-wsl deno run --quiet --no-config --no-lock --no-npm --no-remote --cached-only
+// deno-lint-ignore-file no-unreachable
 
-import { styleText } from 'node:util'
 import {
 	HelpError,
 	exitWithError,
 	writeStdoutStringify,
 	writeStdoutPlain,
 	writeStdoutPretty,
+	heredoc,
+	wantsHelp,
 	asString,
 	asError,
 	assertFactory,
@@ -18,11 +20,11 @@ const { values: actionValues, as: asAction } = assertFactory(
 )
 
 class UsageError extends HelpError {
-	override help = [
-		'USAGE:',
-		'`echo-json.ts <make> [--] ...[<key> <value>]`',
-		`\`echo-json.ts <${actionValues.join('|')}> [--] ...<input>\``,
-	].join('\n')
+	override help = heredoc`
+		USAGE:
+		\`echo-json.ts <make> [--] ...[<key> <value>]\`
+		\`echo-json.ts <${actionValues.join('|')}> [--] ...<input>\`
+	`
 }
 
 // Parsing
@@ -52,7 +54,7 @@ function parse(input: string): {
 
 // Execute
 // <action> [...options] ...<input>
-async function main(...args: string[]) {
+function main(...args: string[]) {
 	// parse <action>
 	if (args.length === 0) {
 		throw new UsageError(`--help=No <action> was provided.`)
@@ -158,7 +160,10 @@ async function main(...args: string[]) {
 }
 
 try {
+	if (wantsHelp(Deno.args)) {
+		throw new UsageError()
+	}
 	await main(...Deno.args)
 } catch (error) {
-	exitWithError(error)
+	await exitWithError(error)
 }

commands/echo-math.ts

@@ -1,6 +1,61 @@
 #!/usr/bin/env -S eval-wsl deno run --quiet --no-config --no-lock --no-npm --no-remote --cached-only
-const precision = Number(Deno.args[0])
-const formula = Deno.args[1]
-const result = Number(eval(formula))
-const output = result.toFixed(precision)
-console.log(output)
+
+import { heredoc, HelpError, exitWithError, wantsHelp } from '../sources/ts.ts'
+
+class UsageError extends HelpError {
+	override help = heredoc`
+		USAGE:
+		\`echo-math.ts <precision> <formula>\`
+
+		EXAMPLE:
+		\`echo-math.ts 2 "1/3"\`
+	`
+}
+
+function assertFormula(value: unknown): asserts value is string {
+	if (typeof value !== 'string' || value.trim() === '') {
+		throw new UsageError('--help=<formula> must be a non-empty string.')
+	}
+	if (!/^[0-9+\-*/%().\s]+$/.test(value)) {
+		throw new UsageError(
+			'--help=The <formula> may only contain numbers, spaces, and math operators: \`+ - * / % ( ) .\`',
+		)
+	}
+}
+
+function assertPrecision(value: number): asserts value is number {
+	if (!Number.isFinite(value) || !Number.isInteger(value) || value < 0) {
+		throw new UsageError('--help=<precision> must be a non-negative integer.')
+	}
+}
+
+function assertEvaluatedNumber(value: number): asserts value is number {
+	if (Number.isNaN(value)) {
+		throw new UsageError('--help=<formula> must evaluate to a number.')
+	}
+}
+
+function main(...args: string[]) {
+	if (args.length < 2) {
+		throw new UsageError('--help=Expected <precision> and <formula>.')
+	}
+	const precisionInput: unknown = args[0]
+	const formulaInput: unknown = args[1]
+	assertFormula(formulaInput)
+	const precision = Number(precisionInput)
+	assertPrecision(precision)
+	const formula = formulaInput
+	const result = Number(eval(formula))
+	assertEvaluatedNumber(result)
+	const output = result.toFixed(precision)
+	console.log(output)
+}
+
+try {
+	if (wantsHelp(Deno.args)) {
+		throw new UsageError()
+	}
+	main(...Deno.args)
+} catch (error) {
+	await exitWithError(error)
+}