@reformer/builder-plugin-cli 1.0.0-beta.1

package/dist/commands/validate.js

@@ -0,0 +1,128 @@
+/**
+ * `reformer-plugin validate`: пропустит ли оболочка этот плагин — ДО оболочки.
+ *
+ * Каждое правило здесь взято из пакета контракта, а не написано заново: разбор манифеста,
+ * разбор словаря, расширения кода. Валидатор, пропускающий то, что оболочка отвергнет, хуже
+ * отсутствия валидатора, — поэтому своего у CLI только то, чего оболочка не видит вовсе.
+ *
+ * ## Что проверяется
+ *
+ * 1. **Манифест исходников** — `parsePluginSourceManifest`: всё, что проверяет оболочка, кроме
+ *    имени каталога, плюс обязательная версия. Отказ здесь останавливает проверку: без манифеста
+ *    не известно, какие файлы искать.
+ * 2. **Файлы, на которые манифест ссылается**: точка входа (есть и это код), таблица стилей,
+ *    словари (есть и плоские). Оболочка отказывает на них при загрузке — здесь то же
+ *    отказом, но до неё. Эти проверки собираются ВСЕ: автору полезнее список, чем первая беда.
+ * 3. **Версия `package.json`**, если он есть, совпадает с версией манифеста. Оболочка
+ *    `package.json` не читает, поэтому расхождение она не заметит, — а упаковка опубликует пакет
+ *    одной версии с манифестом другой.
+ *
+ * Чего здесь НЕТ и почему: сверки `provides` с тем, что плагин регистрирует, потолка числа
+ * файлов и сверки `compatibility.builder` с версией билдера. Первое требует исполнить код,
+ * второе относится к собранному каталогу, а третьего CLI знать не может: в каком билдере плагин
+ * запустят, решает не он, и отказ по этому полю был бы отказом по выдуманному числу. Форма
+ * диапазона при этом проверяется — опечатка ловится здесь, а не у человека при загрузке.
+ *
+ * @module @reformer/builder-plugin-cli/commands/validate
+ */
+import { readFile, stat } from 'node:fs/promises';
+import { join } from 'node:path';
+import { isPluginCodeFile, parseMessagesBundle, parsePluginSourceManifest, PLUGIN_MANIFEST_FILE, } from '@reformer/builder-plugin-api/tooling';
+async function readText(path) {
+    try {
+        return await readFile(path, 'utf8');
+    }
+    catch {
+        return undefined;
+    }
+}
+async function isFile(path) {
+    try {
+        return (await stat(path)).isFile();
+    }
+    catch {
+        return false;
+    }
+}
+/** Проверяет каталог исходников плагина. Ничего не бросает: отказы — данные. */
+export async function validatePlugin(dir) {
+    const text = await readText(join(dir, PLUGIN_MANIFEST_FILE));
+    if (text === undefined) {
+        return {
+            ok: false,
+            findings: [
+                {
+                    code: 'manifest-missing',
+                    message: `в каталоге нет ${PLUGIN_MANIFEST_FILE}`,
+                    file: PLUGIN_MANIFEST_FILE,
+                },
+            ],
+        };
+    }
+    const parsed = parsePluginSourceManifest(text);
+    if (!parsed.ok)
+        return { ok: false, findings: [parsed.problem] };
+    const { manifest } = parsed;
+    const findings = [];
+    if (!isPluginCodeFile(manifest.main)) {
+        findings.push({
+            code: 'entry-missing',
+            message: `точка входа «${manifest.main}» — не файл кода: загрузчик берёт только .js/.ts и родственные`,
+            file: PLUGIN_MANIFEST_FILE,
+        });
+    }
+    else if (!(await isFile(join(dir, manifest.main)))) {
+        findings.push({
+            code: 'entry-missing',
+            message: `точки входа «${manifest.main}» нет`,
+            file: manifest.main,
+        });
+    }
+    if (manifest.styles !== undefined && !(await isFile(join(dir, manifest.styles.file)))) {
+        findings.push({
+            code: 'styles-invalid',
+            message: `объявленной таблицы стилей «${manifest.styles.file}» нет`,
+            file: manifest.styles.file,
+        });
+    }
+    const messages = manifest.contributes?.messages ?? {};
+    for (const [locale, file] of Object.entries(messages)) {
+        const bundle = await readText(join(dir, file));
+        if (bundle === undefined) {
+            findings.push({
+                code: 'messages-invalid',
+                message: `словарь локали «${locale}»: «${file}» не читается`,
+                file,
+            });
+            continue;
+        }
+        const checked = parseMessagesBundle(bundle);
+        if (!checked.ok) {
+            findings.push({
+                code: 'messages-invalid',
+                message: `словарь локали «${locale}»: «${file}» ${checked.reason}`,
+                file,
+            });
+        }
+    }
+    const pkg = await readText(join(dir, 'package.json'));
+    if (pkg !== undefined) {
+        let version;
+        try {
+            version = JSON.parse(pkg).version;
+        }
+        catch {
+            version = undefined;
+        }
+        if (version !== manifest.version) {
+            findings.push({
+                code: 'package-version',
+                message: `версия package.json («${String(version)}») не совпадает с версией манифеста ` +
+                    `(«${manifest.version}»): пакет опубликуется одной версией, а оболочка покажет другую`,
+                file: 'package.json',
+            });
+        }
+    }
+    return findings.length === 0 ? { ok: true, manifest } : { ok: false, manifest, findings };
+}
+//# sourceMappingURL=validate.js.map

