create-linkdesk-plugin 0.1.13 → 0.1.14

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.14",
   "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/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";