@motrix/plugin-cli 2.1.0 → 2.2.0

package/dist/templates/basic-resolver/package.json.tpl

@@ -9,9 +9,9 @@
     "dev": "motrix-plugin dev"
   },
   "devDependencies": {
-    "@motrix/plugin-api": "^2.0.0",
-    "@motrix/plugin-cli": "^2.0.0",
-    "esbuild": "^0.24",
-    "typescript": "^5.6"
+    "@motrix/plugin-api": "^2.1.0",
+    "@motrix/plugin-cli": "^2.1.1",
+    "esbuild": "^0.28.2",
+    "typescript": "^7.0.2"
   }
 }

package/dist/templates/operation/.gitignore.tpl

@@ -0,0 +1,8 @@
+node_modules/
+dist/
+*.tsbuildinfo
+*.log
+.env
+.env.*
+!.env.example
+.DS_Store

package/dist/templates/operation/README.md.tpl

@@ -0,0 +1,94 @@
+# {{PROJECT_NAME}}
+
+**English** | [简体中文](./README.zh-CN.md)
+
+A text deduplication operation scaffolded for `{{PLUGIN_ID}}`.
+
+> **Unreleased protocol and template.** Use a Motrix development build and SDK
+> packages that implement operations v1, composable UI and scoped text files.
+> The host range is `>=2.0.0-beta.48 <3.0.0`, targeting beta.48 as the first
+> supporting release. Beta.47 is rejected, including development builds still
+> reporting that version. This target and the dependency ranges do not establish
+> published support. Raise the host floor if these features ship after beta.48.
+
+## Set up matching development dependencies
+
+Build a matching plugin-sdk checkout first with `pnpm install --frozen-lockfile`
+and `pnpm build` in that checkout. If this project was created immediately inside
+that checkout's root, run the following **from this project directory**:
+
+```sh
+pnpm add -D @motrix/plugin-api@file:../packages/plugin-api @motrix/plugin-cli@file:../packages/plugin-cli
+```
+
+If the project lives elsewhere, adjust both `file:` paths to the matching built
+SDK packages. Do not replace this step with a plain install of the older published
+API/CLI. The source checkout's schema is embedded in its CLI build. When matching
+SDK packages are released, replace these local dependencies with their actual
+released versions; no minimum published SDK package version is assigned here.
+
+## Check and pack
+
+```sh
+pnpm run typecheck
+pnpm run validate
+pnpm run pack
+pnpm run lint
+```
+
+`pack` bundles `src/index.ts` and writes the unsigned
+`dist/{{PLUGIN_ID}}-0.1.0.moext`. `lint` checks the built bundle, so it runs after
+`pack`. `pnpm run build` is an optional bundle-only step. No command here signs or
+publishes. Install the archive through a compatible host's normal third-party
+installation flow and review the two selected-file permissions.
+
+## Files to edit
+
+| File | Role |
+|---|---|
+| `motrix-plugin.json` | Private operation command, argument/result schemas, fields, layout, files, entries and repeat policy |
+| `src/index.ts` | Typed sandbox handler, cancellation checks, progress and scoped file calls |
+| `locales/en-US.json`, `locales/zh-CN.json` | Complete labels, hints, actions and result titles |
+| `tsconfig.json` | Strict checking through the installed `@motrix/plugin-api`; no SDK checkout path is embedded |
+| `esbuild.config.mjs` | Standalone ES2020 bundle with `motrix:plugin-api` kept external |
+
+The handler and manifest use the same `{{PLUGIN_ID}}.deduplicate` identity.
+Changing an argument means updating its schema, handler type, field and layout
+reference together. Persistent preferences belong in plugin configuration, not
+operation arguments. The current template does not generate types from schemas.
+
+## Behavior and limits
+
+Select one UTF-8 `.txt` file, optionally enable **Ignore case**, and select a new
+output. The handler preserves the first occurrence and spelling of each LF-split
+line; case-insensitive keys use `toLowerCase()`. It does not trim whitespace or
+normalize line endings. Empty segments, including a trailing newline or an empty
+file, count as lines; CRLF preserves `\r`. The host displays the unique line count.
+
+The form is available in the plugin page and for one completed single-file task.
+**Process another copy** preserves options and reauthorizes unchanged input,
+clearing output. Locale changes preserve form values. Electron selects native
+files; Web selects files on the server, not browser-local uploads.
+
+File strings are opaque single-invocation references, never paths. Declaring
+permissions does not grant arbitrary file access. The host limits text input and
+output to 1 MiB, prohibits output overwrite, checks authorization again during
+execution and handles progress, cancellation, temporary files and publication.
+The template requests no FFmpeg, network or unrestricted filesystem capability.
+
+## Try it
+
+- For `Apple\napple\nBanana\nApple` without a trailing newline, expect 3 unique
+  lines with Ignore case off and 2 with it on.
+- Check English/Chinese labels, the collapsible options group, both entry points
+  and repeated execution with a fresh output.
+- An existing destination, stale/changed input or unauthorized reference must be
+  rejected. Never remove host authorization checks to make an example run.
+- Cancel before output publication and wait for cleanup. A tiny input may finish
+  too quickly for manual cancellation; that is not cancellation test evidence.
+
+For current controls, layout/condition rules, file grants, limits and unsupported
+features, read the [SDK operation guide](https://github.com/motrixapp/plugin-sdk/blob/main/docs/operations.md).
+Before these sources are published, read `docs/operations.md` in the matching SDK
+checkout instead. New UI nodes/capabilities need host support; the template does
+not provide custom renderer HTML, JavaScript or CSS.

package/dist/templates/operation/README.zh-CN.md.tpl

@@ -0,0 +1,57 @@
+# {{PROJECT_NAME}}
+
+[English](./README.md) | **简体中文**
+
+为 `{{PLUGIN_ID}}` 生成的文本去重操作项目。
+
+> **协议与模板尚未发布。** 使用包含操作 v1、可组合 UI 和受限文本文件能力的 Motrix 构建及 SDK 包。宿主范围为 `>=2.0.0-beta.48 <3.0.0`，以 beta.48 为首个支持版本目标。beta.47 会被拒绝，包括仍使用该版本号的开发构建。此目标与依赖版本范围不代表已发布支持；若功能晚于 beta.48 发布，须同步提高最低宿主版本。
+
+## 配置匹配的开发依赖
+
+先在匹配的 plugin-sdk 源码仓库执行 `pnpm install --frozen-lockfile` 和 `pnpm build`。如果本项目直接创建在该仓库根目录下，请在**本项目目录**执行：
+
+```sh
+pnpm add -D @motrix/plugin-api@file:../packages/plugin-api @motrix/plugin-cli@file:../packages/plugin-cli
+```
+
+如果项目位于其他位置，将两个 `file:` 路径改为实际构建好的 SDK 包位置。不能用普通安装旧版 npm API/CLI 来代替这一步；源码中的 Schema 会内嵌到 CLI 构建产物中。配套 SDK 正式发布后，再将本地依赖改为实际发布版本；模板目前不指定已发布 SDK 包的最低版本。
+
+## 检查与打包
+
+```sh
+pnpm run typecheck
+pnpm run validate
+pnpm run pack
+pnpm run lint
+```
+
+`pack` 打包 `src/index.ts`，输出未签名的 `dist/{{PLUGIN_ID}}-0.1.0.moext`。`lint` 检查 bundle，因此在 pack 后执行。`pnpm run build` 是可选的单独构建 bundle 步骤。这些命令不签名或发布。通过兼容宿主的正常第三方安装流程安装归档，并检查两项所选文件权限。
+
+## 需要编辑的文件
+
+| 文件 | 作用 |
+|---|---|
+| `motrix-plugin.json` | 私有操作命令、参数和结果 Schema、字段、布局、文件、入口、再次执行策略 |
+| `src/index.ts` | 带类型的沙箱处理函数、取消检查、进度和受限文件调用 |
+| `locales/en-US.json`、`locales/zh-CN.json` | 完整标签、说明、按钮和结果标题 |
+| `tsconfig.json` | 通过安装的 `@motrix/plugin-api` 严格检查，不内嵌 SDK 仓库路径 |
+| `esbuild.config.mjs` | 独立 ES2020 bundle，保持 `motrix:plugin-api` 为 external |
+
+处理函数和清单使用相同的 `{{PLUGIN_ID}}.deduplicate` 身份。修改参数时，同时调整 Schema、处理函数类型、字段和布局引用。长期偏好属于插件配置，不属于操作参数；当前模板不从 Schema 自动生成类型。
+
+## 行为与限制
+
+选择一个 UTF-8 `.txt` 文件，按需启用“忽略大小写”，再选择新的输出。处理函数按 LF 分行，保留每行首次出现的位置和原文，忽略大小写时使用 `toLowerCase()` 比较键。不裁剪空白、不归一化换行；空片段也计为一行，包括末尾换行和空文件产生的片段，CRLF 保留 `\r`。宿主显示去重后的行数。
+
+插件页面及一个已完成的单文件任务菜单均提供入口。“再次处理”保留选项、重新授权未变化输入并清空输出。语言切换保留表单值。Electron 选择原生文件；Web 选择服务器上的文件，不上传浏览器本机文件。
+
+文件字符串是不透明单次调用引用，不是路径；声明权限不授予任意文件访问。宿主将文本输入、输出各限制为 1 MiB，禁止覆盖目标，执行时重新检查授权，并管理进度、取消、临时文件和最终保存。模板不申请 FFmpeg、网络或任意文件系统能力。
+
+## 验证方法
+
+- 使用没有末尾换行的 `Apple\napple\nBanana\nApple`，关闭忽略大小写时应得到 3 行，开启时应得到 2 行。
+- 检查中英文标签、可折叠选项组、两个入口，以及用新输出再次执行。
+- 已有目标、过期或变化的输入、未经授权引用应被拒绝；不能移除宿主授权检查来运行示例。
+- 在保存前取消并等待清理。小文件可能快到无法手工取消，不能将其算作取消验证证据。
+
+控件、布局及条件、文件授权、限制和未支持能力见 [SDK 操作指南](https://github.com/motrixapp/plugin-sdk/blob/main/docs/operations.zh-CN.md)。源码发布前，请改为阅读配套 SDK 仓库中的 `docs/operations.zh-CN.md`。新增 UI 节点或能力需要宿主支持；模板不提供自定义 renderer HTML、JavaScript 或 CSS。

package/dist/templates/operation/esbuild.config.mjs.tpl

@@ -0,0 +1,13 @@
+import { build } from 'esbuild'
+
+await build({
+  entryPoints: ['src/index.ts'],
+  bundle: true,
+  format: 'esm',
+  target: 'es2020',
+  platform: 'neutral',
+  outfile: 'dist/plugin.js',
+  external: ['motrix:plugin-api'],
+  minify: true,
+  treeShaking: true,
+})

package/dist/templates/operation/locales/en-US.json.tpl

@@ -0,0 +1,19 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "description": "Remove duplicate lines from a selected text file and save a new copy.",
+  "deduplicate": "Deduplicate lines",
+  "operationDescription": "Remove duplicate lines while keeping their original order, then save a new UTF-8 file.",
+  "input": "Input file",
+  "inputPlaceholder": "Choose a text file",
+  "inputBrowse": "Choose input file",
+  "output": "Output file",
+  "outputPlaceholder": "Choose a save location",
+  "outputBrowse": "Choose output file",
+  "ignoreCase": "Ignore case",
+  "ignoreCaseHelp": "Treat Apple and apple as the same line.",
+  "matchingOptions": "Matching options",
+  "uniqueLines": "Unique lines",
+  "submit": "Deduplicate",
+  "repeat": "Process another copy",
+  "footer": "Original text stays unchanged."
+}

package/dist/templates/operation/locales/zh-CN.json.tpl

@@ -0,0 +1,19 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "description": "去除所选文本文件中的重复行，并另存为新文件。",
+  "deduplicate": "文本去重",
+  "operationDescription": "去除重复行，保留原有顺序，并另存为 UTF-8 文本文件。",
+  "input": "输入文件",
+  "inputPlaceholder": "选择文本文件",
+  "inputBrowse": "选择输入文件",
+  "output": "输出文件",
+  "outputPlaceholder": "选择保存位置",
+  "outputBrowse": "选择输出文件",
+  "ignoreCase": "忽略大小写",
+  "ignoreCaseHelp": "将 Apple 和 apple 视为同一行。",
+  "matchingOptions": "匹配选项",
+  "uniqueLines": "去重后行数",
+  "submit": "去重",
+  "repeat": "再次处理",
+  "footer": "保留原始文本文件。"
+}

