@amxts/cli 0.1.0

package/templates/project/_vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+	"recommendations": ["amxts.amxts-vscode", "oxc.oxc-vscode", "redhat.vscode-yaml"]
+}

package/templates/project/_vscode/settings.json

@@ -0,0 +1,13 @@
+{
+	"files.insertFinalNewline": true,
+
+	"editor.formatOnSave": false,
+	"editor.codeActionsOnSave": {
+		"source.fixAll.oxc": "explicit",
+		"source.organizeImports": "never"
+	},
+	"[json][jsonc][yaml]": {
+		"editor.defaultFormatter": "oxc.oxc-vscode",
+		"editor.formatOnSave": true
+	}
+}

package/templates/project/amxts.config.ts

@@ -0,0 +1,24 @@
+/**
+ * The project's config: the modules it uses and their options.
+ * About this file: https://amxts.github.io/docs/getting-started/quick-start#a-project
+ */
+export default defineConfig({
+	/**
+	 * The modules the plugins use. A module no plugin uses is left out of the
+	 * build; one whose natives only Pawn plugins call stays with
+	 * `pawn: ["@amxts/menu-core"]`.
+	 */
+	modules: {{modules}},
+
+	/**
+	 * The server the plugins are for: "rehlds" (ReHLDS, ReGameDLL, ReAPI) or "hlds".
+	 * With AMXTS_SERVER the build takes that server's includes; without, amxts
+	 * fetches this one's into .amxts/include.
+	 */
+	target: "{{target}}",
+	// #if menu-core
+
+	// Where menu-core reads its menus - configs/menu.ini, .yaml or .json:
+	// menus: { file: "menu" },
+	// #endif
+});

package/templates/project/knip.json

@@ -0,0 +1,4 @@
+{
+	"entry": ["plugins/**/*.ts", "amxts.config.ts", "test/**/*.ts"],
+	"project": ["**/*.ts"]
+}

package/templates/project/plugins/hello.ts

@@ -0,0 +1,39 @@
+plugin({ name: "Hello", version: "1.0.0", author: "{{author}}", description: "The first plugin of {{name}}" });
+
+// #if config-core
+// configs/hello.yaml (or hello.json) says what a player is greeted with -
+// "greeting: Hi" - and "Welcome" is what it is when the file does not say.
+const { greeting } = configs.load("hello", { greeting: "Welcome" });
+// #endif
+// #if !config-core
+const greeting = "Welcome";
+// #endif
+
+server.addCommand("/hp", sayHp);
+server.addEventListener("putinserver", event => print(0, `${greeting}, ${event.player.name}!`));
+// #if menu-core
+
+// A menu made in code: its title and items can be functions of the player.
+const hello = menus.create("HELLO", { title: player => `Hello, ${player.name}` });
+hello.addItem("Wave", { onSelect: wave });
+hello.addItem(player => `Heal (${player.health} HP)`, {
+	visible: player => player.health < 100,
+	onSelect: heal,
+});
+
+server.addCommand("/menu", player => hello.show(player));
+// #endif
+
+function sayHp(player: Player) {
+	print(player, `${player.name}, your HP: ${player.health}`);
+}
+// #if menu-core
+
+function wave(player: Player) {
+	print(0, `${player.name} waves`);
+}
+
+function heal(player: Player) {
+	player.health = 100;
+}
+// #endif

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

@@ -0,0 +1,37 @@
+import { expect, setDefaultTimeout, test } from "bun:test";
+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.
+setDefaultTimeout(120_000);
+
+test("a player who joins is greeted", async () => {
+	const server = await setup();
+	const alice = server.join("Alice");
+
+	expect(alice.chat).toContain("Welcome, Alice!");
+});
+
+test("/hp tells a player their health", async () => {
+	const server = await setup();
+	const alice = server.join("Alice", { health: 40 });
+
+	alice.say("/hp");
+	expect(alice.chat).toContain("Alice, your HP: 40");
+});
+// #if menu-core
+
+test("/menu heals a hurt player", async () => {
+	const server = await setup();
+	const menus = menusOf(server);
+	const alice = server.join("Alice", { health: 40 });
+
+	alice.say("/menu");
+	expect(menus.screen(alice)!.text).toContain("Heal (40 HP)");
+
+	menus.press(alice, 2);
+	expect(alice.health).toBe(100);
+});
+// #endif

package/templates/project/test/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"compilerOptions": {
+		"target": "ES2022",
+		"lib": ["ES2022"],
+		"module": "ESNext",
+		"moduleResolution": "bundler",
+		"types": ["bun"],
+		"strict": true,
+		"noEmit": true,
+		"skipLibCheck": true
+	},
+	"include": ["./**/*.ts"]
+}

package/templates/project/tsconfig.json

@@ -0,0 +1,3 @@
+{
+	"extends": "./.amxts/tsconfig.json"
+}