hackmud-script-manager 0.20.4-550e28d → 0.20.4-6815ce0

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

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { Cache } from "@samual/lib/Cache"
+import { AutoMap } from "@samual/lib/AutoMap"
 import { assert } from "@samual/lib/assert"
 import { countHackmudCharacters } from "@samual/lib/countHackmudCharacters"
 import { writeFilePersistent } from "@samual/lib/writeFilePersistent"
@@ -13,10 +13,10 @@ import { syncMacros } from "../syncMacros.js"
 import "@samual/lib/readDirectoryWithStats"
 import "path/posix"
 import "@samual/lib/copyFilePersistent"
-const version = "0.20.4-550e28d",
+const formatOption = name => colourN(`-${1 == name.length ? "" : "-"}${name}`),
 	options = new Map(),
 	commands = [],
-	userColours = new Cache(user => {
+	userColours = new AutoMap(user => {
 		let hash = 0
 		for (const char of user) hash += (hash >> 1) + hash + "xi1_8ratvsw9hlbgm02y5zpdcn7uekof463qj".indexOf(char) + 1
 		return [colourJ, colourK, colourM, colourW, colourL, colourB][hash % 6](user)
@@ -58,11 +58,11 @@ const pushModule = import("../push.js"),
 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"
+			`Warning: Support for Node.js 21 will be dropped in the next minor version of HSM\n         Your current version of Node.js is ${chalk.bold(process.version)}\n         You should update your version of Node.js\n         https://nodejs.org/en/download/package-manager\n`
 		)
 	)
 if ("v" == commands[0] || "version" == commands[0] || popOption("version", "v")?.value) {
-	console.log(version)
+	console.log("0.20.4-6815ce0")
 	process.exit()
 }
 if (popOption("help", "h")?.value) {
@@ -83,7 +83,7 @@ switch (commands[0]) {
 				noMinifyIncompatibleOption = mangleNamesOption || forceQuineCheatsOption
 			if (noMinifyOption && noMinifyIncompatibleOption) {
 				logError(
-					`Options ${colourN(noMinifyOption.name)} and ${colourN(noMinifyIncompatibleOption.name)} are incompatible\n`
+					`Options ${formatOption(noMinifyOption.name)} and ${formatOption(noMinifyIncompatibleOption.name)} are incompatible\n`
 				)
 				logHelp()
 				process.exit(1)
@@ -106,6 +106,7 @@ switch (commands[0]) {
 					)
 					process.exit(1)
 				}
+				complainAboutUnrecognisedOptions()
 				const { processScript } = await processScriptModule,
 					fileBaseName = basename(target, fileExtension),
 					fileBaseNameEndsWithDotSrc = fileBaseName.endsWith(".src"),
@@ -178,15 +179,15 @@ switch (commands[0]) {
 					}
 				} else scripts.push("*.*")
 				if ("push" == commands[0]) {
-					const { push, MissingSourceFolderError, MissingHackmudFolderError, NoUsersError } =
-							await pushModule,
-						infos = await push(sourcePath, hackmudPath, {
-							scripts,
-							onPush: info => logInfo(info, hackmudPath),
-							minify: noMinifyOption && !noMinifyOption.value,
-							mangleNames: mangleNamesOption?.value,
-							forceQuineCheats: forceQuineCheatsOption?.value
-						})
+					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) {
@@ -200,12 +201,13 @@ switch (commands[0]) {
 					} else infos.length || logError("Could not find any scripts to push")
 				} else {
 					const typeDeclarationPathOption = popOption(
-							"type-declaration-path",
-							"type-declaration",
-							"dts",
-							"gen-types"
-						),
-						{ watch } = await watchModule
+						"type-declaration-path",
+						"type-declaration",
+						"dts",
+						"gen-types"
+					)
+					complainAboutUnrecognisedOptions()
+					const { watch } = await watchModule
 					watch(sourcePath, hackmudPath, {
 						scripts,
 						onPush: info => logInfo(info, hackmudPath),
@@ -229,6 +231,7 @@ switch (commands[0]) {
 				logHelp()
 				process.exit(1)
 			}
+			complainAboutUnrecognisedOptions()
 			const sourcePath = commands[2] || "."
 			await pull(sourcePath, hackmudPath, script).catch(error => {
 				console.error(error)
@@ -238,8 +241,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
@@ -247,7 +251,15 @@ switch (commands[0]) {
 	case "gen-type-declaration":
 	case "gen-dts":
 	case "gen-types":
+	case "emit-dts":
 		{
+			"emit-dts" != commands[0] &&
+				"gen-dts" != commands[0] &&
+				console.warn(
+					colourF(
+						`Warning: ${colourC("hsm")} ${colourL(commands[0])} is being deprecated and will be removed\n         in the next minor release of HSM\n         You should switch to using its alias ${colourC("hsm")} ${colourL("emit-dts")}\n`
+					)
+				)
 			const hackmudPath = getHackmudPath(),
 				target = commands[1]
 			if (!target) {
@@ -255,12 +267,13 @@ switch (commands[0]) {
 				logHelp()
 				process.exit(1)
 			}
+			complainAboutUnrecognisedOptions()
 			const sourcePath = resolve(target),
 				outputPath = commands[2] || "./player.d.ts",
 				typeDeclaration = await generateTypeDeclaration(sourcePath, hackmudPath)
 			let typeDeclarationPath = resolve(outputPath)
 			await writeFile(typeDeclarationPath, typeDeclaration).catch(error => {
-				assert(error instanceof Error, "src/bin/hsm.ts:330:35")
+				assert(error instanceof Error, "src/bin/hsm.ts:353:35")
 				if ("EISDIR" != error.code) throw error
 				typeDeclarationPath = resolve(typeDeclarationPath, "player.d.ts")
 				return writeFile(typeDeclarationPath, typeDeclaration)
@@ -281,21 +294,20 @@ function logHelp() {
 	const pushCommandDescription = "Push scripts from a directory to hackmud user's scripts directories",
 		forceQuineCheatsOptionDescription = `Force quine cheats on. Use ${colourN("--force-quine-cheats")}=${colourV("false")} to force off`,
 		hackmudPathOption = `${colourN("--hackmud-path")}=${colourB("<path>")}\n    Override hackmud path`
-	console.log(colourN("Version") + colourS(": ") + colourV(version))
 	switch (commands[0]) {
 		case "dev":
 		case "watch":
 		case "push":
 			console.log(
 				colourS(
-					`\n${colourJ("push" == commands[0] ? pushCommandDescription : "Watch a directory and push a script when modified")}\n\n${colourA("Usage:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourB('<directory> ["<script user>.<script name>"...]')}\n\n${colourA("Arguments:")}\n${colourB("<directory>")}\n    The source directory containing your scripts\n${colourB("<script user>")}\n    A user to push script(s) to. Can be set to wild card (${colourV("*")}) which will try\n    and discover users to push to\n${colourB("<script name>")}\n    Name of a script to push. Can be set to wild card (${colourV("*")}) to find all scripts\n\n${colourA("Options:")}\n${colourN("--no-minify")}\n    Skip minification to produce a "readable" script\n${colourN("--mangle-names")}\n    Reduce character count further but lose function names in error call stacks\n${colourN("--force-quine-cheats")}\n    ${forceQuineCheatsOptionDescription}\n${hackmudPathOption}\n${"push" == commands[0] ? "" : `${colourN("--type-declaration-path")}=${colourB("<path>")}\n    Path to generate a type declaration file for the scripts\n`}\n${colourA("Examples:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")}\n    Pushes all scripts found in ${colourV("src")} folder to all users\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("foo")}${colourV(".")}${colourL("bar")}\n    Pushes a script named ${colourL("bar")} found in ${colourV("src")} folder to user ${userColours.get("foo")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("foo")}${colourV(".")}${colourL("bar")} ${colourC("baz")}${colourV(".")}${colourL("qux")}\n    Multiple can be specified\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("foo")}${colourV(".")}${colourL("*")}\n    Pushes all scripts found in ${colourV("src")} folder to user ${userColours.get("foo")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("*")}${colourV(".")}${colourL("foo")}\n    Pushes all scripts named ${colourL("foo")} found in ${colourV("src")} folder to all user\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("*")}${colourV(".")}${colourL("*")}\n    Pushes all scripts found in ${colourV("src")} folder to all users`
+					`${colourJ("push" == commands[0] ? pushCommandDescription : "Watch a directory and push a script when modified")}\n\n${colourA("Usage:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourB('<directory> ["<script user>.<script name>"...]')}\n\n${colourA("Arguments:")}\n${colourB("<directory>")}\n    The source directory containing your scripts\n${colourB("<script user>")}\n    A user to push script(s) to. Can be set to wild card (${colourV("*")}) which will try\n    and discover users to push to\n${colourB("<script name>")}\n    Name of a script to push. Can be set to wild card (${colourV("*")}) to find all scripts\n\n${colourA("Options:")}\n${colourN("--no-minify")}\n    Skip minification to produce a "readable" script\n${colourN("--mangle-names")}\n    Reduce character count further but lose function names in error call stacks\n${colourN("--force-quine-cheats")}\n    ${forceQuineCheatsOptionDescription}\n${hackmudPathOption}\n${"push" == commands[0] ? "" : `${colourN("--type-declaration-path")}=${colourB("<path>")}\n    Path to generate a type declaration file for the scripts\n`}\n${colourA("Examples:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")}\n    Pushes all scripts found in ${colourV("src")} folder to all users\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("foo")}${colourV(".")}${colourL("bar")}\n    Pushes a script named ${colourL("bar")} found in ${colourV("src")} folder to user ${userColours.get("foo")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("foo")}${colourV(".")}${colourL("bar")} ${colourC("baz")}${colourV(".")}${colourL("qux")}\n    Multiple can be specified\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("foo")}${colourV(".")}${colourL("*")}\n    Pushes all scripts found in ${colourV("src")} folder to user ${userColours.get("foo")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("*")}${colourV(".")}${colourL("foo")}\n    Pushes all scripts named ${colourL("foo")} found in ${colourV("src")} folder to all user\n${colourC("hsm")} ${colourL(commands[0])} ${colourV("src")} ${colourC("*")}${colourV(".")}${colourL("*")}\n    Pushes all scripts found in ${colourV("src")} folder to all users`
 				)
 			)
 			break
 		case "pull":
 			console.log(
 				colourS(
-					`\n${colourJ("Pull a script a from a hackmud user's script directory")}\n\n${colourA("Usage:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourB("<script user>")}${colourV(".")}${colourB("<script name>")}\n\n${colourA("Options:")}\n${hackmudPathOption}`
+					`${colourJ("Pull a script a from a hackmud user's script directory")}\n\n${colourA("Usage:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourB("<script user>")}${colourV(".")}${colourB("<script name>")}\n\n${colourA("Options:")}\n${hackmudPathOption}`
 				)
 			)
 			break
@@ -303,7 +315,7 @@ function logHelp() {
 		case "golf":
 			console.log(
 				colourS(
-					`\n${colourJ("Minify a script file on the spot")}\n\n${colourA("Usage:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourB("<target> [output path]")}\n\n${colourA("Options:")}\n${colourN("--no-minify")}\n    Skip minification to produce a "readable" script\n${colourN("--mangle-names")}\n    Reduce character count further but lose function names in error call stacks\n${colourN("--force-quine-cheats")}\n    ${forceQuineCheatsOptionDescription}\n${colourN("--watch")}\n    Watch for changes`
+					`${colourJ("Minify a script file on the spot")}\n\n${colourA("Usage:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourB("<target> [output path]")}\n\n${colourA("Options:")}\n${colourN("--no-minify")}\n    Skip minification to produce a "readable" script\n${colourN("--mangle-names")}\n    Reduce character count further but lose function names in error call stacks\n${colourN("--force-quine-cheats")}\n    ${forceQuineCheatsOptionDescription}\n${colourN("--watch")}\n    Watch for changes`
 				)
 			)
 			break
@@ -311,6 +323,14 @@ function logHelp() {
 		case "gen-type-declaration":
 		case "gen-dts":
 		case "gen-types":
+		case "emit-dts":
+			"emit-dts" != commands[0] &&
+				"gen-dts" != commands[0] &&
+				console.warn(
+					colourF(
+						`Warning: ${colourC("hsm")} ${colourL(commands[0])} is being deprecated and will be removed\n         in the next minor release of HSM\n         You should switch to using its alias ${colourC("hsm")} ${colourL("emit-dts")}\n`
+					)
+				)
 			console.log(
 				colourS(
 					`${colourJ("Generate a type declaration file for a directory of scripts")}\n\n${colourA("Usage:")}\n${colourC("hsm")} ${colourL(commands[0])} ${colourB("<directory> [output path]")}\n\n${colourA("Options:")}\n${hackmudPathOption}`
@@ -320,14 +340,14 @@ function logHelp() {
 		case "sync-macros":
 			console.log(
 				colourS(
-					`\n${colourJ("Sync macros across all hackmud users")}\n\n${colourA("Options:")}\n${hackmudPathOption}`
+					`${colourJ("Sync macros across all hackmud users")}\n\n${colourA("Options:")}\n${hackmudPathOption}`
 				)
 			)
 			break
 		default:
 			console.log(
 				colourS(
-					`\n${colourJ("Hackmud Script Manager")}\n\n${colourA("Commands:")}\n${colourL("push")}\n    ${pushCommandDescription}\n${colourL("dev")}\n    Watch a directory and push a script when modified\n${colourL("golf")}\n    Minify a script file on the spot\n${colourL("gen-dts")}\n    Generate a type declaration file for a directory of scripts\n${colourL("sync-macros")}\n    Sync macros across all hackmud users\n${colourL("pull")}\n    Pull a script a from a hackmud user's script directory`
+					`${colourJ("Hackmud Script Manager")}\n${colourN("Version") + colourS(": ") + colourV("0.20.4-6815ce0")}\n\n${colourA("Commands:")}\n${colourL("push")}\n    ${pushCommandDescription}\n${colourL("dev")}\n    Watch a directory and push a script when modified\n${colourL("minify")}\n    Minify a script file on the spot\n${colourL("emit-dts")}\n    Generate a type declaration file for a directory of scripts\n${colourL("sync-macros")}\n    Sync macros across all hackmud users\n${colourL("pull")}\n    Pull a script a from a hackmud user's script directory`
 				)
 			)
 	}
@@ -345,7 +365,7 @@ function logError(message) {
 	process.exitCode = 1
 }
 function getHackmudPath() {
-	const hackmudPathOption = popOption("hackmud-path")
+	const hackmudPathOption = popOption("hackmud-path")?.value
 	if (null != hackmudPathOption && "string" != typeof hackmudPathOption) {
 		logError(`Option ${colourN("--hackmud-path")} must be a string, got ${colourV(hackmudPathOption)}\n`)
 		logHelp()
@@ -359,7 +379,7 @@ function getHackmudPath() {
 }
 function assertOptionIsBoolean(option) {
 	if ("boolean" != typeof option.value) {
-		logError(`The value for ${colourN(option.name)} must be ${colourV("true")} or ${colourV("false")}\n`)
+		logError(`The value for ${formatOption(option.name)} must be ${colourV("true")} or ${colourV("false")}\n`)
 		logHelp()
 		process.exit(1)
 	}
@@ -367,9 +387,7 @@ function assertOptionIsBoolean(option) {
 function popOption(...names) {
 	const presentOptionNames = names.filter(name => options.has(name))
 	if (!presentOptionNames.length) return
-	const presentOptionNamesWithDashDash = presentOptionNames.map(name =>
-		colourN(`-${1 == name.length ? "" : "-"}${name}`)
-	)
+	const presentOptionNamesWithDashDash = presentOptionNames.map(formatOption)
 	if (presentOptionNames.length > 1) {
 		logError(
 			`The options ${presentOptionNamesWithDashDash.join(", ")} are aliases for each other. Please only specify one`
@@ -380,3 +398,11 @@ function popOption(...names) {
 	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)
+	}
+}