package/dist/templates/operation/motrix-plugin.json.tpl

@@ -0,0 +1,181 @@
+{
+  "manifestVersion": 1,
+  "id": "{{PLUGIN_ID}}",
+  "name": "%name%",
+  "version": "0.1.0",
+  "description": "%description%",
+  "categories": ["post-action"],
+  "engines": {
+    "motrix": ">=2.0.0-beta.48 <3.0.0"
+  },
+  "main": "dist/plugin.js",
+  "permissions": ["files.selected.read", "files.selected.write"],
+  "activationEvents": ["onCommand:{{PLUGIN_ID}}.deduplicate"],
+  "contributes": {
+    "commands": [
+      {
+        "id": "{{PLUGIN_ID}}.deduplicate",
+        "title": "%deduplicate%",
+        "execution": "operation",
+        "public": false,
+        "argsSchema": {
+          "type": "object",
+          "properties": {
+            "input": {
+              "type": "string",
+              "minLength": 36,
+              "maxLength": 36
+            },
+            "output": {
+              "type": "string",
+              "minLength": 36,
+              "maxLength": 36
+            },
+            "ignoreCase": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          "required": ["input", "output", "ignoreCase"],
+          "additionalProperties": false
+        },
+        "resultSchema": {
+          "type": "object",
+          "properties": {
+            "output": {
+              "type": "string",
+              "minLength": 36,
+              "maxLength": 36
+            },
+            "lines": {
+              "type": "integer",
+              "title": "%uniqueLines%",
+              "minimum": 0,
+              "maximum": 1048576
+            }
+          },
+          "required": ["output", "lines"],
+          "additionalProperties": false
+        }
+      }
+    ],
+    "operations": {
+      "version": 1,
+      "items": [
+        {
+          "id": "{{PLUGIN_ID}}.deduplicate",
+          "title": "%deduplicate%",
+          "description": "%operationDescription%",
+          "icon": "document",
+          "command": "{{PLUGIN_ID}}.deduplicate",
+          "requires": ["operations.v1", "operations.ui.v1", "files.text.v1"],
+          "fields": [
+            {
+              "field": "input",
+              "label": "%input%",
+              "appearance": {
+                "icon": "document",
+                "tone": "blue",
+                "drop": true,
+                "placeholder": "%inputPlaceholder%",
+                "browseLabel": "%inputBrowse%"
+              }
+            },
+            {
+              "field": "ignoreCase",
+              "label": "%ignoreCase%",
+              "widget": "switch",
+              "help": "%ignoreCaseHelp%"
+            },
+            {
+              "field": "output",
+              "label": "%output%",
+              "appearance": {
+                "icon": "folder",
+                "tone": "amber",
+                "placeholder": "%outputPlaceholder%",
+                "browseLabel": "%outputBrowse%"
+              }
+            }
+          ],
+          "files": {
+            "input": {
+              "kind": "input-file",
+              "use": "text",
+              "extensions": ["txt"]
+            },
+            "output": {
+              "kind": "output-file",
+              "use": "text",
+              "extensions": ["txt"],
+              "suggestedName": {
+                "stemFrom": "input",
+                "suffix": "-unique"
+              }
+            }
+          },
+          "entries": [
+            {
+              "surface": "plugin-detail"
+            },
+            {
+              "surface": "task-menu",
+              "selection": {
+                "count": {
+                  "min": 1,
+                  "max": 1
+                },
+                "every": {
+                  "status": "completed",
+                  "files": "single",
+                  "local": true
+                }
+              },
+              "bind": {
+                "input": {
+                  "source": "task-file",
+                  "index": 0
+                }
+              }
+            }
+          ],
+          "result": {
+            "fields": ["lines"],
+            "files": ["output"]
+          },
+          "ui": {
+            "layout": {
+              "type": "stack",
+              "children": [
+                {
+                  "type": "field",
+                  "field": "input"
+                },
+                {
+                  "type": "group",
+                  "title": "%matchingOptions%",
+                  "children": [
+                    {
+                      "type": "field",
+                      "field": "ignoreCase"
+                    }
+                  ],
+                  "collapsible": true
+                },
+                {
+                  "type": "field",
+                  "field": "output"
+                }
+              ]
+            },
+            "submitLabel": "%submit%",
+            "repeatLabel": "%repeat%",
+            "footer": "%footer%",
+            "repeat": "preserve-inputs"
+          }
+        }
+      ]
+    }
+  },
+  "l10n": "locales"
+}

package/dist/templates/operation/package.json.tpl

@@ -0,0 +1,23 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "version": "0.1.0",
+  "type": "module",
+  "private": true,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "node esbuild.config.mjs",
+    "typecheck": "tsc --noEmit",
+    "validate": "motrix-plugin validate",
+    "pack": "motrix-plugin pack",
+    "lint": "motrix-plugin lint",
+    "dev": "motrix-plugin dev"
+  },
+  "devDependencies": {
+    "@motrix/plugin-api": "^2.2.0",
+    "@motrix/plugin-cli": "^2.2.0",
+    "esbuild": "^0.28.2",
+    "typescript": "^7.0.2"
+  }
+}

