@amxts/core 0.2.4 → 0.3.0

package/src/testing/tables.ts

@@ -17,6 +17,17 @@ function generated(file: string): string {
 	}
 }
 
+/** A hook's answer, by how its event's result getter reads it: text and a vector are only Ham Sandwich's. */
+function answerOf(result: string | undefined): HookAnswer {
+	if (!result) return 'none';
+	if (result.includes('__resultText')) return 'text';
+	if (result.includes('__resultVector')) return 'vector';
+	if (result.startsWith('cellFloat')) return 'float';
+	return result.endsWith('!= 0') ? 'bool' : 'int';
+}
+
+export type HookAnswer = 'int' | 'float' | 'bool' | 'text' | 'vector' | 'none';
+
 /** A hookchain as the fake fires it: which arguments are floats or text, and what it answers. */
 export interface HookShape {
 	/** reapi's short name: "take_damage". */
@@ -25,8 +36,8 @@ export interface HookShape {
 	floats: Set<number>;
 	/** Zero-based arguments the event reads as text. */
 	texts: Set<number>;
-	/** The ATYPE_* the chain answers with, or -1 for a chain that answers nothing. */
-	answer: number;
+	/** What the chain answers with: a number, a float, a boolean, text, a vector, or nothing. */
+	answer: HookAnswer;
 	/** The Ham_* function a Ham Sandwich hook of the event is on, when it has one. */
 	ham?: number;
 }
@@ -36,6 +47,8 @@ export interface Tables {
 	constants: Map<string, number>;
 	/** The dispatcher's native ids (`NATIVE_x`) to names. */
 	dispatched: Map<number, string>;
+	/** A native's arguments as they cross, by its name: runtime/natives.txt's marks (`s` text in, `t` text back), without the `leaf` after them. */
+	crossings: Map<string, string[]>;
 	/** A hookchain's number (hookIdOf) to its short name. */
 	hookNames: Map<number, string>;
 	/** A hookchain by its short name, or by its event name ("takeDamage"). */
@@ -90,6 +103,10 @@ export function tables(): Tables {
 		dispatched.set(Number(id), name);
 	}
 
+	const crossings = new Map<string, string[]>();
+	const natives = readFileSync(join(PLUGINS_ROOT, '../runtime/natives.txt'), 'utf-8');
+	for (const [, name, marks] of natives.matchAll(/^(\w+) \([^)]*\)\S* (\S+)(?: leaf)?$/gm)) crossings.set(name, marks.split(','));
+
 	const hookNames = new Map<number, string>();
 	const switchBody = constantsSource.slice(constantsSource.indexOf('export function hookIdOf'));
 	for (const [, name, id] of switchBody.slice(0, switchBody.indexOf('\n}\n')).matchAll(/case "(\w+)": return (-?\d+);/g)) {
@@ -104,15 +121,14 @@ export function tables(): Tables {
 		const kind = body.match(/private readonly kind: string = "(\w+)";/)?.[1];
 		if (!kind) continue;
 
-		// The answer's ATYPE_*: a cell's, or text or a vector, which only Ham Sandwich answers.
-		const result = body.match(/get result\(\)[^{]*\{[^}]*this\.__result(?:Cell\((ATYPE_\w+)\)|(Text|Vector)\(\))/);
-		const answer = !result ? '' : result[1] ?? (result[2] === 'Text' ? 'ATYPE_STRING' : 'ATYPE_VECTOR');
+		const result = body.match(/get result\(\)[^{]*\{ return ([^;]*);/)?.[1];
+		const answer = answerOf(result);
 		const ham = body.match(/private static readonly ham: i32 = (Ham_\w+);/)?.[1];
 		const shape: HookShape = {
 			kind,
 			floats: new Set([...body.matchAll(/cellFloat\(this\.__cell\((\d+)\)\)/g)].map(m => Number(m[1]))),
 			texts: new Set([...body.matchAll(/this\.__text\((\d+)\)/g)].map(m => Number(m[1]))),
-			answer: answer ? constants.get(answer) ?? -1 : -1,
+			answer,
 			...(ham ? { ham: constants.get(ham) } : {}),
 		};
 
@@ -144,6 +160,7 @@ export function tables(): Tables {
 	cached = {
 		constants,
 		dispatched,
+		crossings,
 		hookNames,
 		hooks,
 		floatFields: fieldsOf(kind => (kind & 3) === 1),

package/src/typecheck.mjs

@@ -0,0 +1,110 @@
+// `amxts typecheck`: TypeScript over the project (.amxts/tsconfig.json, which
+// `prepare` writes), and what TypeScript allows and the build does not:
+//
+// - an event or a message named by a variable. A parameter typed
+//   `K extends keyof M` (server.addEventListener, addMessageListener, ...)
+//   picks the event's type by the name written in the call, so the build
+//   needs a string literal there; a loop over `["a", "b"] as const` gives
+//   TypeScript a union, which it takes;
+// - a setting's name or default in a variable: `env(name)`. The build reads
+//   which settings a plugin needs, and of which kind, from the call
+//   (scripts/server-env.ts);
+// - `const rows = []`: TypeScript reads the element type off the later
+//   pushes, the build needs it written.
+//
+//   node src/typecheck.mjs              in the project's folder; exits 1 on any error
+import { resolve, sep } from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+import ts from 'typescript';
+
+/**
+ * What the project's own files - in `root`, outside node_modules and .amxts
+ * - write that TypeScript takes and the build does not: each the node it is
+ * about and what to write instead.
+ *
+ * @param {ts.Program} program
+ * @param {string} [root] the project's folder
+ * @returns {{ node: ts.Node, message: string }[]} the problems, in the files' order
+ */
+export function buildProblems(program, root = process.cwd()) {
+	const inside = resolve(root) + sep;
+	const checker = program.getTypeChecker();
+	const found = [];
+
+	const visit = (node) => {
+		if (ts.isCallExpression(node)) {
+			const declaration = checker.getResolvedSignature(node)?.declaration;
+			const [name, fallback] = node.arguments;
+			if (isFacadeEnv(declaration) && ((name && !ts.isStringLiteralLike(name)) || (fallback && !writtenOut(fallback)))) {
+				found.push({ node, message: 'env() takes its name and its default written out - env("MYPLUGIN_TOKEN"), env("MYPLUGIN_LIMIT", 100), env("MYPLUGIN_DEBUG", false), env("MYPLUGIN_URL", "https://...") - the build reads what a plugin needs from the call.' });
+			}
+			declaration?.parameters?.forEach((parameter, i) => {
+				const argument = node.arguments[i];
+				if (argument && !ts.isStringLiteral(argument) && namesAKey(parameter, declaration)) {
+					found.push({ node: argument, message: `'${argument.getText()}' has to be written out as a string literal - the build picks the event by the name in the call; write a call for each name.` });
+				}
+			});
+		}
+		if (ts.isVariableDeclaration(node) && !node.type && node.initializer && ts.isArrayLiteralExpression(node.initializer) && node.initializer.elements.length === 0) {
+			found.push({ node, message: `the build does not read an empty array's element type off its later use - write it: const ${node.name.getText()}: Row[] = []` });
+		}
+		ts.forEachChild(node, visit);
+	};
+
+	for (const file of program.getSourceFiles()) {
+		const path = resolve(file.fileName);
+		if (!file.isDeclarationFile && path.startsWith(inside) && !/[\\/](?:node_modules|\.amxts)[\\/]/.test(path)) visit(file);
+	}
+	return found;
+}
+
+/** Whether a call's function is the facade's env(). */
+function isFacadeEnv(declaration) {
+	return declaration?.name?.text === 'env' && /[\\/]facade\.ts$/.test(declaration.getSourceFile().fileName);
+}
+
+/** Whether a default is written out: text, a number, `-` a number, true or false. */
+function writtenOut(node) {
+	if (ts.isPrefixUnaryExpression(node) && node.operator === ts.SyntaxKind.MinusToken) return ts.isNumericLiteral(node.operand);
+	return ts.isStringLiteralLike(node) || ts.isNumericLiteral(node) || node.kind === ts.SyntaxKind.TrueKeyword || node.kind === ts.SyntaxKind.FalseKeyword;
+}
+
+/** Whether the parameter is typed with a type parameter of its function that is `extends keyof ...`. */
+function namesAKey(parameter, declaration) {
+	const type = parameter.type;
+	if (!type || !ts.isTypeReferenceNode(type) || !ts.isIdentifier(type.typeName)) return false;
+	const constraint = declaration.typeParameters?.find(each => each.name.text === type.typeName.text)?.constraint;
+	return !!constraint && ts.isTypeOperatorNode(constraint) && constraint.operator === ts.SyntaxKind.KeyOfKeyword;
+}
+
+/** `file(line,col): error amxts: ...`, as tsc writes its own. */
+function described({ node, message }) {
+	const file = node.getSourceFile();
+	const { line, character } = file.getLineAndCharacterOfPosition(node.getStart());
+	return `${file.fileName}(${line + 1},${character + 1}): error amxts: ${message}`;
+}
+
+function main() {
+	const config = ts.getParsedCommandLineOfConfigFile('.amxts/tsconfig.json', { noEmit: true }, { ...ts.sys, onUnRecoverableConfigFileDiagnostic: () => {} });
+	if (!config) {
+		process.stdout.write('error: .amxts/tsconfig.json cannot be read - run npx amxts prepare\n');
+		process.exit(1);
+	}
+
+	const program = ts.createProgram({ rootNames: config.fileNames, options: config.options });
+	const diagnostics = [...config.errors, ...ts.getPreEmitDiagnostics(program)];
+	const format = process.stdout.isTTY ? ts.formatDiagnosticsWithColorAndContext : ts.formatDiagnostics;
+	process.stdout.write(format(diagnostics, {
+		getCanonicalFileName: name => name,
+		getCurrentDirectory: ts.sys.getCurrentDirectory,
+		getNewLine: () => ts.sys.newLine,
+	}));
+
+	const problems = buildProblems(program);
+	for (const problem of problems) process.stdout.write(`${described(problem)}\n`);
+	const errors = diagnostics.filter(each => each.category === ts.DiagnosticCategory.Error).length + problems.length;
+	process.exit(errors > 0 ? 1 : 0);
+}
+
+if (process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url)) main();

package/runtime/licenses/Bun-LICENSE.md

@@ -1,84 +0,0 @@
-Bun itself is MIT-licensed.
-
-## JavaScriptCore
-
-Bun statically links JavaScriptCore (and WebKit) which is LGPL-2 licensed. WebCore files from WebKit are also licensed under LGPL2. Per LGPL2:
-
-> (1) If you statically link against an LGPL’d library, you must also provide your application in an object (not necessarily source) format, so that a user has the opportunity to modify the library and relink the application.
-
-You can find the patched version of WebKit used by Bun here: <https://github.com/oven-sh/webkit>. If you would like to relink Bun with changes:
-
-- `git clone https://github.com/oven-sh/WebKit vendor/WebKit`
-- `bun sync-webkit-source` (checks out the version pinned in `WEBKIT_VERSION` in `scripts/build/deps/webkit.ts`)
-- `bun run build:local`
-
-This compiles JavaScriptCore, compiles Bun’s `.cpp` bindings for JavaScriptCore (which are the object files using JavaScriptCore) and outputs a new `bun` binary with your changes.
-
-## Linked libraries
-
-Bun statically links these libraries:
-
-| Library | License |
-|---------|---------|
-| [`boringssl`](https://boringssl.googlesource.com/boringssl/) | [several licenses](https://boringssl.googlesource.com/boringssl/+/refs/heads/master/LICENSE) |
-| [`brotli`](https://github.com/google/brotli) | MIT |
-| [`libarchive`](https://github.com/libarchive/libarchive) | [several licenses](https://github.com/libarchive/libarchive/blob/master/COPYING) |
-| [`lol-html`](https://github.com/cloudflare/lol-html/tree/master/c-api) | BSD 3-Clause |
-| [`ls-hpack`](https://github.com/litespeedtech/ls-hpack) | MIT |
-| [`ls-qpack`](https://github.com/litespeedtech/ls-qpack) | MIT |
-| [`lsquic`](https://github.com/litespeedtech/lsquic) | MIT (portions derived from [Chromium proto-quic](https://github.com/litespeedtech/lsquic/blob/master/LICENSE.chrome), BSD 3-Clause) |
-| [`mimalloc`](https://github.com/microsoft/mimalloc) | MIT |
-| [`picohttp`](https://github.com/h2o/picohttpparser) | dual-licensed under the Perl License or the MIT License |
-| [`zstd`](https://github.com/facebook/zstd) | dual-licensed under the BSD License or GPLv2 license |
-| [`simdutf`](https://github.com/simdutf/simdutf) | Apache 2.0 |
-| [`tinycc`](https://github.com/tinycc/tinycc) | LGPL v2.1 |
-| [`uSockets`](https://github.com/uNetworking/uSockets) | Apache 2.0 |
-| [`zlib-ng`](https://github.com/zlib-ng/zlib-ng) | zlib |
-| [`c-ares`](https://github.com/c-ares/c-ares) | MIT licensed |
-| [`libicu`](https://github.com/unicode-org/icu) 78 | [license here](https://github.com/unicode-org/icu/blob/main/icu4c/LICENSE) |
-| [`libbase64`](https://github.com/aklomp/base64/blob/master/LICENSE) | BSD 2-Clause |
-| [`libuv`](https://github.com/libuv/libuv) (on Windows) | MIT |
-| [`libdeflate`](https://github.com/ebiggers/libdeflate) | MIT |
-| [`libjpeg-turbo`](https://github.com/libjpeg-turbo/libjpeg-turbo) | [BSD 3-Clause / IJG / zlib](https://github.com/libjpeg-turbo/libjpeg-turbo/blob/main/LICENSE.md) |
-| [`libspng`](https://github.com/randy408/libspng) | BSD 2-Clause |
-| [`libwebp`](https://github.com/webmproject/libwebp) | BSD 3-Clause |
-| [`highway`](https://github.com/google/highway) | Apache 2.0 |
-| [`uucode`](https://github.com/jacobsandlund/uucode) | MIT |
-| A fork of [`uWebsockets`](https://github.com/jarred-sumner/uwebsockets) | Apache 2.0 licensed |
-| Parts of [Tigerbeetle's IO code](https://github.com/tigerbeetle/tigerbeetle/blob/532c8b70b9142c17e07737ab6d3da68d7500cbca/src/io/windows.zig#L1) | Apache 2.0 licensed |
-| `__cxa_thread_atexit` fallback from [LLVM libc++abi](https://github.com/llvm/llvm-project/blob/llvmorg-19.1.0/libcxxabi/src/cxa_thread_atexit.cpp) | Apache 2.0 with LLVM exception |
-
-## Polyfills
-
-For compatibility reasons, the following packages are embedded into Bun's binary and injected if imported.
-
-| Package | License |
-|---------|---------|
-| [`acorn`](https://github.com/acornjs/acorn) | MIT |
-| [`acorn-walk`](https://github.com/acornjs/acorn) | MIT |
-| [`assert`](https://npmjs.com/package/assert) | MIT |
-| [`browserify-zlib`](https://npmjs.com/package/browserify-zlib) | MIT |
-| [`buffer`](https://npmjs.com/package/buffer) | MIT |
-| [`constants-browserify`](https://npmjs.com/package/constants-browserify) | MIT |
-| [`crypto-browserify`](https://npmjs.com/package/crypto-browserify) | MIT |
-| [`domain-browser`](https://npmjs.com/package/domain-browser) | MIT |
-| [`events`](https://npmjs.com/package/events) | MIT |
-| [`https-browserify`](https://npmjs.com/package/https-browserify) | MIT |
-| [`os-browserify`](https://npmjs.com/package/os-browserify) | MIT |
-| [`path-browserify`](https://npmjs.com/package/path-browserify) | MIT |
-| [`process`](https://npmjs.com/package/process) | MIT |
-| [`punycode`](https://npmjs.com/package/punycode) | MIT |
-| [`querystring-es3`](https://npmjs.com/package/querystring-es3) | MIT |
-| [`stream-browserify`](https://npmjs.com/package/stream-browserify) | MIT |
-| [`stream-http`](https://npmjs.com/package/stream-http) | MIT |
-| [`string_decoder`](https://npmjs.com/package/string_decoder) | MIT |
-| [`timers-browserify`](https://npmjs.com/package/timers-browserify) | MIT |
-| [`tty-browserify`](https://npmjs.com/package/tty-browserify) | MIT |
-| [`url`](https://npmjs.com/package/url) | MIT |
-| [`util`](https://npmjs.com/package/util) | MIT |
-| [`vm-browserify`](https://npmjs.com/package/vm-browserify) | MIT |
-
-## Additional credits
-
-- Bun's JS transpiler, CSS lexer, and Node.js module resolver source code is a port of [@evanw](https://github.com/evanw)’s [esbuild](https://github.com/evanw/esbuild) project.
-- Credit to [@kipply](https://github.com/kipply) for the name "Bun"!