hackmud-script-manager 0.21.1-583d190 → 0.21.1-8ea4b63

package/README.md

@@ -12,7 +12,7 @@ You can read about how HSM works [in my blog post](https://samual.uk/blog/js-cod
 ## Usage
 1. Run `#dir` in game, then `cd` to that folder
 2. Name your source script file to `<name>.src.js`
-3. Run `hsm golf <name>.src.js` and it will create a minified script file called `<name>.js`
+3. Run `hsm minify <name>.src.js` and it will create a minified script file called `<name>.js`
 
 > **NOTE:** If you get an error message that looks like this:
 > ```

package/bin/hsm.js

@@ -55,14 +55,16 @@ const pushModule = import("../push.js"),
 	colourS = chalk.rgb(122, 178, 244),
 	colourV = chalk.rgb(255, 0, 236),
 	colourW = chalk.rgb(255, 150, 224)
-process.version.startsWith("v21.") &&
+if (process.version.startsWith("v21.")) {
+	process.exitCode = 1
 	console.warn(
 		colourF(
 			`${chalk.bold("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.21.1-583d190")
+	console.log("0.21.1-8ea4b63")
 	process.exit()
 }
 let warnedDeprecatedEmitDtsAlias = !1
@@ -79,13 +81,14 @@ switch (commands[0]) {
 	case "minify":
 		{
 			const noMinifyOption = popOption("no-minify", "skip-minify")
-			noMinifyOption &&
-				"no-minify" != noMinifyOption.name &&
+			if (noMinifyOption && "no-minify" != noMinifyOption.name) {
+				process.exitCode = 1
 				console.warn(
 					colourF(
 						`${chalk.bold("Warning:")} ${formatOption(noMinifyOption.name)} is 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"),
 				noQuineCheatsOptions = popOption("no-quine-cheats"),
@@ -131,19 +134,19 @@ switch (commands[0]) {
 					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
+						"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"
+						fileBaseNameEndsWithDotSrc
+							? scriptName + ".js"
+							: ".js" == fileExtension
+								? fileBaseName + ".min.js"
+								: fileBaseName + ".js"
 					)
 				const golfFile = () =>
 					readFile(target, { encoding: "utf8" }).then(async source => {
@@ -158,6 +161,7 @@ switch (commands[0]) {
 								rootFolderPath
 							}),
 							timeTook = performance.now() - timeStart
+						warnings.length && (process.exitCode = 1)
 						for (const { message } of warnings)
 							console.warn(colourF(`${chalk.bold("Warning:")} ${message}`))
 						await writeFilePersistent(outputPath, script)
@@ -207,14 +211,18 @@ switch (commands[0]) {
 						"dts",
 						"gen-types"
 					)
-					dtsPathOption &&
+					if (
+						dtsPathOption &&
 						"dts-path" != dtsPathOption.name &&
-						"type-declaration-path" != dtsPathOption.name &&
+						"type-declaration-path" != dtsPathOption.name
+					) {
+						process.exitCode = 1
 						console.warn(
 							colourF(
 								`${chalk.bold("Warning:")} ${formatOption(dtsPathOption.name)} is 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 { watch } = await watchModule
 					watch(sourcePath, hackmudPath, {
@@ -244,7 +252,7 @@ switch (commands[0]) {
 						const typeDeclaration = await generateTypeDeclaration(sourcePath, hackmudPath)
 						declarationPathPromise = writeFile(typeDeclarationPath, typeDeclaration)
 							.catch(error => {
-								assert(error instanceof Error, "src/bin/hsm.ts:292:38")
+								assert(error instanceof Error, "src/bin/hsm.ts:299:38")
 								if ("EISDIR" != error.code) throw error
 								typeDeclarationPath = resolve(typeDeclarationPath, "player.d.ts")
 								return writeFile(typeDeclarationPath, typeDeclaration)
@@ -311,6 +319,7 @@ switch (commands[0]) {
 		{
 			if ("emit-dts" != commands[0] && "gen-dts" != commands[0]) {
 				warnedDeprecatedEmitDtsAlias = !0
+				process.exitCode = 1
 				console.warn(
 					colourF(
 						`${chalk.bold("Warning:")} ${colourC("hsm")} ${colourL(commands[0])} is 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`
@@ -330,7 +339,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:428:35")
+				assert(error instanceof Error, "src/bin/hsm.ts:438:35")
 				if ("EISDIR" != error.code) throw error
 				typeDeclarationPath = resolve(typeDeclarationPath, "player.d.ts")
 				return writeFile(typeDeclarationPath, typeDeclaration)
@@ -379,14 +388,14 @@ function logHelp() {
 		case "gen-dts":
 		case "gen-types":
 		case "emit-dts":
-			warnedDeprecatedEmitDtsAlias ||
-				"emit-dts" == commands[0] ||
-				"gen-dts" == commands[0] ||
+			if (!warnedDeprecatedEmitDtsAlias && "emit-dts" != commands[0] && "gen-dts" != commands[0]) {
+				process.exitCode = 1
 				console.warn(
 					colourF(
 						`${chalk.bold("Warning:")} ${colourC("hsm")} ${colourL(commands[0])} is 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}`
@@ -403,7 +412,7 @@ function logHelp() {
 		default:
 			console.log(
 				colourS(
-					`${colourJ("Hackmud Script Manager")}\n${colourN("Version") + colourS(": ") + colourV("0.21.1-583d190")}\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`
+					`${colourJ("Hackmud Script Manager")}\n${colourN("Version") + colourS(": ") + colourV("0.21.1-8ea4b63")}\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`
 				)
 			)
 	}
@@ -412,6 +421,7 @@ function logInfo({ path, users, characterCount, error, warnings }, hackmudPath)
 	path = relative(".", path)
 	if (error) logError(`Error "${chalk.bold(error.message)}" in ${chalk.bold(path)}`)
 	else {
+		warnings.length && (process.exitCode = 1)
 		for (const warning of warnings) console.warn(colourF(`${chalk.bold("Warning:")} ${warning.message}`))
 		log(
 			`Pushed ${chalk.bold(path)} to ${users.map(user => chalk.bold(userColours.get(user))).join(", ")} | ${chalk.bold(characterCount + "")} chars | ${chalk.bold(resolve(hackmudPath, users[0], "scripts", basename(path, extname(path))) + ".js")}`

package/env.d.ts

@@ -710,7 +710,7 @@ type MongoTypeStringsToTypes = {
 	string: string
 	object: MongoObject
 	array: MongoValue[]
-	objectId: ObjectId
+	objectId: MongoObjectId
 	bool: boolean
 	date: Date
 	null: null
@@ -720,7 +720,7 @@ type MongoTypeStringsToTypes = {
 
 type MongoTypeString = keyof MongoTypeStringsToTypes
 type MongoTypeNumber = -1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 16 | 17 | 18 | 19 | 127
-type MongoId = Exclude<MongoPrimitive, null> | MongoObject
+type MongoId = Exclude<MongoPrimitive, null> | MongoObjectId | MongoObject
 type MongoQueryId = Exclude<MongoPrimitive, null> | MongoQueryObject
 type MongoDocument = MongoObject & { _id?: MongoId }
 
@@ -865,8 +865,8 @@ type BrainContext = Replace<CliContext, { /** Whether the script is being run vi
 // when anyField: true is given, other fields (except _id) are omitted
 
 type MongoProject<TDocument, TProjection> =
-	true extends (1 extends TProjection[keyof TProjection] ? true : TProjection[keyof TProjection]) ?
-		(TProjection extends { _id: false | 0 } ? {} : { _id: TDocument extends { _id: infer TId } ? TId : MongoId }) &
+	(TProjection extends { _id: false | 0 } ? {} : { _id: TDocument extends { _id: infer TId } ? TId : MongoId }) & (
+		true extends (1 extends TProjection[keyof TProjection] ? true : TProjection[keyof TProjection]) ?
 			{
 				[K in
 					keyof TDocument as K extends keyof TProjection ? TProjection[K] extends true | 1 ? K : never : never
@@ -877,7 +877,8 @@ type MongoProject<TDocument, TProjection> =
 					keyof TProjection as TProjection[K] extends true | 1 ? K extends keyof TDocument ? never : K : never
 				]?: MongoValue
 			}
-	: { [k: string]: MongoValue } & { [K in keyof TDocument as K extends keyof TProjection ? never : K]: TDocument[K] }
+		: { [k: string]: MongoValue } & { [K in keyof TDocument as K extends keyof TProjection ? never : K]: TDocument[K] }
+	)
 
 type DeepFreeze<T> = { readonly [P in keyof T]: DeepFreeze<T[P]> }
 
@@ -885,9 +886,9 @@ declare global {
 	type ScriptSuccess<T = unknown> = { ok: true } & T
 	type ScriptFailure = { ok: false, msg?: string }
 	type ScriptResponse<T = unknown> = ScriptSuccess<T> | ScriptFailure
-	type Scriptor<TArgs extends any[] = any[]> = { name: string, call: (...args: TArgs) => unknown }
+	type Scriptor<TArgs = any> = { name: string, call: (args: TArgs) => unknown }
 	type Context = CliContext | SubscriptContext | ScriptorContext | BrainContext
-	type ObjectId = { $oid: string }
+	type MongoObjectId = { $oid: string }
 
 	interface PlayerFullsec {}
 	interface PlayerHighsec {}
@@ -978,7 +979,7 @@ declare global {
 		us: <T extends MongoDocument>(query: MongoQuery<T> | MongoQuery<T>[], command: MongoUpdateCommand<T>) =>
 			{ n: number, ok: 0 | 1, opTime: { t: number }, nModified: number }[]
 
-		ObjectId: () => ObjectId
+		ObjectId: () => MongoObjectId
 	}
 
 	/** Debug Log.

package/generateTypeDeclaration.js

@@ -13,9 +13,9 @@ async function generateTypeDeclaration(sourceDirectory, hackmudPath) {
 	await Promise.all(
 		(await readDirectoryWithStats(sourceDirectory)).map(async ({ stats, name }) => {
 			if (stats.isFile())
-				name.endsWith(".ts") ?
-					name.endsWith(".d.ts") || wildScripts.push(basename(name, ".ts"))
-				:	name.endsWith(".js") && wildAnyScripts.push(basename(name, ".js"))
+				name.endsWith(".ts")
+					? name.endsWith(".d.ts") || wildScripts.push(basename(name, ".ts"))
+					: name.endsWith(".js") && wildAnyScripts.push(basename(name, ".js"))
 			else if (stats.isDirectory()) {
 				const scripts = [],
 					anyScripts = []
@@ -24,9 +24,9 @@ async function generateTypeDeclaration(sourceDirectory, hackmudPath) {
 				users.add(name)
 				for (const child of await readDirectoryWithStats(resolve(sourceDirectory, name)))
 					child.stats.isFile() &&
-						(child.name.endsWith(".ts") ?
-							name.endsWith(".d.ts") || scripts.push(basename(child.name, ".ts"))
-						:	child.name.endsWith(".js") && anyScripts.push(basename(child.name, ".js")))
+						(child.name.endsWith(".ts")
+							? name.endsWith(".d.ts") || scripts.push(basename(child.name, ".ts"))
+							: child.name.endsWith(".js") && anyScripts.push(basename(child.name, ".js")))
 			}
 		})
 	)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hackmud-script-manager",
-  "version": "0.21.1-583d190",
+  "version": "0.21.1-8ea4b63",
   "description": "Script manager for game hackmud, with minification, TypeScript support, and player script type definition generation.",
   "keywords": [
     "api",

package/processScript/index.js

@@ -221,10 +221,10 @@ async function processScript(
 						for (const referencePath of getReferencePathsToGlobal("JSON", program))
 							"MemberExpression" == referencePath.parentPath.node.type &&
 								"Identifier" == referencePath.parentPath.node.property.type &&
-								("parse" == referencePath.parentPath.node.property.name ?
-									(referencePath.parentPath.node.property.name = "oparse")
-								:	"stringify" == referencePath.parentPath.node.property.name &&
-									(referencePath.parentPath.node.property.name = "ostringify"))
+								("parse" == referencePath.parentPath.node.property.name
+									? (referencePath.parentPath.node.property.name = "oparse")
+									: "stringify" == referencePath.parentPath.node.property.name &&
+										(referencePath.parentPath.node.property.name = "ostringify"))
 						return generate(program.node).code
 					}
 				},

package/processScript/minify.js

@@ -359,12 +359,9 @@ async function minify(file, { uniqueId = "00000000000", mangleNames = !1, forceQ
 	}
 	if (1 == forceQuineCheats) return code
 	assert(scriptBeforeJSONValueReplacement, "src/processScript/minify.ts:485:43")
-	return (
-			countHackmudCharacters(scriptBeforeJSONValueReplacement) <=
-				countHackmudCharacters(code) + Number(hasComment)
-		) ?
-			scriptBeforeJSONValueReplacement
-		:	code
+	return countHackmudCharacters(scriptBeforeJSONValueReplacement) <= countHackmudCharacters(code) + Number(hasComment)
+		? scriptBeforeJSONValueReplacement
+		: code
 }
 function parseObjectExpression(node, o) {
 	if (!node.properties.length) return !1

package/processScript/preprocess.js

@@ -4,11 +4,23 @@ import babelTraverse from "@babel/traverse"
 import t from "@babel/types"
 import { assert } from "@samual/lib/assert"
 import { spliceString } from "@samual/lib/spliceString"
+import { tokenizer, tokTypes } from "acorn"
 import { resolve } from "import-meta-resolve"
 const { default: traverse } = babelTraverse,
-	{ default: generate } = babelGenerator
+	{ default: generate } = babelGenerator,
+	SUBSCRIPT_PREFIXES = ["s", "fs", "4s", "hs", "3s", "ms", "2s", "ls", "1s", "ns", "0s"]
 async function preprocess(code, { uniqueId = "00000000000" } = {}) {
-	assert(/^\w{11}$/.test(uniqueId), "src/processScript/preprocess.ts:23:36")
+	assert(/^\w{11}$/.test(uniqueId), "src/processScript/preprocess.ts:26:36")
+	const tokensIterable = tokenizer(code, { ecmaVersion: "latest" })
+	for (const token of tokensIterable) {
+		assert("value" in token, "src/processScript/preprocess.ts:31:28")
+		if (token.type != tokTypes.privateId) continue
+		assert("string" == typeof token.value, "src/processScript/preprocess.ts:36:42")
+		if (!SUBSCRIPT_PREFIXES.includes(token.value)) continue
+		const nextToken = tokensIterable.getToken()
+		if (nextToken.type != tokTypes._in && nextToken.type != tokTypes.dot)
+			throw SyntaxError("Subscripts must be in the form of #fs.foo.bar")
+	}
 	const sourceCode = code
 	let lengthBefore, file, program
 	do {
@@ -47,7 +59,7 @@ async function preprocess(code, { uniqueId = "00000000000" } = {}) {
 			})
 			break
 		} catch (error_) {
-			assert(error_ instanceof SyntaxError, "src/processScript/preprocess.ts:67:42")
+			assert(error_ instanceof SyntaxError, "src/processScript/preprocess.ts:89:42")
 			error = error_
 		}
 		if ("BABEL_PARSER_SYNTAX_ERROR" != error.code || "PrivateInExpectedIn" != error.reasonCode) {
@@ -80,14 +92,14 @@ async function preprocess(code, { uniqueId = "00000000000" } = {}) {
 	;(needRecord || needTuple) &&
 		file.program.body.unshift(
 			t.importDeclaration(
-				needRecord ?
-					needTuple ?
-						[
-							t.importSpecifier(t.identifier("Record"), t.identifier("Record")),
-							t.importSpecifier(t.identifier("Tuple"), t.identifier("Tuple"))
-						]
-					:	[t.importSpecifier(t.identifier("Record"), t.identifier("Record"))]
-				:	[t.importSpecifier(t.identifier("Tuple"), t.identifier("Tuple"))],
+				needRecord
+					? needTuple
+						? [
+								t.importSpecifier(t.identifier("Record"), t.identifier("Record")),
+								t.importSpecifier(t.identifier("Tuple"), t.identifier("Tuple"))
+							]
+						: [t.importSpecifier(t.identifier("Record"), t.identifier("Record"))]
+					: [t.importSpecifier(t.identifier("Tuple"), t.identifier("Tuple"))],
 				t.stringLiteral("@bloomberg/record-tuple-polyfill")
 			)
 		)

package/processScript/transform.js

@@ -253,29 +253,29 @@ function transform(file, sourceCode, { uniqueId = "00000000000", scriptUser, scr
 					mainFunction = t.functionDeclaration(
 						t.identifier(topFunctionName),
 						declarator.init.params,
-						"BlockStatement" == declarator.init.body.type ?
-							declarator.init.body
-						:	t.blockStatement([t.returnStatement(declarator.init.body)])
+						"BlockStatement" == declarator.init.body.type
+							? declarator.init.body
+							: t.blockStatement([t.returnStatement(declarator.init.body)])
 					)
 		else
-			"FunctionDeclaration" == statement.type ?
-				statement.id.name == exportDefaultName ?
-					(mainFunction = statement)
-				:	globalBlock.body.push(
-						t.variableDeclaration("let", [
-							t.variableDeclarator(
-								statement.id,
-								t.functionExpression(
-									void 0,
-									statement.params,
-									statement.body,
-									statement.generator,
-									statement.async
+			"FunctionDeclaration" == statement.type
+				? statement.id.name == exportDefaultName
+					? (mainFunction = statement)
+					: globalBlock.body.push(
+							t.variableDeclaration("let", [
+								t.variableDeclarator(
+									statement.id,
+									t.functionExpression(
+										void 0,
+										statement.params,
+										statement.body,
+										statement.generator,
+										statement.async
+									)
 								)
-							)
-						])
-					)
-			:	globalBlock.body.push(statement)
+							])
+						)
+				: globalBlock.body.push(statement)
 	mainFunction ||= t.functionDeclaration(
 		t.identifier(topFunctionName),
 		[t.identifier("context"), t.identifier("args")],
@@ -515,9 +515,11 @@ function transform(file, sourceCode, { uniqueId = "00000000000", scriptUser, scr
 				"let",
 				[...neededDbMethodLets].map(name => {
 					const getArgs = () =>
-						"ObjectId" == name ? []
-						: "i" == name || "r" == name ? [t.identifier("a")]
-						: [t.identifier("a"), t.identifier("b")]
+						"ObjectId" == name
+							? []
+							: "i" == name || "r" == name
+								? [t.identifier("a")]
+								: [t.identifier("a"), t.identifier("b")]
 					return t.variableDeclarator(
 						t.identifier(`_${uniqueId}_CONSOLE_METHOD_${name}_`),
 						t.arrowFunctionExpression(
@@ -663,9 +665,9 @@ function transform(file, sourceCode, { uniqueId = "00000000000", scriptUser, scr
 			const bigIntAsNumber = Number(path.node.value)
 			path.replaceWith(
 				t.callExpression(t.identifier("BigInt"), [
-					BigInt(bigIntAsNumber) == BigInt(path.node.value) ?
-						t.numericLiteral(bigIntAsNumber)
-					:	t.stringLiteral(path.node.value)
+					BigInt(bigIntAsNumber) == BigInt(path.node.value)
+						? t.numericLiteral(bigIntAsNumber)
+						: t.stringLiteral(path.node.value)
 				])
 			)
 		}

package/watch.js

@@ -68,12 +68,13 @@ async function watch(
 	let pushEverything = !1
 	for (const fullScriptName of scripts) {
 		const [user, scriptName] = fullScriptName.split(".")
-		user && "*" != user ?
-			scriptName && "*" != scriptName ?
-				scriptNamesToUsers.get(scriptName).add(user)
-			:	wildScriptUsers.add(user)
-		: scriptName && "*" != scriptName ? wildUserScripts.add(scriptName)
-		: (pushEverything = !0)
+		user && "*" != user
+			? scriptName && "*" != scriptName
+				? scriptNamesToUsers.get(scriptName).add(user)
+				: wildScriptUsers.add(user)
+			: scriptName && "*" != scriptName
+				? wildUserScripts.add(scriptName)
+				: (pushEverything = !0)
 	}
 	const watcher = watch$1(".", {
 		cwd: sourceDirectory,
@@ -112,9 +113,9 @@ async function watch(
 				for (const { stats, name } of await readDirectoryWithStats(sourceDirectory))
 					stats.isDirectory() && usersToPushToSet.add(name)
 				for (const { stats, name } of await readDirectoryWithStats(hackmudDirectory))
-					stats.isDirectory() ?
-						usersToPushToSet.add(name)
-					:	stats.isFile() && name.endsWith(".key") && usersToPushToSet.add(name.slice(0, -4))
+					stats.isDirectory()
+						? usersToPushToSet.add(name)
+						: stats.isFile() && name.endsWith(".key") && usersToPushToSet.add(name.slice(0, -4))
 				for (const users of scriptNamesToUsers.values()) for (const user of users) usersToPushToSet.add(user)
 			}
 			for (const user of wildScriptUsers) usersToPushToSet.add(user)