@amxts/cli 0.1.0

package/templates/module/README.md

@@ -0,0 +1,81 @@
+<div align="center">
+
+<img src="assets/logo.svg" width="96" alt="{{title}}">
+
+# {{title}}
+
+*What {{title}} does, in one line*
+
+[![amxts module](https://img.shields.io/badge/amxts-module-3178c6?style=flat-square)](https://amxts.github.io/)
+[![License](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](LICENSE)
+
+[Features](#features) • [Installation](#installation) • [Usage](#usage) • [Development](#development)
+
+**English** | [Русский](README.ru.md)
+
+</div>
+
+{{title}} greets players — say here what your module does, for whom and why.
+
+## Features
+
+- **Greets players.** `greet(player)` says hello in chat — replace this with what your module does.
+
+## Installation
+
+```bash
+npx amxts module add {{package}}
+```
+
+It installs the package and adds it to your project's `amxts.config.ts`:
+
+```ts
+export default defineConfig({
+	modules: ["{{package}}"],
+	{{configKey}}: {
+		greeting: "Hi",
+	},
+});
+```
+
+| Option | Default | What it does |
+| --- | --- | --- |
+| `greeting` | `"Hello"` | What a player is greeted with. |
+
+## Usage
+
+A plugin of a project that lists the module uses it as `{{camel}}`, without an import:
+
+```ts
+server.addCommand("/hello", {{camel}}.greet);
+```
+
+| Function | What it does |
+| --- | --- |
+| `greet(player)` | Greets the player in chat. |
+
+The module is built only for a project whose plugins use it.
+<!-- #if natives -->
+
+## Pawn plugins
+
+Pawn plugins call the module through its natives: `#include <{{include}}>` — the package ships `include/{{include}}.inc`. A project whose Pawn plugins call them keeps the module in the build when no TypeScript plugin uses it: `pawn: ["{{package}}"]` in `amxts.config.ts`.
+
+```pawn
+#include <{{include}}>
+
+public client_putinserver(id) {
+	{{include}}_greet(id);
+}
+```
+<!-- #endif -->
+
+## Development
+
+```bash
+npm install
+npm test             # the tests in test/, on the playground project
+npm run check        # the package is ready to publish
+```
+
+`playground/` is a project with the module in it: its `amxts.config.ts` lists the module, and `plugins/` has a plugin that uses it. `npx amxts build` there builds it for a server.

package/templates/module/README.ru.md

@@ -0,0 +1,81 @@
+<div align="center">
+
+<img src="assets/logo.svg" width="96" alt="{{title}}">
+
+# {{title}}
+
+*Что делает {{title}}, одной строкой*
+
+[![amxts module](https://img.shields.io/badge/amxts-module-3178c6?style=flat-square)](https://amxts.github.io/)
+[![License](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](LICENSE)
+
+[Возможности](#возможности) • [Установка](#установка) • [Использование](#использование) • [Разработка](#разработка)
+
+[English](README.md) | **Русский**
+
+</div>
+
+{{title}} приветствует игроков — напишите здесь, что делает ваш модуль, для кого и зачем.
+
+## Возможности
+
+- **Приветствует игроков.** `greet(player)` здоровается в чате — замените это тем, что делает ваш модуль.
+
+## Установка
+
+```bash
+npx amxts module add {{package}}
+```
+
+Команда ставит пакет и добавляет его в `amxts.config.ts` проекта:
+
+```ts
+export default defineConfig({
+	modules: ["{{package}}"],
+	{{configKey}}: {
+		greeting: "Привет",
+	},
+});
+```
+
+| Настройка | По умолчанию | Что делает |
+| --- | --- | --- |
+| `greeting` | `"Hello"` | Чем приветствовать игрока. |
+
+## Использование
+
+Плагин проекта, в котором модуль указан, пользуется им как `{{camel}}`, без импорта:
+
+```ts
+server.addCommand("/hello", {{camel}}.greet);
+```
+
+| Функция | Что делает |
+| --- | --- |
+| `greet(player)` | Приветствует игрока в чате. |
+
+Модуль собирается только для проекта, плагины которого им пользуются.
+<!-- #if natives -->
+
+## Pawn-плагины
+
+Pawn-плагины обращаются к модулю через его нативы: `#include <{{include}}>` — пакет поставляет `include/{{include}}.inc`. Проект, Pawn-плагины которого их вызывают, оставляет модуль в сборке, даже когда им не пользуется ни один плагин на TypeScript: `pawn: ["{{package}}"]` в `amxts.config.ts`.
+
+```pawn
+#include <{{include}}>
+
+public client_putinserver(id) {
+	{{include}}_greet(id);
+}
+```
+<!-- #endif -->
+
+## Разработка
+
+```bash
+npm install
+npm test             # тесты из test/ на проекте playground
+npm run check        # пакет готов к публикации
+```
+
+`playground/` — проект с модулем: его `amxts.config.ts` перечисляет модуль, а в `plugins/` лежит плагин, который им пользуется. `npx amxts build` там собирает его для сервера.

package/templates/module/_gitattributes

@@ -0,0 +1,5 @@
+# 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

package/templates/module/_gitignore

@@ -0,0 +1,11 @@
+node_modules/
+*.tgz
+# amxts prepare: the editor config the playground extends
+.amxts/
+# amxts build
+dist/
+# a library: the consumer resolves its own versions
+bun.lock
+package-lock.json
+pnpm-lock.yaml
+yarn.lock

package/templates/module/_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"
+	]
+}