@amxts/core 0.2.3 → 0.2.4

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@amxts/core",
 	"type": "module",
-	"version": "0.2.3",
+	"version": "0.2.4",
 	"description": "Counter-Strike 1.6 plugins in TypeScript: compiled ahead of time and run inside AMX Mod X, next to Pawn plugins.",
 	"author": {
 		"name": "kukson777",
@@ -104,8 +104,8 @@
 		"assemblyscript": "0.28.20"
 	},
 	"optionalDependencies": {
-		"@amxts/wamrc-linux-x64": "^0.2.3",
-		"@amxts/wamrc-win32-x64": "^0.2.3"
+		"@amxts/wamrc-linux-x64": "^0.2.4",
+		"@amxts/wamrc-win32-x64": "^0.2.4"
 	},
 	"devDependencies": {
 		"@amxts/config-core": "^0.1.2",

package/scripts/build-wasm.ts

@@ -45,7 +45,7 @@ import { serverIncludes } from './includes';
 import { pluginCache } from './plugin-cache';
 import { includeName } from './plugin-natives';
 import { fromRegistry, prebuiltOf, prebuiltSurface } from './prebuilt';
-import { CORE_DIR, CORE_PLUGINS, loadProject, modulesInUse, pluginList, projectPlugins, sourcesFor } from './project';
+import { CORE_DIR, CORE_PLUGINS, loadProject, modulesInUse, pluginList, projectPlugins, sourcesFor, staleCopies } from './project';
 import { sharedModulesBuild } from './shared-modules';
 import { describeSystem, serverFolder, serverSystem, SYSTEM_NAME, WAMRC_PACKAGE, wamrcPath } from './system';
 import { c, live, log, progress, since } from './ui';
@@ -162,6 +162,10 @@ function ownPlugins(): Target[] {
 	return projectPlugins(project).map(source => ({ source, name: basename(source).replace(/\.ts$/, '') }));
 }
 
+for (const copy of staleCopies(project)) {
+	log.warn(`${shown(copy)} is a copy of amxts's own API from an older version, not a plugin: delete it (npx amxts upgrade does)`);
+}
+
 for (const plugin of ownPlugins()) {
 	if (project.modules.some(pkg => pkg.short === plugin.name)) {
 		fail(`${shown(plugin.source)}: a module in amxts.config.ts is called ${plugin.name} too`, 'Rename the plugin.');

package/scripts/prebuilt.ts

@@ -235,7 +235,7 @@ function mismatch(manifest: PrebuiltManifest, pkg: ModulePackage, sources: Sourc
 		}
 	}
 	const own = resolve(sources.project.pluginsDir) !== resolve(CORE_PLUGINS);
-	const shadow = own ? manifest.places.find(place => existsSync(join(sources.project.pluginsDir, place))) : undefined;
+	const shadow = own ? manifest.places.find(place => sources.ownFile(place)) : undefined;
 	if (shadow) return `${posix(relative(sources.project.dir, join(sources.project.pluginsDir, shadow)))} takes the place of a file ${named} was built from`;
 	return null;
 }

package/scripts/project.ts

@@ -53,6 +53,7 @@ import { createRequire } from 'node:module';
 import { basename, dirname, isAbsolute, join, relative, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import ts from 'typescript';
+import { serverFolder } from '../src/system.mjs';
 import { coreImports, importedName, importTable, withAutoImports } from './auto-imports';
 import { includeDirs } from './includes';
 import { existsSync, readdirSync, readFileSync, statSync } from './tracked-fs';
@@ -667,9 +668,57 @@ export function coreEntryOf(place: string): string {
 export function projectPlugins(project: Project): string[] {
 	const core = resolve(project.pluginsDir) === resolve(CORE_PLUGINS);
 	if (core && resolve(project.dir) !== resolve(CORE_DIR)) return [];
+	const stale = new Set(staleCopies(project));
 	return readdirSync(project.pluginsDir)
 		.filter(f => f.endsWith('.ts') && !f.endsWith('.d.ts') && !(core && NOT_PLUGINS.has(f)))
-		.map(f => join(project.pluginsDir, f));
+		.map(f => join(project.pluginsDir, f))
+		.filter(f => !stale.has(f));
+}
+
+/** A server's addons/amxts: the module's files, written over on every start. */
+export const SERVER_FOLDER = /[\\/]addons[\\/]amxts$/i;
+
+/** The server's addons/amxts that AMXTS_SERVER names, or '' when it names none. */
+export function serverDir(): string {
+	try {
+		const dir = serverFolder(process.env.AMXTS_SERVER ?? '');
+		return dir && resolve(dir);
+	} catch {
+		return '';
+	}
+}
+
+/**
+ * Copies of the core's own API at the top of the project's plugins folder,
+ * left there by an older amxts: a file named as one of the core's as/ (or
+ * the editor's imports.d.ts) whose first line is the core's - a generator's
+ * header or that file's own first line. An author's file of the same name
+ * starts otherwise and stays a plugin. A server's addons/amxts/plugins holds
+ * these files on purpose: the module writes them there for the plugins
+ * compiled on the server.
+ */
+export function staleCopies(project: Project): string[] {
+	const dir = resolve(project.pluginsDir);
+	const parent = dirname(dir);
+	if (!existsSync(dir) || dir === resolve(CORE_PLUGINS) || SERVER_FOLDER.test(parent) || parent === serverDir()) return [];
+	coreFirstLines ??= new Map([...readdirSync(CORE_PLUGINS).filter(f => f.endsWith('.ts')).map(f => [f, firstLine(join(CORE_PLUGINS, f))] as const), ['imports.d.ts', '// GENERATED by ']]);
+	const core = coreFirstLines;
+	return readdirSync(dir)
+		.filter((f) => {
+			const header = core.get(f);
+			if (header === undefined) return false;
+			const line = firstLine(join(dir, f));
+			return line.startsWith('// GENERATED by ') || line === header;
+		})
+		.sort()
+		.map(f => join(dir, f));
+}
+
+/** The first line of each file at the top of the core's as/, read once. */
+let coreFirstLines: Map<string, string> | undefined;
+
+function firstLine(path: string): string {
+	return readFileSync(path, 'utf8').split('\n', 1)[0].trimEnd();
 }
 
 /** The modules that run on the server - each in its owner plugin: every one but a library. */
@@ -747,7 +796,12 @@ export class Sources {
 	/** A plugin that imports a module package the config does not list. */
 	readonly problems: string[] = [];
 
-	constructor(readonly root: string, readonly project: Project) {}
+	/** Copies of the core's API an older amxts left in the plugins folder: the core's files are under them. */
+	private readonly stale: Set<string>;
+
+	constructor(readonly root: string, readonly project: Project) {
+		this.stale = new Set(staleCopies(project));
+	}
 
 	/**
 	 * Whether a file is a plugin's code, which auto-imports reach: the
@@ -792,14 +846,20 @@ export class Sources {
 		return this.project.modules.find(pkg => path === pkg.module || path === pkg.natives || ofPackage(pkg, path)) ?? null;
 	}
 
+	/** The project's own file at this place under its plugins folder, or null: an old copy of the core's API is not one. */
+	ownFile(place: string): string | null {
+		const own = join(this.project.pluginsDir, place);
+		return existsSync(own) && !this.stale.has(own) ? own : null;
+	}
+
 	/** The file on disk at this place in the tree, or null. */
 	real(path: string): string | null {
 		const rel = this.rel(path);
 		if (!inside(this.root, resolve(path))) return existsSync(path) ? resolve(path) : null;
 
 		if (this.project.pluginsDir !== resolve(this.root)) {
-			const own = join(this.project.pluginsDir, rel);
-			if (existsSync(own)) return own;
+			const own = this.ownFile(rel);
+			if (own) return own;
 		}
 		const core = resolve(this.root, rel);
 		if (existsSync(core)) return core;

package/scripts/upgrade.ts

@@ -29,13 +29,13 @@ import type { Kind } from './upgrade-names';
 // functions take one object, the menu's context, and an item is one object
 // with its title (scripts/upgrade-menus.ts). What is rewritten no longer
 // matches, so a second run changes nothing.
-import { existsSync, readdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { existsSync, readdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
 import { basename, dirname, join, relative, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import ts from 'typescript';
 import { MESSAGE_NAMES } from './client-messages';
-import { CORE_ENTRIES, CORE_PLUGINS, loadProject } from './project';
-import { apiFiles, serverFolder } from './system';
+import { CORE_ENTRIES, CORE_PLUGINS, loadProject, SERVER_FOLDER, serverDir, staleCopies } from './project';
+import { apiFiles } from './system';
 import { c, log } from './ui';
 import { upgradeMenus } from './upgrade-menus';
 import { COMMON, EVENTS, FLAG_NAMES, GAME_EVENT_FIELDS, HIDDEN, HIDDEN_EVENTS, JOIN_OPTIONS, RENAMED, SERVER_EVENT_CLASSES, SERVER_EVENT_FIELDS, SERVER_EVENTS, SERVER_EVENTS_BY_HAND, SERVER_FIELD_CLASSES, SERVER_GAME_EVENTS } from './upgrade-names';
@@ -775,9 +775,6 @@ export function upgradeFlags(file: string, text: string): { text: string; change
 /** Folders that are not the project's code: what is installed, built or generated. */
 const SKIP = new Set(['node_modules', 'dist', '.amxts', '.git']);
 
-/** A server's addons/amxts: the module's files, written over on every start. */
-const SERVER_FOLDER = /[\\/]addons[\\/]amxts$/i;
-
 /** The project's TypeScript files: its plugins, its tests and fixtures, a module's sources. */
 function codeFiles(dir: string, skip: Set<string>): string[] {
 	return readdirSync(dir, { withFileTypes: true }).flatMap((entry) => {
@@ -787,16 +784,6 @@ function codeFiles(dir: string, skip: Set<string>): string[] {
 	});
 }
 
-/** The server's addons/amxts that AMXTS_SERVER names, or '' when it names none. */
-function serverDir(): string {
-	try {
-		const dir = serverFolder(process.env.AMXTS_SERVER ?? '');
-		return dir && resolve(dir);
-	} catch {
-		return '';
-	}
-}
-
 /**
  * The project's code to upgrade. The module's own files - the API a server
  * writes beside its plugins, at the core's version it runs - are not, in the
@@ -810,14 +797,20 @@ function projectFiles(dir: string, pluginsDir: string, outDir: string): string[]
 	return codeFiles(dir, new Set([outDir, serverDir()])).filter(file => !theirs.has(basename(file)) || dirname(file) === pluginsDir);
 }
 
-/** Rewrites the project in `dir`: every change, in the order of the files, and what is left to do by hand. `write: false` only lists them. */
-export function upgradeProject(dir: string, { write = true } = {}): { changes: Change[]; left: Left[] } {
+/**
+ * Rewrites the project in `dir`: every change, in the order of the files, and
+ * what is left to do by hand. Then removes the copies of the core's API an
+ * older amxts left in the plugins folder - after the rewrite, so nothing
+ * still imports them by `~/`. `write: false` only lists them.
+ */
+export function upgradeProject(dir: string, { write = true } = {}): { changes: Change[]; left: Left[]; removed: string[] } {
 	const project = loadProject(dir);
 	const ownFolder = resolve(project.pluginsDir) !== resolve(CORE_PLUGINS);
-	const renames = renamesFor(project.modules, place => ownFolder && existsSync(join(project.pluginsDir, place)));
+	const stale = staleCopies(project);
+	const renames = renamesFor(project.modules, place => ownFolder && existsSync(join(project.pluginsDir, place)) && !stale.includes(join(project.pluginsDir, place)));
 	const changes: Change[] = [];
 	const left: Left[] = [];
-	for (const file of projectFiles(project.dir, resolve(project.pluginsDir), project.outDir)) {
+	for (const file of projectFiles(project.dir, resolve(project.pluginsDir), project.outDir).filter(file => !stale.includes(file))) {
 		const text = readFileSync(file, 'utf8');
 		const name = relative(project.dir, file).replace(/\\/g, '/');
 		const http = dropHttpImports(name, text);
@@ -835,7 +828,10 @@ export function upgradeProject(dir: string, { write = true } = {}): { changes: C
 		if (write) writeFileSync(file, flags.text);
 		changes.push(...http.changes, ...imports.changes, ...handlers.changes, ...menus.changes, ...names.changes, ...events.changes, ...messages.changes, ...flags.changes);
 	}
-	return { changes, left };
+	if (write) {
+		for (const file of stale) rmSync(file);
+	}
+	return { changes, left, removed: stale.map(file => basename(file)) };
 }
 
 // Run as a task (scripts/run.ts names it in argv) or by itself.
@@ -844,14 +840,16 @@ if (import.meta.main || resolve(process.argv[1] ?? '') === fileURLToPath(import.
 	// amxts command as JSON, which prints what is left to do in its summary.
 	const args = process.argv.slice(2);
 	const report = args.includes('--report') ? args[args.indexOf('--report') + 1] : undefined;
-	const { changes, left } = upgradeProject(process.cwd(), { write: !args.includes('--dry-run') });
+	const write = !args.includes('--dry-run');
+	const { changes, left, removed } = upgradeProject(process.cwd(), { write });
+	if (removed.length) log.success(`${write ? 'removed' : 'would remove'} amxts's old API copies from plugins/: ${removed.join(', ')}`);
 	for (const change of changes) console.log(`  ${c.dim(`${change.file}:${change.line}`)}  ${change.from} ${c.dim('→')} ${change.to}`);
 	if (report) {
 		writeFileSync(report, JSON.stringify({ changes, left }));
 	} else {
 		const files = new Set(changes.map(change => change.file)).size;
 		if (changes.length) log.success(`upgraded ${changes.length} place(s) in ${files} file(s)`);
-		else if (!left.length) log.success('nothing to upgrade: the code already uses this core\'s API');
+		else if (!left.length && !removed.length) log.success('nothing to upgrade: the code already uses this core\'s API');
 		for (const each of left) log.warn(`${each.file}:${each.line}  ${each.why}`);
 	}
 }