package/dist/commands/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/commands/validate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,GAErB,MAAM,sCAAsC,CAAC;AAgB9C,KAAK,UAAU,QAAQ,CAAC,IAAY;IAClC,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,gFAAgF;AAChF,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,GAAW;IAC9C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC7D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO;YACL,EAAE,EAAE,KAAK;YACT,QAAQ,EAAE;gBACR;oBACE,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EAAE,kBAAkB,oBAAoB,EAAE;oBACjD,IAAI,EAAE,oBAAoB;iBAC3B;aACF;SACF,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;IAC/C,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACjE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAE5B,MAAM,QAAQ,GAAwB,EAAE,CAAC;IAEzC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,gBAAgB,QAAQ,CAAC,IAAI,gEAAgE;YACtG,IAAI,EAAE,oBAAoB;SAC3B,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,gBAAgB,QAAQ,CAAC,IAAI,OAAO;YAC7C,IAAI,EAAE,QAAQ,CAAC,IAAI;SACpB,CAAC,CAAC;IACL,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACtF,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,+BAA+B,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO;YACnE,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,QAAQ,GAAqC,QAAQ,CAAC,WAAW,EAAE,QAAQ,IAAI,EAAE,CAAC;IACxF,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;QAC/C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,mBAAmB,MAAM,OAAO,IAAI,eAAe;gBAC5D,IAAI;aACL,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;YAChB,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,mBAAmB,MAAM,OAAO,IAAI,KAAK,OAAO,CAAC,MAAM,EAAE;gBAClE,IAAI;aACL,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC;IACtD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,IAAI,OAAgB,CAAC;QACrB,IAAI,CAAC;YACH,OAAO,GAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAA2B,CAAC,OAAO,CAAC;QAC/D,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,SAAS,CAAC;QACtB,CAAC;QACD,IAAI,OAAO,KAAK,QAAQ,CAAC,OAAO,EAAE,CAAC;YACjC,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EACL,yBAAyB,MAAM,CAAC,OAAO,CAAC,sCAAsC;oBAC9E,KAAK,QAAQ,CAAC,OAAO,iEAAiE;gBACxF,IAAI,EAAE,cAAc;aACrB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAC5F,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Программный вход CLI: те же команды, что у `reformer-plugin`, без процесса вокруг.
+ *
+ * @module @reformer/builder-plugin-cli
+ */
+export { buildPlugin, type BuildOptions, type BuildResult } from './commands/build.js';
+export { createPlugin, type CreateOptions, type CreateResult } from './commands/create.js';
+export { startDev, type DevOptions, type DevSession } from './commands/dev.js';
+export { type CliFindingCode, type Finding } from './commands/findings.js';
+export { packPlugin, type PackOptions, type PackResult } from './commands/pack.js';
+export { validatePlugin, type ValidationFinding, type ValidationResult, } from './commands/validate.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,KAAK,UAAU,EAAE,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/E,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EACL,cAAc,EACd,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,GACtB,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * Программный вход CLI: те же команды, что у `reformer-plugin`, без процесса вокруг.
+ *
+ * @module @reformer/builder-plugin-cli
+ */
+export { buildPlugin } from './commands/build.js';
+export { createPlugin } from './commands/create.js';
+export { startDev } from './commands/dev.js';
+export { packPlugin } from './commands/pack.js';
+export { validatePlugin, } from './commands/validate.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAuC,MAAM,qBAAqB,CAAC;AACvF,OAAO,EAAE,YAAY,EAAyC,MAAM,sBAAsB,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAoC,MAAM,mBAAmB,CAAC;AAE/E,OAAO,EAAE,UAAU,EAAqC,MAAM,oBAAoB,CAAC;AACnF,OAAO,EACL,cAAc,GAGf,MAAM,wBAAwB,CAAC"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@reformer/builder-plugin-cli",
+  "version": "1.0.0-beta.1",
+  "description": "Command-line tools for ReFormer Builder plugin authors: scaffold, validate, build, develop and pack a plugin",
+  "type": "module",
+  "bin": {
+    "reformer-plugin": "./dist/cli.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.build.json",
+    "test": "node ../../scripts/run-vitest.mjs"
+  },
+  "keywords": [
+    "reformer",
+    "builder",
+    "plugin",
+    "cli"
+  ],
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "author": "Alexandr Bukhtatyy",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AlexandrBukhtatyy/ReFormer.git",
+    "directory": "packages/reformer-builder-plugin-cli"
+  },
+  "homepage": "https://alexandrbukhtatyy.github.io/ReFormer/",
+  "bugs": {
+    "url": "https://github.com/AlexandrBukhtatyy/ReFormer/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@reformer/builder-plugin-api": "*",
+    "esbuild": "^0.27.1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.8"
+  }
+}