@amxts/cli 0.2.1 → 0.3.0

package/src/update-check.mjs

@@ -0,0 +1,64 @@
+// The line that says a newer amxts is out: `amxts 0.2.5 is out: npx amxts
+// upgrade`. Read from a file the last check wrote, so it costs a command
+// nothing; once a day a check runs in a process of its own, left behind, and
+// writes it again. Only in a terminal, not in CI; AMXTS_IGNORE_UPDATE_CHECK=1
+// turns it off.
+import { spawn } from 'node:child_process';
+import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { homedir } from 'node:os';
+import { dirname, join } from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+import { compareVersions } from './core.mjs';
+import { execAmxts } from './pm.mjs';
+import { isCI } from './ui.mjs';
+
+/** Where the last check is kept: `{ checked, latest }`. */
+export const UPDATE_FILE = join(homedir(), '.cache', 'amxts', 'update.json');
+const DAY = 24 * 60 * 60 * 1000;
+
+function save(file, data) {
+	try {
+		mkdirSync(dirname(file), { recursive: true });
+		writeFileSync(file, `${JSON.stringify(data)}\n`);
+	} catch {}
+}
+
+/**
+ * The line about a newer core than the project's, or null; starts the day's
+ * check when the last one is older.
+ * @param {string} version the project's core
+ * @param {string} pm its package manager, for the words
+ * @param {{ env?: Record<string, string | undefined>, tty?: boolean, now?: number, file?: string, check?: (file: string) => void }} [options]
+ */
+export function updateLine(version, pm, { env = process.env, tty = Boolean(process.stdout.isTTY), now = Date.now(), file = UPDATE_FILE, check = startCheck } = {}) {
+	if (env.AMXTS_IGNORE_UPDATE_CHECK === '1' || !tty || isCI(env)) return null;
+	let last = {};
+	try {
+		last = JSON.parse(readFileSync(file, 'utf8'));
+	} catch {}
+	if (!(now - (last.checked ?? 0) < DAY)) {
+		// Written first: a second command in the same minute does not check again.
+		save(file, { ...last, checked: now });
+		check(file);
+	}
+	return last.latest && compareVersions(last.latest, version) > 0 ? `amxts ${last.latest} is out: ${execAmxts(pm)} upgrade` : null;
+}
+
+/** Starts the check in a process of its own, which the command does not wait for. */
+function startCheck(file) {
+	try {
+		spawn(process.execPath, [fileURLToPath(import.meta.url), file], { detached: true, stdio: 'ignore', windowsHide: true }).unref();
+	} catch {}
+}
+
+// The check itself: the latest @amxts/core on the registry npm is set to.
+if (process.argv[1] === fileURLToPath(import.meta.url)) {
+	const file = process.argv[2];
+	const registry = (process.env.npm_config_registry || 'https://registry.npmjs.org/').replace(/\/?$/, '/');
+	try {
+		const response = await fetch(`${registry}@amxts/core/latest`, { signal: AbortSignal.timeout(10_000) });
+		const { version } = await response.json();
+		if (typeof version === 'string') save(file, { checked: Date.now(), latest: version });
+	} catch {}
+}

package/src/upgrade.mjs

@@ -240,6 +240,8 @@ export async function upgrade({ to, server = true, serverOnly = false, dryRun =
 			: { ok: true, line: `the module of amxts ${version} goes in once @amxts/core ${version} is installed` };
 	}
 	console.log(['', ...summary(outcome)].join('\n'));
+	// A script that upgrades and goes on hears that the build failed.
+	if (outcome.build === 'failed') process.exitCode = 1;
 	return outcome;
 }
 

package/templates/module/_oxlintrc.json

@@ -18,41 +18,20 @@
 		"**/node_modules/",
 		"**/*.tgz",
 		"**/bun.lock",
+		"**/bun.lockb",
 		"**/package-lock.json",
 		"**/pnpm-lock.yaml",
 		"**/yarn.lock",
+		"**/.yarn",
 		"**/.amxts/",
 		"**/dist/",
-		"**/node_modules",
-		"**/dist",
-		"**/bun.lockb",
-		"**/output",
 		"**/coverage",
-		"**/temp",
-		"**/.temp",
-		"**/tmp",
-		"**/.tmp",
-		"**/.history",
-		"**/.vitepress/cache",
-		"**/.nuxt",
-		"**/.next",
-		"**/.svelte-kit",
-		"**/.vercel",
-		"**/.changeset",
-		"**/.idea",
 		"**/.cache",
-		"**/.output",
-		"**/.vite-inspect",
-		"**/.yarn",
+		"**/__snapshots__",
 		"**/CHANGELOG*.md",
 		"**/LICENSE*",
