@amxts/cli 0.2.0 → 0.2.1

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@amxts/cli",
 	"type": "module",
-	"version": "0.2.0",
+	"version": "0.2.1",
 	"description": "The amxts command: create a project or a module, add modules, build, deploy, type-check and test",
 	"author": {
 		"name": "kukson777",

package/src/init-module.mjs

@@ -17,7 +17,7 @@ import process from 'node:process';
 import { shortName, specFor } from './catalog.mjs';
 import { CLI_DIR, CORE_RANGE, FROM_SOURCE, needLocalCore } from './core.mjs';
 import { LINT_DEPENDENCIES, LINT_SCRIPTS } from './lint.mjs';
-import { detectPackageManager, execAmxts, installArgs, runScript } from './pm.mjs';
+import { detectPackageManager, execAmxts, installArgs, runScript, testRunner } from './pm.mjs';
 import { copyTemplate, gitAuthor, writeFile } from './template.mjs';
 import { c, CliError, log } from './ui.mjs';
 
@@ -57,9 +57,11 @@ export async function initModule(options) {
 	}
 
 	const pm = options.pm ?? detectPackageManager();
+	const runner = testRunner(pm);
+	values['test.types'] = runner.types;
 	const localCore = (options.local ?? FROM_SOURCE) ? await needLocalCore() : null;
 
-	const written = copyTemplate(join(CLI_DIR, 'templates', 'module'), dir, values, { natives }, path => path === 'src/natives.ts' && !natives);
+	const written = copyTemplate(join(CLI_DIR, 'templates', 'module'), dir, values, { natives, bun: pm === 'bun' }, path => path === 'src/natives.ts' && !natives);
 
 	const amxts = { module: 'src/index.ts' };
 	if (natives) Object.assign(amxts, { natives: 'src/natives.ts', include: `include/${values.include}.inc` });
@@ -78,15 +80,15 @@ export async function initModule(options) {
 		scripts: {
 			build: 'amxts build',
 			check: 'amxts check',
-			test: 'amxts test',
+			test: runner.script,
 			...LINT_SCRIPTS,
 		},
 		peerDependencies: { '@amxts/core': CORE_RANGE },
 		devDependencies: Object.fromEntries(Object.entries({
 			...(localCore ? { '@amxts/core': specFor({ name: '@amxts/core', dir: localCore.dir }, dir, pm) } : {}),
 			...LINT_DEPENDENCIES,
-			'@types/bun': '^1.4.2',
-			'typescript': '^6.0.3',
+			...runner.devDependencies,
+			typescript: '^6.0.3',
 		}).sort(([a], [b]) => a.localeCompare(b))),
 	}, null, '\t')}\n`);
 	written.push('package.json');

package/src/init.mjs

@@ -18,7 +18,7 @@ import { modulesList } from './config.mjs';
 import { bunFor, CLI_DIR, CORE_RANGE, coreDirFrom, FROM_SOURCE, loadCore, needLocalCore, readJson, VERSION } from './core.mjs';
 import { ensureIncludes, FETCHED, serverIncludes, targetOf, TARGETS } from './includes.mjs';
 import { LINT_DEPENDENCIES, LINT_FILES, LINT_SCRIPTS } from './lint.mjs';
-import { commandLine, execAmxts, installArgs, installLinked, linkedFolders, PACKAGE_MANAGERS, packageManagerOfAgent, run, runScript, versionOf } from './pm.mjs';
+import { commandLine, execAmxts, installArgs, installLinked, linkedFolders, PACKAGE_MANAGERS, packageManagerOfAgent, run, runScript, testRunner, versionOf } from './pm.mjs';
 import { npmRegistry, versionsFor } from './registry.mjs';
 import { askServer, canAsk, missingServer, serverEnv, serverFolder } from './server.mjs';
 import { HOST_SYSTEM, serverSystemOf, SYSTEMS } from './system.mjs';
@@ -32,8 +32,7 @@ import { c, CliError } from './ui.mjs';
  * from this machine's folders (--local) are not called unused.
  */
 const TOOLS = {
-	'@types/bun': '^1.4.2',
-	'knip': '^6.39.0',
+	knip: '^6.39.0',
 };
 
 const DEFAULT_DIR = 'my-server';
@@ -187,6 +186,7 @@ export async function initProject(options) {
 	// The files.
 	const amxts = execAmxts(pm);
 	const install = installArgs(pm).join(' ');
+	const runner = testRunner(pm);
 	const values = {
 		'name': packageName(root),
 		'author': gitAuthor(),
@@ -199,8 +199,9 @@ export async function initProject(options) {
 		'run.typecheck': runScript(pm, 'typecheck'),
 		'run.test': runScript(pm, 'test'),
 		'run.lint': runScript(pm, 'lint'),
+		'test.types': runner.types,
 	};
-	const flags = { lint, ...Object.fromEntries(installed.map(module => [shortName(module.name), true])) };
+	const flags = { lint, bun: pm === 'bun', ...Object.fromEntries(installed.map(module => [shortName(module.name), true])) };
 	const written = copyTemplate(join(CLI_DIR, 'templates', 'project'), root, values, flags, path => LINT_FILES.includes(path) && !lint);
 
 	const core = { name: '@amxts/core', dir: localCore?.dir ?? null };
@@ -209,6 +210,7 @@ export async function initProject(options) {
 		[core.name]: specFor(core, root, pm, CORE_RANGE),
 		...Object.fromEntries(installed.map(module => [module.name, specFor(module, root, pm, versions[module.name] ? `^${versions[module.name]}` : 'latest')])),
 		...TOOLS,
+		...runner.devDependencies,
 		...(lint ? LINT_DEPENDENCIES : {}),
 	};
 	writeFile(join(root, 'package.json'), `${JSON.stringify({
@@ -221,7 +223,7 @@ export async function initProject(options) {
 			dev: 'amxts dev',
 			build: 'amxts build',
 			typecheck: 'amxts typecheck',
-			test: 'amxts test',
+			test: runner.script,
 			...(lint ? LINT_SCRIPTS : {}),
 		},
 		devDependencies: Object.fromEntries(Object.entries(devDependencies).sort(([a], [b]) => a.localeCompare(b))),

package/src/main.mjs

@@ -6,7 +6,9 @@
 // It runs on Node. Commands that make or change a project (init, module,
 // info) run here; the ones that compile (build, dev, typecheck, check,
 // prepare) are tasks of the project's core, which runs them on Bun
-// (core.mjs); test runs bun test.
+// (core.mjs); test runs the project's Vitest, or bun test.
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
 import process from 'node:process';
 import { GLOBAL_FLAGS, parseArgs } from './args.mjs';
 import { needBun, needProject, projectCore, runTask, runTaskOrExit, VERSION } from './core.mjs';
@@ -137,12 +139,17 @@ export const COMMANDS = {
 		},
 	},
 	test: {
-		description: 'Run the project\'s tests on a fake server (bun test)',
-		usage: 'amxts test [bun test options]',
+		description: 'Run the project\'s tests on a fake server (Vitest when the project has it, else bun test)',
+		usage: 'amxts test [test runner options]',
 		passThrough: true,
 		examples: ['amxts test', 'amxts test hello', 'amxts test --watch'],
 		async run({ raw }) {
-			const result = await run([needBun(await projectCore(), 'runs tests'), 'test', ...raw]);
+			const core = await projectCore();
+			// A project with Vitest tests on Node; any other on bun test.
+			const vitest = join(needProject(), 'node_modules', 'vitest', 'vitest.mjs');
+			const result = await run(existsSync(vitest)
+				? [process.execPath, vitest, ...(raw.includes('--watch') ? [] : ['run']), ...raw]
+				: [needBun(core, 'runs tests'), 'test', ...raw]);
 			process.exitCode = result.code;
 		},
 	},

package/src/pm.mjs

@@ -75,6 +75,17 @@ export function execAmxts(pm) {
 	return { npm: 'npx amxts', pnpm: 'pnpm amxts', yarn: 'yarn amxts', bun: 'bunx amxts' }[pm] ?? 'npx amxts';
 }
 
+/**
+ * What a new project's or module's tests run on: `bun test` with Bun as the
+ * package manager, Vitest on Node with any other. `types` is the test
+ * folder's tsconfig `types`.
+ */
+export function testRunner(pm) {
+	return pm === 'bun'
+		? { script: 'amxts test', types: 'bun', devDependencies: { '@types/bun': '^1.4.2' } }
+		: { script: 'vitest run', types: 'node', devDependencies: { '@types/node': '^24.0.0', 'vitest': '^5.0.3' } };
+}
+
 /**
  * The folders a project's package.json takes packages from - `link:` and
  * `file:` specs: the core and the modules of this machine (--local).

package/templates/module/test/tsconfig.json

@@ -4,7 +4,7 @@
 		"lib": ["ES2022"],
 		"module": "ESNext",
 		"moduleResolution": "bundler",
-		"types": ["bun"],
+		"types": ["{{test.types}}"],
 		"strict": true,
 		"noEmit": true,
 		"skipLibCheck": true

package/templates/module/test/{{name}}.test.ts

@@ -1,4 +1,9 @@
+// #if bun
 import { describe, expect, test } from "bun:test";
+// #endif
+// #if !bun
+import { describe, expect, test } from "vitest";
+// #endif
 import { setup } from "@amxts/core/test-utils";
 
 // The first test compiles the plugins; the next runs take them from the cache.

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

@@ -1,11 +1,21 @@
+// #if bun
 import { expect, setDefaultTimeout, test } from "bun:test";
+// #endif
+// #if !bun
+import { expect, test, vi } from "vitest";
+// #endif
 import { setup } from "@amxts/core/test-utils";
 // #if menu-core
 import { menusOf } from "@amxts/menu-core/testing";
 // #endif
 
 // The first run compiles the plugins; the next ones take them from the cache.
+// #if bun
 setDefaultTimeout(120_000);
+// #endif
+// #if !bun
+vi.setConfig({ testTimeout: 120_000 });
+// #endif
 
 test("a player who joins is greeted", async () => {
 	const server = await setup();

package/templates/project/test/tsconfig.json

@@ -4,7 +4,7 @@
 		"lib": ["ES2022"],
 		"module": "ESNext",
 		"moduleResolution": "bundler",
-		"types": ["bun"],
+		"types": ["{{test.types}}"],
 		"strict": true,
 		"noEmit": true,
 		"skipLibCheck": true