hackmud-script-manager 0.20.4-23a791c → 0.20.4-34f0749

package/README.md

@@ -20,6 +20,10 @@ You can read about how HSM works [in my blog post](https://samual.uk/blog/js-cod
 > ```
 > You will need to run `Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser` in PowerShell as an administrator. For more information, see [Microsoft's page about Execution Policies](https://learn.microsoft.com/en-gb/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.4).
 
+![image](https://github.com/samualtnorman/hackmud-script-manager/assets/18307063/69a371fe-f8c8-43fe-b3c7-39f3735ce6fb)
+![image](https://github.com/samualtnorman/hackmud-script-manager/assets/18307063/08103f9e-74fa-4a56-a739-94858ba8c139)
+![image](https://github.com/samualtnorman/hackmud-script-manager/assets/18307063/25ccb86d-1fe3-4632-b703-ac47f5b32c9c)
+
 ## Features
 - Minification
     - This includes auto quine cheating.

package/bin/hsm.js

@@ -5,14 +5,16 @@ import { countHackmudCharacters } from "@samual/lib/countHackmudCharacters"
 import { writeFilePersistent } from "@samual/lib/writeFilePersistent"
 import { writeFile, readFile } from "fs/promises"
 import { homedir } from "os"
-import { extname, basename, resolve, dirname, relative } from "path"
+import { resolve, extname, basename, dirname, relative } from "path"
 import { supportedExtensions } from "../constants.js"
 import { generateTypeDeclaration } from "../generateTypeDeclaration.js"
 import { pull } from "../pull.js"
 import { syncMacros } from "../syncMacros.js"
 import "@samual/lib/readDirectoryWithStats"
+import "path/posix"
 import "@samual/lib/copyFilePersistent"
-const version = "0.20.4-23a791c",
+const version = "0.20.4-34f0749",
+	formatOption = name => colourN(`-${1 == name.length ? "" : "-"}${name}`),
 	options = new Map(),
 	commands = [],
 	userColours = new Cache(user => {
@@ -36,10 +38,6 @@ for (const argument of process.argv.slice(2))
 		if ("-" == argument[1]) options.set(key.slice(2), value)
 		else for (const option of key.slice(1)) options.set(option, value)
 	} else commands.push(argument)
-if ("v" == commands[0] || "version" == commands[0] || options.get("version") || options.get("v")) {
-	console.log(version)
-	process.exit()
-}
 const pushModule = import("../push.js"),
 	processScriptModule = import("../processScript/index.js"),
 	watchModule = import("../watch.js"),
@@ -49,6 +47,7 @@ const pushModule = import("../push.js"),
 	colourB = chalk.rgb(202, 202, 202),
 	colourC = chalk.rgb(155, 155, 155),
 	colourD = chalk.rgb(255, 0, 0),
+	colourF = chalk.rgb(255, 128, 0),
 	colourJ = chalk.rgb(255, 244, 4),
 	colourK = chalk.rgb(243, 249, 152),
 	colourL = chalk.rgb(30, 255, 0),
@@ -57,153 +56,171 @@ const pushModule = import("../push.js"),
 	colourS = chalk.rgb(122, 178, 244),
 	colourV = chalk.rgb(255, 0, 236),
 	colourW = chalk.rgb(255, 150, 224)
-if (options.get("help") || options.get("h")) {
+process.version.startsWith("v21.") &&
+	console.warn(
+		colourF(
+			"Warning: Support for Node.js 21 will be dropped in the next minor version of HSM\n         You should update your version of Node.js\n         https://nodejs.org/en/download/package-manager"
+		)
+	)
+if ("v" == commands[0] || "version" == commands[0] || popOption("version", "v")?.value) {
+	console.log(version)
+	process.exit()
+}
+if (popOption("help", "h")?.value) {
 	logHelp()
 	process.exit()
 }
 let autoExit = !0
 switch (commands[0]) {
 	case "push":
+	case "dev":
+	case "watch":
+	case "golf":
+	case "minify":
 		{
-			const hackmudPath = getHackmudPath(),
-				sourcePath = commands[1]
-			if (!sourcePath) {
-				logError("Must provide the directory to push from\n")
-				logHelp()
-				break
-			}
-			const scripts = commands.slice(2)
-			if (scripts.length) {
-				const invalidScript = scripts.find(
-					script => !/^(?:[a-z_][a-z\d_]{0,24}|\*)\.(?:[a-z_][a-z\d_]{0,24}|\*)$/.test(script)
-				)
-				if (invalidScript) {
-					logError(`Invalid script name: ${JSON.stringify(invalidScript)}\n`)
-					logHelp()
-					break
-				}
-			} else scripts.push("*.*")
-			const optionsHasNoMinify = options.has("no-minify")
-			if ((optionsHasNoMinify || options.has("skip-minify")) && options.has("mangle-names")) {
+			const noMinifyOption = popOption("no-minify", "skip-minify"),
+				mangleNamesOption = popOption("mangle-names"),
+				forceQuineCheatsOption = popOption("force-quine-cheats"),
+				noMinifyIncompatibleOption = mangleNamesOption || forceQuineCheatsOption
+			if (noMinifyOption && noMinifyIncompatibleOption) {
 				logError(
-					`Options ${colourN("--mangle-names")} and ${colourN(optionsHasNoMinify ? "--no-minify" : "--skip-minify")} are incompatible\n`
+					`Options ${formatOption(noMinifyOption.name)} and ${formatOption(noMinifyIncompatibleOption.name)} are incompatible\n`
 				)
 				logHelp()
-				break
+				process.exit(1)
 			}
-			const shouldSkipMinify = options.get("no-minify") || options.get("skip-minify")
-			let shouldMinify
-			if (null != shouldSkipMinify) {
-				if ("boolean" != typeof shouldSkipMinify) {
+			noMinifyOption && assertOptionIsBoolean(noMinifyOption)
+			mangleNamesOption && assertOptionIsBoolean(mangleNamesOption)
+			forceQuineCheatsOption && assertOptionIsBoolean(forceQuineCheatsOption)
+			if ("golf" == commands[0] || "minify" == commands[0]) {
+				const watchOption = popOption("watch"),
+					target = commands[1]
+				if (!target) {
+					logError("Must provide target\n")
+					logHelp()
+					process.exit(1)
+				}
+				const fileExtension = extname(target)
+				if (!supportedExtensions.includes(fileExtension)) {
 					logError(
-						`The value for ${colourN(optionsHasNoMinify ? "--no-minify" : "--skip-minify")} must be ${colourV("true")} or ${colourV("false")}\n`
+						`Unsupported file extension "${chalk.bold(fileExtension)}"\nSupported extensions are "${supportedExtensions.map(extension => chalk.bold(extension)).join('", "')}"`
 					)
-					logHelp()
-					break
+					process.exit(1)
 				}
-				shouldMinify = !shouldSkipMinify
-			}
-			const shouldMangleNames = options.get("mangle-names")
-			if (null != shouldMangleNames && "boolean" != typeof shouldMangleNames) {
-				logError(
-					`The value for ${colourN("--mangle-names")} must be ${colourV("true")} or ${colourV("false")}\n`
-				)
-				logHelp()
-				break
-			}
-			const shouldforceQuineCheats = options.get("force-quine-cheats")
-			if (null != shouldforceQuineCheats && "boolean" != typeof shouldforceQuineCheats) {
-				logError(
-					`The value for ${colourN("--force-quine-cheats")} must be ${colourV("true")} or ${colourV("false")}\n`
-				)
-				logHelp()
-				break
-			}
-			const { push } = await pushModule
-			;(
-				await push(sourcePath, hackmudPath, {
-					scripts,
-					onPush: info => logInfo(info, hackmudPath),
-					minify: shouldMinify,
-					mangleNames: shouldMangleNames,
-					forceQuineCheats: shouldforceQuineCheats
-				})
-			).length || logError("Could not find any scripts to push")
-		}
-		break
-	case "dev":
-	case "watch":
-		{
-			const hackmudPath = getHackmudPath(),
-				sourcePath = commands[1]
-			if (!sourcePath) {
-				logError("Must provide the directory to watch\n")
-				logHelp()
-				break
-			}
-			const scripts = commands.slice(2)
-			if (scripts.length) {
-				const invalidScript = scripts.find(
-					script => !/^(?:[a-z_][a-z\d_]{0,24}|\*)\.(?:[a-z_][a-z\d_]{0,24}|\*)$/.test(script)
-				)
-				if (invalidScript) {
-					logError(`Invalid script name: ${JSON.stringify(invalidScript)}\n`)
+				complainAboutUnrecognisedOptions()
+				const { processScript } = await processScriptModule,
+					fileBaseName = basename(target, fileExtension),
+					fileBaseNameEndsWithDotSrc = fileBaseName.endsWith(".src"),
+					scriptName = fileBaseNameEndsWithDotSrc ? fileBaseName.slice(0, -4) : fileBaseName,
+					scriptUser =
+						(
+							"scripts" == basename(resolve(target, "..")) &&
+							"hackmud" == basename(resolve(target, "../../.."))
+						) ?
+							basename(resolve(target, "../.."))
+						:	void 0
+				let outputPath =
+					commands[2] ||
+					resolve(
+						dirname(target),
+						fileBaseNameEndsWithDotSrc ? scriptName + ".js"
+						: ".js" == fileExtension ? fileBaseName + ".min.js"
+						: fileBaseName + ".js"
+					)
+				const golfFile = () =>
+					readFile(target, { encoding: "utf8" }).then(async source => {
+						const timeStart = performance.now(),
+							{ script, warnings } = await processScript(source, {
+								minify: noMinifyOption && !noMinifyOption.value,
+								scriptUser,
+								scriptName,
+								filePath: target,
+								mangleNames: mangleNamesOption?.value,
+								forceQuineCheats: forceQuineCheatsOption?.value
+							}),
+							timeTook = performance.now() - timeStart
+						for (const { message, line } of warnings)
+							log(`Warning "${chalk.bold(message)}" on line ${chalk.bold(line + "")}`)
+						await writeFilePersistent(outputPath, script)
+							.catch(error => {
+								if (!commands[2] || "EISDIR" != error.code) throw error
+								outputPath = resolve(outputPath, basename(target, fileExtension) + ".js")
+								return writeFilePersistent(outputPath, script)
+							})
+							.then(() =>
+								log(
+									`Wrote ${chalk.bold(countHackmudCharacters(script))} chars to ${chalk.bold(relative(".", outputPath))} | took ${Math.round(100 * timeTook) / 100}ms`
+								)
+							)
+					})
+				if (watchOption) {
+					const { watch: watchFile } = await chokidarModule
+					watchFile(target, { awaitWriteFinish: { stabilityThreshold: 100 } })
+						.on("ready", () => log("Watching " + target))
+						.on("change", golfFile)
+					autoExit = !1
+				} else await golfFile()
+			} else {
+				const hackmudPath = getHackmudPath(),
+					sourcePath = commands[1]
+				if (!sourcePath) {
+					logError(`Must provide the directory to ${"push" == commands[0] ? "push from" : "watch"}\n`)
 					logHelp()
-					break
+					process.exit(1)
 				}
-			} else scripts.push("*.*")
-			const optionsHasNoMinify = options.has("no-minify")
-			if ((optionsHasNoMinify || options.has("skip-minify")) && options.has("mangle-names")) {
-				logError(
-					`Options ${colourN("--mangle-names")} and ${colourN(optionsHasNoMinify ? "--no-minify" : "--skip-minify")} are incompatible\n`
-				)
-				logHelp()
-				break
-			}
-			const shouldSkipMinify = options.get("no-minify") || options.get("skip-minify")
-			let shouldMinify
-			if (null != shouldSkipMinify) {
-				if ("boolean" != typeof shouldSkipMinify) {
-					logError(
-						`The value for ${colourN(optionsHasNoMinify ? "--no-minify" : "--skip-minify")} must be ${colourV("true")} or ${colourV("false")}\n`
+				const scripts = commands.slice(2)
+				if (scripts.length) {
+					const invalidScript = scripts.find(
+						script => !/^(?:[a-z_][a-z\d_]{0,24}|\*)\.(?:[a-z_][a-z\d_]{0,24}|\*)$/.test(script)
 					)
-					logHelp()
-					break
+					if (invalidScript) {
+						logError(`Invalid script name: ${JSON.stringify(invalidScript)}\n`)
+						logHelp()
+						process.exit(1)
+					}
+				} else scripts.push("*.*")
+				if ("push" == commands[0]) {
+					const { push, MissingSourceFolderError, MissingHackmudFolderError, NoUsersError } = await pushModule
+					complainAboutUnrecognisedOptions()
+					const infos = await push(sourcePath, hackmudPath, {
+						scripts,
+						onPush: info => logInfo(info, hackmudPath),
+						minify: noMinifyOption && !noMinifyOption.value,
+						mangleNames: mangleNamesOption?.value,
+						forceQuineCheats: forceQuineCheatsOption?.value
+					})
+					if (infos instanceof Error) {
+						logError(infos.message)
+						if (infos instanceof MissingSourceFolderError || infos instanceof NoUsersError) {
+							console.log()
+							logHelp()
+						} else
+							infos instanceof MissingHackmudFolderError &&
+								log(
+									`If this is not where your hackmud folder is, you can specify it with the\n${colourN("--hackmud-path")}=${colourB("<path>")} option or ${colourN("HSM_HACKMUD_PATH")} environment variable`
+								)
+					} else infos.length || logError("Could not find any scripts to push")
+				} else {
+					const typeDeclarationPathOption = popOption(
+						"type-declaration-path",
+						"type-declaration",
+						"dts",
+						"gen-types"
+					)
+					complainAboutUnrecognisedOptions()
+					const { watch } = await watchModule
+					watch(sourcePath, hackmudPath, {
+						scripts,
+						onPush: info => logInfo(info, hackmudPath),
+						typeDeclarationPath: typeDeclarationPathOption?.value.toString(),
+						minify: noMinifyOption && !noMinifyOption.value,
+						mangleNames: mangleNamesOption?.value,
+						onReady: () => log("Watching"),
+						forceQuineCheats: forceQuineCheatsOption?.value
+					})
+					autoExit = !1
 				}
-				shouldMinify = !shouldSkipMinify
 			}
-			const shouldMangleNames = options.get("mangle-names")
-			if (null != shouldMangleNames && "boolean" != typeof shouldMangleNames) {
-				logError(
-					`The value for ${colourN("--mangle-names")} must be ${colourV("true")} or ${colourV("false")}\n`
-				)
-				logHelp()
-				break
-			}
-			const shouldforceQuineCheats = options.get("force-quine-cheats")
-			if (null != shouldforceQuineCheats && "boolean" != typeof shouldforceQuineCheats) {
-				logError(
-					`The value for ${colourN("--force-quine-cheats")} must be ${colourV("true")} or ${colourV("false")}\n`
-				)
-				logHelp()
-				break
-			}
-			const { watch } = await watchModule
-			watch(sourcePath, hackmudPath, {
-				scripts,
-				onPush: info => logInfo(info, hackmudPath),
-				typeDeclarationPath: (
-					options.get("type-declaration-path") ||
-					options.get("type-declaration") ||
-					options.get("dts") ||
-					options.get("gen-types")
-				)?.toString(),
-				minify: shouldMinify,
-				mangleNames: shouldMangleNames,
-				onReady: () => log("Watching"),
-				forceQuineCheats: shouldforceQuineCheats
-			})
-			autoExit = !1
 		}
 		break
 	case "pull":
@@ -213,8 +230,9 @@ switch (commands[0]) {
 			if (!script) {
 				logError("Must provide the script to pull\n")
 				logHelp()
-				break
+				process.exit(1)
 			}
+			complainAboutUnrecognisedOptions()
 			const sourcePath = commands[2] || "."
 			await pull(sourcePath, hackmudPath, script).catch(error => {
 				console.error(error)
@@ -224,8 +242,9 @@ switch (commands[0]) {
 		break
 	case "sync-macros":
 		{
-			const hackmudPath = getHackmudPath(),
-				{ macrosSynced, usersSynced } = await syncMacros(hackmudPath)
+			const hackmudPath = getHackmudPath()
+			complainAboutUnrecognisedOptions()
+			const { macrosSynced, usersSynced } = await syncMacros(hackmudPath)
 			log(`Synced ${macrosSynced} macros to ${usersSynced} users`)
 		}
 		break
@@ -234,18 +253,20 @@ switch (commands[0]) {
 	case "gen-dts":
 	case "gen-types":
 		{
-			const target = commands[1]
+			const hackmudPath = getHackmudPath(),
+				target = commands[1]
 			if (!target) {
 				logError("Must provide target directory\n")
 				logHelp()
-				break
+				process.exit(1)
 			}
+			complainAboutUnrecognisedOptions()
 			const sourcePath = resolve(target),
 				outputPath = commands[2] || "./player.d.ts",
-				typeDeclaration = await generateTypeDeclaration(sourcePath, getHackmudPath())
+				typeDeclaration = await generateTypeDeclaration(sourcePath, hackmudPath)
 			let typeDeclarationPath = resolve(outputPath)
 			await writeFile(typeDeclarationPath, typeDeclaration).catch(error => {
-				assert(error instanceof Error, "src/bin/hsm.ts:327:35")
+				assert(error instanceof Error, "src/bin/hsm.ts:343:35")
 				if ("EISDIR" != error.code) throw error
 				typeDeclarationPath = resolve(typeDeclarationPath, "player.d.ts")
 				return writeFile(typeDeclarationPath, typeDeclaration)
@@ -257,99 +278,6 @@ switch (commands[0]) {
 	case "h":
 		logHelp()
 		break
-	case "golf":
-	case "minify":
-		{
-			const target = commands[1]
-			if (!target) {
-				logError("Must provide target\n")
-				logHelp()
-				break
-			}
-			const fileExtension = extname(target)
-			if (!supportedExtensions.includes(fileExtension)) {
-				logError(
-					`Unsupported file extension "${chalk.bold(fileExtension)}"\nSupported extensions are "${supportedExtensions.map(extension => chalk.bold(extension)).join('", "')}"`
-				)
-				break
-			}
-			const { processScript } = await processScriptModule,
-				fileBaseName = basename(target, fileExtension),
-				fileBaseNameEndsWithDotSrc = fileBaseName.endsWith(".src"),
-				scriptName = fileBaseNameEndsWithDotSrc ? fileBaseName.slice(0, -4) : fileBaseName,
-				scriptUser =
-					"scripts" == basename(resolve(target, "..")) && "hackmud" == basename(resolve(target, "../../..")) ?
-						basename(resolve(target, "../.."))
-					:	void 0,
-				optionsHasNoMinify = options.has("no-minify")
-			if ((optionsHasNoMinify || options.has("skip-minify")) && options.has("mangle-names")) {
-				logError(
-					`Options ${colourN("--mangle-names")} and ${colourN(optionsHasNoMinify ? "--no-minify" : "--skip-minify")} are incompatible\n`
-				)
-				logHelp()
-				break
-			}
-			const mangleNames_ = options.get("mangle-names")
-			if (null != mangleNames_ && "boolean" != typeof mangleNames_) {
-				logError(
-					`The value for ${colourN("--mangle-names")} must be ${colourV("true")} or ${colourV("false")}\n`
-				)
-				logHelp()
-				break
-			}
-			const mangleNames = mangleNames_,
-				forceQuineCheats_ = options.get("force-quine-cheats")
-			if (null != forceQuineCheats_ && "boolean" != typeof forceQuineCheats_) {
-				logError(
-					`the value for ${colourN("--force-quine-cheats")} must be ${colourV("true")} or ${colourV("false")}\n`
-				)
-				logHelp()
-				break
-			}
-			const forceQuineCheats = forceQuineCheats_
-			let outputPath =
-				commands[2] ||
-				resolve(
-					dirname(target),
-					fileBaseNameEndsWithDotSrc ? scriptName + ".js"
-					: ".js" == fileExtension ? fileBaseName + ".min.js"
-					: fileBaseName + ".js"
-				)
-			const golfFile = () =>
-				readFile(target, { encoding: "utf8" }).then(async source => {
-					const timeStart = performance.now(),
-						{ script, warnings } = await processScript(source, {
-							minify: !(options.get("no-minify") || options.get("skip-minify")),
-							scriptUser,
-							scriptName,
-							filePath: target,
-							mangleNames,
-							forceQuineCheats
-						}),
-						timeTook = performance.now() - timeStart
-					for (const { message, line } of warnings)
-						log(`Warning "${chalk.bold(message)}" on line ${chalk.bold(line + "")}`)
-					await writeFilePersistent(outputPath, script)
-						.catch(error => {
-							if (!commands[2] || "EISDIR" != error.code) throw error
-							outputPath = resolve(outputPath, basename(target, fileExtension) + ".js")
-							return writeFilePersistent(outputPath, script)
-						})
-						.then(() =>
-							log(
-								`Wrote ${chalk.bold(countHackmudCharacters(script))} chars to ${chalk.bold(relative(".", outputPath))} | took ${Math.round(100 * timeTook) / 100}ms`
-							)
-						)
-				})
-			if (options.get("watch")) {
-				const { watch: watchFile } = await chokidarModule
-				watchFile(target, { awaitWriteFinish: { stabilityThreshold: 100 } })
-					.on("ready", () => log("Watching " + target))
-					.on("change", golfFile)
-				autoExit = !1
-			} else await golfFile()
-		}
-		break
 	default:
 		commands[0] && logError(`Unknown command: ${colourL(commands[0])}\n`)
 		logHelp()
@@ -423,7 +351,7 @@ function logError(message) {
 	process.exitCode = 1
 }
 function getHackmudPath() {
-	const hackmudPathOption = options.get("hackmud-path")
+	const hackmudPathOption = popOption("hackmud-path")
 	if (null != hackmudPathOption && "string" != typeof hackmudPathOption) {
 		logError(`Option ${colourN("--hackmud-path")} must be a string, got ${colourV(hackmudPathOption)}\n`)
 		logHelp()
@@ -435,3 +363,32 @@ function getHackmudPath() {
 		("win32" == process.platform ? resolve(process.env.APPDATA, "hackmud") : resolve(homedir(), ".config/hackmud"))
 	)
 }
+function assertOptionIsBoolean(option) {
+	if ("boolean" != typeof option.value) {
+		logError(`The value for ${formatOption(option.name)} must be ${colourV("true")} or ${colourV("false")}\n`)
+		logHelp()
+		process.exit(1)
+	}
+}
+function popOption(...names) {
+	const presentOptionNames = names.filter(name => options.has(name))
+	if (!presentOptionNames.length) return
+	const presentOptionNamesWithDashDash = presentOptionNames.map(formatOption)
+	if (presentOptionNames.length > 1) {
+		logError(
+			`The options ${presentOptionNamesWithDashDash.join(", ")} are aliases for each other. Please only specify one`
+		)
+		process.exit(1)
+	}
+	const value = options.get(presentOptionNames[0])
+	options.delete(presentOptionNames[0])
+	return { name: presentOptionNamesWithDashDash[0], value }
+}
+function complainAboutUnrecognisedOptions() {
+	if (options.size) {
+		logError(
+			`Unrecognised option${options.size > 1 ? "s" : ""}: ${[...options.keys()].map(formatOption).join(", ")}`
+		)
+		process.exit(1)
+	}
+}