-		"**/*.min.*",
-		"**/__snapshots__",
-		"**/vite.config.*.timestamp-*",
-		"**/auto-import.d.ts",
-		"**/auto-imports.d.ts",
-		"**/components.d.ts",
-		"**/.context",
+		"**/.history",
+		"**/.idea",
 		"**/.claude",
 		"**/.agents",
 		"**/.*/skills"

package/templates/module/src/index.ts

@@ -21,5 +21,5 @@ let greeting = "";
 
 /** Greets the player in chat. */
 export function greet(player: Player) {
-	print(player, `${greeting}, ${player.name}!`);
+	player.print(`${greeting}, ${player.name}!`);
 }

package/templates/project/_oxlintrc.json

@@ -18,41 +18,20 @@
 		"**/node_modules/",
 		"**/*.tgz",
 		"**/bun.lock",
+		"**/bun.lockb",
 		"**/package-lock.json",
 		"**/pnpm-lock.yaml",
 		"**/yarn.lock",
+		"**/.yarn",
 		"**/.amxts/",
 		"**/dist/",
-		"**/node_modules",
-		"**/dist",
-		"**/bun.lockb",
-		"**/output",
 		"**/coverage",
-		"**/temp",
-		"**/.temp",
-		"**/tmp",
-		"**/.tmp",
-		"**/.history",
-		"**/.vitepress/cache",
-		"**/.nuxt",
-		"**/.next",
-		"**/.svelte-kit",
-		"**/.vercel",
-		"**/.changeset",
-		"**/.idea",
 		"**/.cache",
-		"**/.output",
-		"**/.vite-inspect",
-		"**/.yarn",
+		"**/__snapshots__",
 		"**/CHANGELOG*.md",
 		"**/LICENSE*",
-		"**/*.min.*",
-		"**/__snapshots__",
-		"**/vite.config.*.timestamp-*",
-		"**/auto-import.d.ts",
-		"**/auto-imports.d.ts",
-		"**/components.d.ts",
-		"**/.context",
+		"**/.history",
+		"**/.idea",
 		"**/.claude",
 		"**/.agents",
 		"**/.*/skills"

package/templates/project/plugins/hello.ts

@@ -14,12 +14,17 @@ const greeting = "Welcome";
 // #endif
 
 server.addCommand("/hp", ({ player }) => sayHp(player));
-server.addEventListener("putInServer", event => print(0, `${greeting}, ${event.player.name}!`));
+server.addEventListener("putInServer", event => event.player.print(`${greeting}, ${event.player.name}!`));
 // #if menu-core
 
 // A menu made in code: its title and items can be functions of the player it is shown to.
 const hello = menus.create("HELLO", { title: ({ player }) => `Hello, ${player.name}` });
-hello.addItem({ title: "Wave", onSelect: ({ player }) => print(0, `${player.name} waves`) });
+hello.addItem({
+	title: "Wave",
+	onSelect: ({ player }) => {
+		server.print(`${player.name} waves`);
+	},
+});
 hello.addItem({
 	title: ({ player }) => `Heal (${player.health} HP)`,
 	visible: ({ player }) => player.health < 100,
@@ -34,7 +39,12 @@ server.addCommand("/menu", ({ player }) => hello.show(player));
 
 // A menu: its title and items can be functions of the player it is shown to.
 const hello = new Menu(({ player }) => `Hello, ${player.name}`);
-hello.addItem({ title: "Wave", onSelect: ({ player }) => print(0, `${player.name} waves`) });
+hello.addItem({
+	title: "Wave",
+	onSelect: ({ player }) => {
+		server.print(`${player.name} waves`);
+	},
+});
 hello.addItem({
 	title: ({ player }) => `Heal (${player.health} HP)`,
 	visible: ({ player }) => player.health < 100,
@@ -47,5 +57,5 @@ server.addCommand("/menu", ({ player }) => hello.show(player));
 // #endif
 
 function sayHp(player: Player) {
-	print(player, `${player.name}, your HP: ${player.health}`);
+	player.print(`${player.name}, your HP: ${player.health}`);
 }

package/templates/project/test/hello.test.ts

@@ -44,4 +44,15 @@ test("/menu heals a hurt player", async () => {
 	menus.press(alice, 2);
 	expect(alice.health).toBe(100);
 });
+
+test("Wave in /menu tells everyone", async () => {
+	const server = await setup();
+	const menus = menusOf(server);
+	const alice = server.join("Alice");
+	const bob = server.join("Bob");
+
+	alice.say("/menu");
+	menus.press(alice, 1);
+	expect(bob.chat).toContain("Alice waves");
+});
 // #endif