hackmud-script-manager 0.20.4-c17726e → 0.20.4-c908d16

package/bin/hsm.js

@@ -24,16 +24,16 @@ const formatOption = name => colourN(`-${1 == name.length ? "" : "-"}${name}`),
 	log = message => console.log(colourS(message))
 for (const argument of process.argv.slice(2))
 	if ("-" == argument[0]) {
-		const [key, valueRaw] = argument.split("=")
-		let value = valueRaw
-		if (value)
-			if ("true" == value) value = !0
-			else if ("false" == value) value = !1
-			else {
-				const number = Number(value)
-				isFinite(number) && (value = number)
-			}
-		else value = !0
+		const argumentEqualsIndex = argument.indexOf("=")
+		let key, value
+		if (-1 == argumentEqualsIndex) {
+			key = argument
+			value = !0
+		} else {
+			key = argument.slice(0, argumentEqualsIndex)
+			value = argument.slice(argumentEqualsIndex + 1)
+			"true" == value ? (value = !0) : "false" == value && (value = !1)
+		}
 		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)
@@ -58,13 +58,14 @@ 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("0.20.4-c17726e")
+	console.log("0.20.4-c908d16")
 	process.exit()
 }
+let warnedDeprecatedEmitDtsAlias = !1
 if (popOption("help", "h")?.value) {
 	logHelp()
 	process.exit()
@@ -77,8 +78,15 @@ switch (commands[0]) {
 	case "golf":
 	case "minify":
 		{
-			const noMinifyOption = popOption("no-minify", "skip-minify"),
-				mangleNamesOption = popOption("mangle-names"),
+			const noMinifyOption = popOption("no-minify", "skip-minify")
+			noMinifyOption &&
+				"no-minify" != noMinifyOption.name &&
+				console.warn(
+					colourF(
+						`Warning: ${formatOption(noMinifyOption.name)} is being deprecated and will be removed in the next minor\n         release of HSM\n         You should switch to using its alias ${colourN("--no-minify")}\n`
+					)
+				)
+			const mangleNamesOption = popOption("mangle-names"),
 				forceQuineCheatsOption = popOption("force-quine-cheats"),
 				noMinifyIncompatibleOption = mangleNamesOption || forceQuineCheatsOption
 			if (noMinifyOption && noMinifyIncompatibleOption) {
@@ -178,16 +186,67 @@ switch (commands[0]) {
 						process.exit(1)
 					}
 				} else scripts.push("*.*")
-				if ("push" == commands[0]) {
-					const { push, MissingSourceFolderError, MissingHackmudFolderError, NoUsersError } = await pushModule
+				const watchOption = popOption("watch")
+				if ("push" != commands[0] || watchOption?.value) {
+					const dtsPathOption = popOption(
+						"dts-path",
+						"type-declaration-path",
+						"type-declaration",
+						"dts",
+						"gen-types"
+					)
+					dtsPathOption &&
+						"dts-path" != dtsPathOption.name &&
+						"type-declaration-path" != dtsPathOption.name &&
+						console.warn(
+							colourF(
+								`Warning: ${formatOption(dtsPathOption.name)} is being deprecated and will be removed in the\n         next minor release of HSM\n         You should switch to using its alias ${colourN("--dts-path")}\n`
+							)
+						)
 					complainAboutUnrecognisedOptions()
-					const infos = await push(sourcePath, hackmudPath, {
+					const { watch } = await watchModule
+					watch(sourcePath, hackmudPath, {
 						scripts,
 						onPush: info => logInfo(info, hackmudPath),
+						typeDeclarationPath: dtsPathOption?.value.toString(),
 						minify: noMinifyOption && !noMinifyOption.value,
 						mangleNames: mangleNamesOption?.value,
+						onReady: () => log("Watching"),
 						forceQuineCheats: forceQuineCheatsOption?.value
 					})
+					autoExit = !1
+				} else {
+					const dtsPathOption = popOption("dts-path")
+					complainAboutUnrecognisedOptions()
+					let declarationPathPromise
+					if (dtsPathOption) {
+						if ("string" != typeof dtsPathOption.value) {
+							logError(
+								`Option ${formatOption(dtsPathOption.name)} must be a string, got ${colourV(dtsPathOption.value)}\n`
+							)
+							logHelp()
+							process.exit(1)
+						}
+						let typeDeclarationPath = resolve(dtsPathOption.value)
+						const typeDeclaration = await generateTypeDeclaration(sourcePath, hackmudPath)
+						declarationPathPromise = writeFile(typeDeclarationPath, typeDeclaration)
+							.catch(error => {
+								assert(error instanceof Error, "src/bin/hsm.ts:274:38")
+								if ("EISDIR" != error.code) throw error
+								typeDeclarationPath = resolve(typeDeclarationPath, "player.d.ts")
+								return writeFile(typeDeclarationPath, typeDeclaration)
+							})
+							.then(() => typeDeclarationPath)
+					}
+					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
+						})
 					if (infos instanceof Error) {
 						logError(infos.message)
 						if (infos instanceof MissingSourceFolderError || infos instanceof NoUsersError) {
@@ -199,25 +258,8 @@ switch (commands[0]) {
 									`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
+					declarationPathPromise &&
+						log("Wrote type declaration to " + chalk.bold(await declarationPathPromise))
 				}
 			}
 		}
@@ -251,7 +293,16 @@ switch (commands[0]) {
 	case "gen-type-declaration":
 	case "gen-dts":
 	case "gen-types":
+	case "emit-dts":
 		{
+			if ("emit-dts" != commands[0] && "gen-dts" != commands[0]) {
+				warnedDeprecatedEmitDtsAlias = !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) {
@@ -265,7 +316,7 @@ switch (commands[0]) {
 				typeDeclaration = await generateTypeDeclaration(sourcePath, hackmudPath)
 			let typeDeclarationPath = resolve(outputPath)
 			await writeFile(typeDeclarationPath, typeDeclaration).catch(error => {
-				assert(error instanceof Error, "src/bin/hsm.ts:343:35")
+				assert(error instanceof Error, "src/bin/hsm.ts:408:35")
 				if ("EISDIR" != error.code) throw error
 				typeDeclarationPath = resolve(typeDeclarationPath, "player.d.ts")
 				return writeFile(typeDeclarationPath, typeDeclaration)
@@ -274,7 +325,6 @@ switch (commands[0]) {
 		}
 		break
 	case "help":
-	case "h":
 		logHelp()
 		break
 	default:
@@ -286,21 +336,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("0.20.4-c17726e"))
 	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${colourN("--dts-path")}=${colourB("<path>")}\n    Path to generate a type declaration (.d.ts) file for the scripts\n${colourN("--watch")}\n    Watch for changes\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
@@ -308,7 +357,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
@@ -316,6 +365,15 @@ function logHelp() {
 		case "gen-type-declaration":
 		case "gen-dts":
 		case "gen-types":
+		case "emit-dts":
+			warnedDeprecatedEmitDtsAlias ||
+				"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}`
@@ -325,14 +383,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-c908d16")}\n\n${colourA("Commands:")}\n${colourL("push")}\n    ${pushCommandDescription}\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\n\n${colourA("Options:")}\n${colourN("--help")}\n    Can be used on any command e.g. ${colourC("hsm")} ${colourL("push")} ${colourN("--help")} to show helpful information`
 				)
 			)
 	}
@@ -350,17 +408,29 @@ function logError(message) {
 	process.exitCode = 1
 }
 function getHackmudPath() {
-	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()
-		process.exit(1)
+	const hackmudPathOption = popOption("hackmud-path")
+	if (hackmudPathOption) {
+		if ("string" != typeof hackmudPathOption.value) {
+			logError(`Option ${colourN("--hackmud-path")} must be a string, got ${colourV(hackmudPathOption.value)}\n`)
+			logHelp()
+			process.exit(1)
+		}
+		if (!hackmudPathOption.value) {
+			logError(`Option ${colourN("--hackmud-path")} was specified but empty\n`)
+			logHelp()
+			process.exit(1)
+		}
+		return hackmudPathOption.value
 	}
-	return (
-		hackmudPathOption ||
-		process.env.HSM_HACKMUD_PATH ||
-		("win32" == process.platform ? resolve(process.env.APPDATA, "hackmud") : resolve(homedir(), ".config/hackmud"))
-	)
+	if (null != process.env.HSM_HACKMUD_PATH) {
+		if (!process.env.HSM_HACKMUD_PATH) {
+			logError(`Environment variable ${colourN("HSM_HACKMUD_PATH")} was specified but empty\n`)
+			logHelp()
+			process.exit(1)
+		}
+		return process.env.HSM_HACKMUD_PATH
+	}
+	return "win32" == process.platform ? resolve(process.env.APPDATA, "hackmud") : resolve(homedir(), ".config/hackmud")
 }
 function assertOptionIsBoolean(option) {
 	if ("boolean" != typeof option.value) {
@@ -372,16 +442,15 @@ function assertOptionIsBoolean(option) {
 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`
+			`The options ${presentOptionNames.map(formatOption).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 }
+	return { name: presentOptionNames[0], value }
 }
 function complainAboutUnrecognisedOptions() {
 	if (options.size) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hackmud-script-manager",
-  "version": "0.20.4-c17726e",
+  "version": "0.20.4-c908d16",
   "description": "Script manager for game hackmud, with minification, TypeScript support, and player script type definition generation.",
   "keywords": [
     "api",
@@ -86,6 +86,6 @@
     "hsm": "bin/hsm.js"
   },
   "engines": {
-    "node": "^18 || ^20 || >=22"
+    "node": "^18 || >=20"
   }
 }