package/dist/templates/operation/src/index.ts.tpl

@@ -0,0 +1,19 @@
+import { commands } from 'motrix:plugin-api'
+
+commands.registerOperation<
+  { input: string; output: string; ignoreCase: boolean },
+  { output: string; lines: number }
+>('{{PLUGIN_ID}}.deduplicate', async (args, context) => {
+  const text = await context.files.readText(args.input)
+  const seen = new Set<string>()
+  const lines = text.split('\n').filter((line) => {
+    context.signal.throwIfAborted()
+    const key = args.ignoreCase ? line.toLowerCase() : line
+    if (seen.has(key)) return false
+    seen.add(key)
+    return true
+  })
+  await context.progress({ phase: 'running', fraction: 0.5 })
+  await context.files.writeText(args.output, lines.join('\n'))
+  return { output: args.output, lines: lines.length }
+})

package/dist/templates/operation/tsconfig.json.tpl

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["ES2022", "DOM"],
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "types": ["@motrix/plugin-api"]
+  },
+  "include": ["src"]
+}

package/dist/templates/post-action/package.json.tpl

@@ -9,9 +9,9 @@
     "dev": "motrix-plugin dev"
   },
   "devDependencies": {
-    "@motrix/plugin-api": "^2.0.0",
-    "@motrix/plugin-cli": "^2.0.0",
-    "esbuild": "^0.24",
-    "typescript": "^5.6"
+    "@motrix/plugin-api": "^2.1.0",
+    "@motrix/plugin-cli": "^2.1.1",
+    "esbuild": "^0.28.2",
+    "typescript": "^7.0.2"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@motrix/plugin-cli",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "type": "module",
   "bin": {
     "motrix-plugin": "dist/bin/motrix-plugin.js",
@@ -18,23 +18,23 @@
     "directory": "packages/plugin-cli"
   },
   "license": "MIT",
-  "scripts": {
-    "build": "tsup",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run"
-  },
   "dependencies": {
-    "chokidar": "^4",
-    "commander": "^12",
-    "esbuild": "^0.24",
-    "yazl": "^2"
+    "chokidar": "^5.0.0",
+    "commander": "^15.0.0",
+    "esbuild": "^0.28.2",
+    "yazl": "^3.3.1"
   },
   "devDependencies": {
-    "@motrix/plugin-manifest-schema": "workspace:*",
+    "@motrix/plugin-manifest-schema": "2.2.0",
     "@types/node": "^24",
-    "tsup": "^8",
-    "typescript": "^5.6",
-    "vitest": "^3",
-    "zod": "^4"
+    "tsup": "^8.5.1",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.11",
+    "zod": "^4.5.4"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
   }
-}
+}