@amxts/cli 0.1.0

package/templates/module/assets/logo.svg

@@ -0,0 +1,8 @@
+<svg width="128" height="128" viewBox="0 0 128 128" fill="none" xmlns="http://www.w3.org/2000/svg" role="img" aria-label="{{title}}">
+  <rect width="128" height="128" rx="28" fill="#15181D"/>
+  <!-- the amxts braces -->
+  <path d="M48 40C40 40 40 46 40 52C40 60 34 62 30 64C34 66 40 68 40 76C40 82 40 88 48 88" stroke="#F2C94C" stroke-width="8" stroke-linecap="round" stroke-linejoin="round"/>
+  <path d="M80 40C88 40 88 46 88 52C88 60 94 62 98 64C94 66 88 68 88 76C88 82 88 88 80 88" stroke="#F2C94C" stroke-width="8" stroke-linecap="round" stroke-linejoin="round"/>
+  <!-- the module's own sign: replace this square with yours -->
+  <rect x="53" y="53" width="22" height="22" rx="6" fill="#9AA3AE"/>
+</svg>

package/templates/module/playground/amxts.config.ts

@@ -0,0 +1,4 @@
+export default defineConfig({
+	modules: ["{{package}}"],
+	{{configKey}}: { greeting: "Hi" },
+});

package/templates/module/playground/plugins/welcome.ts

@@ -0,0 +1,3 @@
+plugin({ name: "Welcome", version: "0.1.0", author: "{{author}}", description: "Tries {{title}} out" });
+
+server.addCommand("/hello", {{camel}}.greet);

package/templates/module/playground/tsconfig.json

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

package/templates/module/src/index.ts

@@ -0,0 +1,25 @@
+/**
+ * {{title}}: an amxts module. Its exports are its API - the plugins of a
+ * project that lists it use it as `{{camel}}`, without an import - and one
+ * instance of it runs on the server for all of them.
+ */
+import { Player, print } from "@amxts/core";
+import { {{Options}} } from "./types";
+
+export * from "./types";
+
+export default defineModule<{{Options}}>({
+	meta: { name: "{{name}}", configKey: "{{configKey}}" },
+	defaults: { greeting: "Hello" },
+	imports: [{ from: "{{package}}", as: "{{camel}}" }],
+	setup(options) {
+		greeting = options.greeting;
+	},
+});
+
+let greeting = "";
+
+/** Greets the player in chat. */
+export function greet(player: Player) {
+	print(player, `${greeting}, ${player.name}!`);
+}

package/templates/module/src/natives.ts

@@ -0,0 +1,13 @@
+/**
+ * {{title}} for Pawn plugins: each `export function` here is a native, and
+ * `npx amxts build` writes include/{{include}}.inc from them.
+ */
+import { Player, plugin } from "@amxts/core";
+import * as {{camel}} from "./index";
+
+plugin({ name: "{{title}}", version: "0.1.0", author: "{{author}}", description: "{{title}} for amxts" });
+
+/** Greets the player in chat. */
+export function {{include}}_greet(player: Player) {
+	{{camel}}.greet(player);
+}

package/templates/module/src/types.ts

@@ -0,0 +1,11 @@
+/** {{title}}'s options: `{{configKey}}` in a project's amxts.config.ts. */
+export interface {{Options}} {
+	/** What a player is greeted with. */
+	greeting: string;
+}
+
+declare module "@amxts/core" {
+	interface ModuleOptions {
+		{{configKey}}?: Partial<{{Options}}>;
+	}
+}

package/templates/module/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/module/test/{{name}}.test.ts

@@ -0,0 +1,25 @@
+import { describe, expect, test } from "bun:test";
+import { setup } from "@amxts/core/test-utils";
+
+// The first test compiles the plugins; the next runs take them from the cache.
+const TIMEOUT = 120_000;
+
+describe("{{name}}", () => {
+	test("the playground's plugin greets whoever asks, with the playground's greeting", async () => {
+		const server = await setup({ rootDir: "playground" });
+		const alice = server.join("Alice");
+
+		alice.say("/hello");
+		expect(alice.chat).toContain("Hi, Alice!");
+	}, TIMEOUT);
+	// #if natives
+
+	test("a Pawn plugin greets through the native", async () => {
+		const server = await setup();
+		const bob = server.join("Bob");
+
+		server.native("{{include}}_greet", bob.id);
+		expect(bob.chat).toContain("Hello, Bob!");
+	}, TIMEOUT);
+	// #endif
+});

package/templates/module/tsconfig.json

@@ -0,0 +1,10 @@
+{
+	"extends": "@amxts/core/as/tsconfig.json",
+	"compilerOptions": {
+		"paths": {
+			"~/*": ["./node_modules/@amxts/core/as/*"]
+		},
+		"noEmit": true
+	},
+	"include": ["src/**/*.ts"]
+}

package/templates/project/README.md

@@ -0,0 +1,28 @@
+# {{name}}
+
+Counter-Strike 1.6 plugins in TypeScript, built with [amxts](https://amxts.github.io/).
+
+## Commands
+
+- `{{install}}` - installs the core, the modules and the tools
+- `{{run.dev}}` - builds, deploys to the server in `AMXTS_SERVER` and again on every save
+- `{{run.build}}` - builds the plugins into `dist/`, with `plugins.ini`
+- `{{run.typecheck}}` - checks the plugins as the editor does
+- `{{run.test}}` - runs the tests in `test/` on a fake server
+<!-- #if lint -->
+- `{{run.lint}}` - oxlint and oxfmt check the code; `lint:fix` fixes what they can
+<!-- #endif -->
+- `{{amxts}} module add <name>` - installs a module and lists it in `amxts.config.ts`
+
+`AMXTS_SERVER` in `.env` is the `addons/amxts` folder of the server `dev`
+deploys to:
+
+```sh
+AMXTS_SERVER=D:/hlds/cstrike/addons/amxts
+```
+
+## Layout
+
+- `plugins/` - the plugins: each `.ts` file here is one plugin on the server
+- `amxts.config.ts` - the modules the project uses and their options
+- `test/` - tests: the plugins on a fake server, driven as players would

package/templates/project/_gitattributes

@@ -0,0 +1,7 @@
+# #if lint
+# oxfmt writes LF: the files it formats keep LF when checked out on Windows too.
+*.json text eol=lf
+*.jsonc text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
+# #endif

package/templates/project/_gitignore

@@ -0,0 +1,7 @@
+node_modules/
+# amxts prepare: the editor config tsconfig.json extends, the includes it fetches
+.amxts/
+# amxts build
+dist/
+# this machine's settings: AMXTS_SERVER
+.env

package/templates/project/_oxfmtrc.json

@@ -0,0 +1,18 @@
+{
+	"$schema": "./node_modules/oxfmt/configuration_schema.json",
+	"useTabs": true,
+	"singleQuote": false,
+	"sortPackageJson": false,
+	"ignorePatterns": [
+		"**/*.ts",
+		"**/*.mts",
+		"**/*.cts",
+		"**/*.tsx",
+		"**/*.js",
+		"**/*.mjs",
+		"**/*.cjs",
+		"**/*.jsx",
+		"**/*.md",
+		"**/*.inc"
+	]
+}