create-linkdesk-plugin 0.1.13 → 0.1.15

package/README.md

@@ -30,7 +30,7 @@ my-cool-plugin/
 ├── .github/workflows/ci.yml   # CI that runs `npm run verify` on every push
 ├── scripts/ci-verify.mjs      # the strict tier CI runs (lint + tests + declaration self-checks)
 ├── vitest.config.ts      # test config (jsdom + globals; @linkdesk/ui is inlined so its CSS import resolves)
-├── vitest.setup.ts       # test runtime ground — mocks window.linkdesk (no Electron preload under vitest)
+├── vitest.setup.ts       # one-line pointer to the shared test ground in @linkdesk/plugin-sdk (the window.linkdesk mock)
 ├── .vscode/settings.json      # plugin.json is treated as jsonc (comments do not light up red)
 ├── resources/
 │   └── icon.svg          # placeholder icon — replace it with your own

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-linkdesk-plugin",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "description": "LinkDesk 插件脚手架——`npm create linkdesk-plugin@latest my-cool-plugin` 一行生成你的第一个插件项目（对标 yo code）。",
   "type": "module",
   "bin": {

package/template/AGENTS.md

@@ -47,6 +47,15 @@ npm run publish    # ⑧ publish to your own GitHub repo (first step of listing)
 - **This project is its own git repo** (the scaffold ran `git init -b main` plus one initial commit). `publish` uses `origin` to create the Release ⇒ pushing to GitHub is just two commands: `git remote add origin <your repo>` + `git push -u origin main`.
 - **Keep the version numbers in step**: `plugin.json`'s `version` and `package.json`'s `version` **must match**; and every bump needs a matching `## v<new version>（YYYY-MM-DD）` section in `CHANGELOG.md`, or the plugin's detail page will show "no changelog provided for this version".
 
+## 6. Tests in this repo
+
+- **The toolchain is preinstalled** (`vitest` / `jsdom` / `@testing-library/react` are already declared) — write a `*.test.ts` file and run `npm run test`.
+- **The shared test ground comes from the SDK**: the minimal `window.linkdesk` mock lives in `@linkdesk/plugin-sdk/vitest-setup`, and this repo's `vitest.setup.ts` is a **one-line pointer** to it. **Do not paste a second copy in here** — a copied mock drifts from the shared one and nothing would notice.
+- **Pure logic should be tested**: a `src/**/*.ts` unit that touches neither React nor `window.linkdesk` should get a `src/__tests__/<same name>.test.ts`. Views and hooks are worth testing **when it pays off** — nothing measures that today.
+- **Plugin-specific stubs stay in your own test files**: if your code calls something the shared mock does not cover (say `window.linkdesk.serial`), set that stub up with `vi.fn()` in the test. Do not ask the shared mock to grow a branch for your plugin.
+- **Declarative plugins** (pure JSON / themes / language packs) have **no testable units** — their gate is the structure and declaration checks in `npm run verify`. "It has no tests" is not a defect there.
+- **Older projects can migrate whenever they like**: replacing the full mock body with the one-line pointer plus one `npm install` is the whole move (upside: mock upgrades then ride along with the SDK).
+
 ---
 
 > Author: {{author}} ｜ Generated: {{date}}

package/template/README.md

@@ -26,7 +26,7 @@ You do not need to pre-create empty folders (git does not track them). **Create
 | `src/components/` | Components reused inside this plugin | When needed |
 | `src/services/` | Domain logic / IPC wrappers / data layer | When needed |
 | `src/styles/` | **Multiple** CSS files — keep them together here (a single file next to the entry is fine too) | When needed |
-| `src/__tests__/` | Unit tests — **test tooling is preinstalled** (`vitest` / `jsdom` / `@testing-library/react` are already in `devDependencies`); write tests and run `npm run test` | When needed |
+| `src/__tests__/` | Unit tests — **test tooling is preinstalled** (`vitest` / `jsdom` / `@testing-library/react` are already in `devDependencies`); the `window.linkdesk` mock is **not** in this repo — `vitest.setup.ts` is a one-line pointer to the shared ground in `@linkdesk/plugin-sdk`, so just write tests and run `npm run test` | When needed |
 
 > 🔴 **Shared things do not belong here** — components/hooks reused across plugins come from `@linkdesk/ui` (the public package the shell provides; it is already declared in `package.json` as `"latest"`, which resolves to the shell's current version line when you install — pin it to a specific shell version if you need a floor). The shell supplies that one instance at runtime, so **do not import its css** and **do not write a second copy inside your plugin**. Only logic that belongs to this plugin stays local.
 > 🔴 **Assets always live in `resources/` — no loose images in the plugin root.** What gets into the install package is what is **referenced by the README** or **declared by `icon` / `marketIcon`**; the directory name itself has no magic.

package/template/scripts/ci-verify.mjs

@@ -7,7 +7,7 @@
  * 搬走的一共六类检查：编译图 / eslint（含 linkdesk/* 自定义规则）/ vitest / 体量 / i18n / 主题审计。
  * 本脚本 + ci.yml + vitest 配置 = 给插件仓装回来的那一份，否则「独立」就是拿「质量真空」换的。
  *
- * ── 五段（每段独立判红；**没有对象也要说话**，不许静默绿）──
+ * ── 六段（每段独立判红；**没有对象也要说话**，不许静默绿）──
  *   ① lint 严格腿   —— `@linkdesk/plugin-sdk` 的 eslint 规则腿 + css/font-scale/spacing 三条扫描腿。
  *                     🔴 SDK 的 `npm run lint` 是 **WARN 级、永不 fail**（三档制：警告不是封锁，
  *                     作者本地不被拦——那是刻意的）。CI 要的是**拦截**，所以本段把同一份报告按
@@ -29,6 +29,12 @@
  *                     而包内相对路径（`resources/icon.svg`）在未装态恒 404（`linkdesk://` 只在本地已装的
  *                     插件根里找文件）。`publish` 会自动 URL 化；本段是那条纪律的机械兜底——
  *                     它看不见「谁是图标栏插件」（不看插件类型，只看字段形态，硬约束 10 零 ID 知识）。
+ *   ⑥ 测试覆盖      —— 结构判据（2026-09-26 用户拍板升拦）：**纯逻辑单元**（`src` 下任意深度的 `.ts`
+ *                     去 `.d.ts`/测试/barrel/`use*`/含 `window.linkdesk` 或 React）应有测试，命中 =
+ *                     **同名测试文件 ∨ 被任一测试文件引用**——与官方覆盖尺**同一份实现**
+ *                     （`@linkdesk/plugin-sdk/test-audit`，⛔ 别复制判据）。🔴 零测报出 ≠ 判死：
+ *                     同名判据看不见跨文件覆盖（一跳传递假红实测过）⇒ 先核覆盖再补测，别写无意义测试凑数。
+ *                     百分比不上门禁（覆盖口径已定稿为结构判据）；声明式/零逻辑仓按据豁免（无硬编码白名单）。
  *
  * ── 为什么 ③ 的覆盖度只能黄灯（不是漏做）──
  * `t()` 的 key 可以合法地住在**应用级字典**里（`lang-defaults` 插件，运行时由它经 LanguageRegistry
@@ -37,13 +43,14 @@
  * 同款理由）。所以：字典**文件本身**的问题判红（③ 上半），**跨仓才能回答**的覆盖度只报告。
  *
  * 用法：node scripts/ci-verify.mjs     （工程根 = cwd）
- * 退出码 0 = 五段全过；1 = 有红灯（逐条打印缺什么）
+ * 退出码 0 = 六段全过；1 = 有红灯（逐条打印缺什么）
  */
 import { existsSync, readFileSync, readdirSync } from "node:fs";
 import { basename, dirname, join, relative, resolve, sep } from "node:path";
 import { parse as parseJsonc, printParseErrorCode } from "jsonc-parser";
 import { runPluginLint, renderPluginLintReport } from "@linkdesk/plugin-sdk/eslint";
 import { validateThemeJson, validateIconThemeJson } from "@linkdesk/plugin-sdk";
+import { analyzeRepo } from "@linkdesk/plugin-sdk/test-audit";
 
 const ROOT = process.cwd();
 const failures = [];
@@ -541,6 +548,24 @@ if (!manifest) {
   }
 }
 
+// ═══════════════ ⑥ 测试覆盖（结构判据——2026-09-26 用户拍板升拦）═══════════════
+// 审计核心与官方覆盖尺**同一份实现**（@linkdesk/plugin-sdk/test-audit 单一真源）——⛔ 别在这里复制判据。
+const audit = analyzeRepo(ROOT, { official: true });
+if (audit.kind === "exempt") {
+  line(`⏭ ⑥ 测试覆盖：${audit.exempt}`);
+} else if (audit.zeroTest.length > 0) {
+  fail(
+    `⑥ 测试覆盖：${audit.zeroTest.length} 个纯逻辑单元零测试（判据 = 同名测试文件 ∨ 被任一测试文件引用）：\n` +
+      audit.zeroTest.map((z) => `       src/${z.unit}.ts（${z.evidence.join(" + ")}）`).join("\n") +
+      `\n     ⚠️ 零测 = 待裁决不是判死——同名判据看不见跨文件覆盖，先核这些单元是否已被别的测试` +
+      `间接覆盖，再补测（替身照契约不照实现；夹具不用真插件名/真文案；⛔ 不写无断言测试凑数）。`,
+  );
+} else {
+  line(
+    `✅ ⑥ 测试覆盖：纯逻辑单元 ${audit.logicUnits} 个全部有测试（宽口径 ${audit.wideUnits}，命中 = 同名 ∨ 被引用）。`,
+  );
+}
+
 // ═══════════════ 结论 ═══════════════
 line("────────────────────────────────────────────────────────────");
 if (failures.length > 0) {
@@ -550,5 +575,5 @@ if (failures.length > 0) {
   console.error(`  eslint-disable 注释 + 理由（见上面报告尾部），别把检查删了。`);
   process.exitCode = 1;
 } else {
-  console.log(`✅ 插件仓自检全过（${pluginId}）——lint / 跨插件 / 字典 / 声明自洽 / 目录条目形态五段。`);
+  console.log(`✅ 插件仓自检全过（${pluginId}）——lint / 跨插件 / 字典 / 声明自洽 / 目录条目形态 / 测试覆盖六段。`);
 }

package/template/vitest.setup.ts

@@ -1,96 +1,3 @@
-/**
- * vitest setup——mock window.linkdesk API。
- * 测试跑在 Node.js/jsdom，没有 Electron preload 注入的 window.linkdesk。
- * 迁移到 linkdesk.* API 后，插件代码直接依赖它——测试环境需提供最小 mock。
- *
- * 🔴 **本文件是壳仓 `vitest.setup.ts` 的逐字副本**（除本头注五条）。
- *   它不是「配置」，是插件测试的**运行时地基**——下半部的六个命名空间与 `__ldkConfigStore`
- *   少了任何一个，凡碰 `window.linkdesk` 的测试都会报错、或更糟：静默走错分支。
- *   改壳仓那份时把这里一起改（两处同源）。「由 @linkdesk/plugin-sdk 提供共享版本、
- *   本文件改成一行 re-export」是可预见的收敛方向——那时这五条注记一并删掉。
- */
-
-// path 纯函数——直接实现，不走 IPC
-const pathMock = {
-  normalize: (p: string) => p.replace(/\\/g, "/"),
-  join: (...parts: string[]) =>
-    parts.map((p) => String(p).replace(/\\/g, "/")).join("/").replace(/\/+/g, "/"),
-  basename: (p: string) => {
-    const s = p.replace(/\\/g, "/").split("/");
-    return s[s.length - 1] || "";
-  },
-  dirname: (p: string) => {
-    const s = p.replace(/\\/g, "/").split("/");
-    s.pop();
-    return s.join("/") || ".";
-  },
-  extname: (p: string) => {
-    const b = p.replace(/\\/g, "/").split("/").pop() || "";
-    const i = b.lastIndexOf(".");
-    return i > 0 ? b.slice(i) : "";
-  },
-};
-
-// 测试全局窄类型 cast——替代 (globalThis as any)（__ldkConfigStore 由本文件声明、测试文件消费）
-type TestGlobal = { window?: Window; __ldkConfigStore?: Map<string, unknown> };
-const _g = globalThis as TestGlobal;
-
-// configuration——默认返回 null，测试中按需 mock。
-// __ldkConfigStore 暴露给测试——测试可直接设置值控制 get() 返回。
-const _configStore = (_g.__ldkConfigStore = new Map<string, unknown>());
-const configurationMock = {
-  get: async (key: string) => _configStore.get(key) ?? null,
-  set: async (key: string, v: unknown) => { _configStore.set(key, v); },
-  onChange: (_key: string, _cb: (v: unknown) => void) => {
-    return () => {}; // no-op unsubscribe
-  },
-};
-
-// workspace——默认返回空工作区
-const workspaceMock = {
-  getFolders: async () => [] as { uri: string; name: string }[],
-  getActive: async () => undefined as string | undefined,
-};
-
-// filesystem——可替换的最小 stub。测试可覆盖 lk.filesystem.xxx = vi.fn() 按需定制
-const filesystemMock = {
-  readTextFile: async (_p: string) => "",
-  writeTextFile: async (_p: string, _d: string) => {},
-  readBinaryFile: async (_p: string) => new Uint8Array(),
-  writeBinaryFile: async (_p: string, _d: Uint8Array) => {},
-  listDir: async (_p: string) => [] as { path: string; name: string; isDirectory: boolean; isFile: boolean }[],
-  exists: async (_p: string) => false,
-  mkdir: async (_p: string) => {},
-  copy: async (_src: string, _dest: string) => {},
-  remove: async (_p: string) => {},
-  watch: async (_dirPath: string, _onEvent: (e: unknown) => void) => {
-    return () => {}; // unsubscribe
-  },
-};
-
-// tabs——最小 stub
-const tabsMock = {
-  create: async (_type: string, _opts?: Record<string, unknown>) => "tab-1",
-  openOrFocus: async (_type: string, _opts?: Record<string, unknown>) => "tab-1",
-  focus: async (_tabId: string) => {},
-  close: async (_tabId: string) => {},
-  focusBySourceId: async (_sourceId: string) => {},
-  updateLabelBySourceId: async (_sourceId: string, _label: string) => {},
-  closeBySourceId: async (_sourceId: string) => {},
-};
-
-// 最小 mock——故意不满足 LinkDeskAPI 全契约（测试按需覆盖），经 linkdesk?: object 窄口赋值
-_g.window = _g.window ?? ({} as Window);
-(_g.window as Window & { linkdesk?: object }).linkdesk = {
-  path: pathMock,
-  configuration: configurationMock,
-  config: configurationMock,
-  workspace: workspaceMock,
-  filesystem: filesystemMock,
-  tabs: tabsMock,
-  // event stubs
-  events: {
-    on: () => () => {},
-    emit: () => {},
-  },
-};
+// Shared test ground: the minimal `window.linkdesk` mock ships with the SDK (`@linkdesk/plugin-sdk/vitest-setup`).
+// One line on purpose — plugin-specific stubs belong in your own test files (`vi.fn()`), not in here.
+import "@linkdesk/plugin-sdk/vitest-setup";