@motrix/plugin-cli 2.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright (c) 2018-present Dr_rOot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# @motrix/plugin-cli
+
+Command-line developer tools for authoring, validating, and packaging
+[Motrix](https://motrix.app) plugins.
+
+Ships two bins:
+
+- **`motrix-plugin`** — the main developer tool (init/dev/validate/lint/pack)
+- **`create-motrix-plugin`** — a thin scaffolder invoked via `pnpm create motrix-plugin`
+
+## Install
+
+```bash
+pnpm add -D @motrix/plugin-cli
+# or run without installing:
+pnpm dlx @motrix/plugin-cli init my-plugin
+```
+
+## Commands
+
+```bash
+motrix-plugin init <name> [-t basic-resolver|post-action] [-p <publisher>]
+```
+Scaffold a new plugin project from a template (`basic-resolver` or
+`post-action`) into `./<name>`.
+
+```bash
+motrix-plugin dev
+```
+Watch-build the plugin with esbuild and relaunch a local Motrix install
+against it (found via `$MOTRIX_BIN` or a standard Motrix install location).
+
+```bash
+motrix-plugin validate
+```
+Validate `motrix-plugin.json` against
+[`@motrix/plugin-manifest-schema`](https://www.npmjs.com/package/@motrix/plugin-manifest-schema) —
+the same schema the Motrix host uses when installing a plugin.
+
+### Schema versioning
+
+`validate` checks your manifest against the `@motrix/plugin-manifest-schema`
+version **embedded in the CLI at build time** — not whatever copy of the
+schema your own project has installed. Keep `@motrix/plugin-cli` up to date
+so its embedded schema matches the Motrix host you're targeting; schema
+releases always ship together with a matching CLI release (lockstep), so
+staying current on the CLI keeps you current on the schema too.
+
+```bash
+motrix-plugin lint
+```
+Static checks beyond schema validation: locale coverage
+(`contributes`/UI strings present in every declared locale) and
+top-level side-effect detection (guest code must not run effectful code at
+module scope).
+
+```bash
+motrix-plugin validate-host-permissions
+```
+Sanity-check `hostPermissions` match patterns and warn on overly broad grants
+(e.g. `<all_urls>`).
+
+```bash
+motrix-plugin pack
+```
+Bundle the plugin with esbuild and zip it into a `.moext` distributable,
+enforcing the per-bundle and total package size limits.
+
+```bash
+pnpm create motrix-plugin my-plugin [template]
+```
+Equivalent to `motrix-plugin init`, usable without a prior install via the
+`create-*` npm convention.
+
+## Learn more
+
+- Manifest shape reference: [`@motrix/plugin-manifest-schema`](https://www.npmjs.com/package/@motrix/plugin-manifest-schema)
+- Plugin runtime types: [`@motrix/plugin-api`](https://www.npmjs.com/package/@motrix/plugin-api)
+- Design background: `docs/superpowers/specs/2026-05-09-plugin-ecosystem-design.md`
+  in the [motrix-turbo](https://gitlab.com/agalwood/motrix-turbo) repository

package/dist/bin/create-motrix-plugin.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+
+// src/commands/init.ts
+import { copyFile, mkdir, readdir, readFile, writeFile } from "fs/promises";
+import path from "path";
+import { fileURLToPath } from "url";
+var TEMPLATES = path.resolve(
+  fileURLToPath(import.meta.url),
+  "../../templates"
+);
+async function init(opts) {
+  const target = path.resolve(opts.destDir, opts.projectName);
+  await mkdir(target, { recursive: true });
+  const src = path.join(TEMPLATES, opts.template);
+  await copyTree(src, target, {
+    PROJECT_NAME: opts.projectName,
+    PUBLISHER: opts.publisher,
+    PLUGIN_ID: `${opts.publisher}.${opts.projectName}`
+  });
+  return { created: target };
+}
+async function copyTree(src, dst, vars) {
+  for (const e of await readdir(src, { withFileTypes: true })) {
+    const sp = path.join(src, e.name);
+    const dp = path.join(dst, e.name.replace(/\.tpl$/, ""));
+    if (e.isDirectory()) {
+      await mkdir(dp, { recursive: true });
+      await copyTree(sp, dp, vars);
+    } else if (e.name.endsWith(".tpl")) {
+      let content = await readFile(sp, "utf8");
+      for (const [k, v] of Object.entries(vars))
+        content = content.replaceAll(`{{${k}}}`, v);
+      await writeFile(dp, content);
+    } else {
+      await copyFile(sp, dp);
+    }
+  }
+}
+
+// src/bin/create-motrix-plugin.ts
+var validTemplates = ["basic-resolver", "post-action"];
+var [name = "my-plugin", rawTemplate = "basic-resolver"] = process.argv.slice(2);
+if (!validTemplates.includes(rawTemplate)) {
+  console.error(
+    `Unknown template: ${rawTemplate}. Available: ${validTemplates.join(", ")}`
+  );
+  process.exit(1);
+}
+var template = rawTemplate;
+await init({
+  projectName: name,
+  template,
+  destDir: process.cwd(),
+  publisher: "me"
+});
+console.log("Created", name);