@dsh-workbench/module-hello 0.3.11 → 1.0.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 更新日志
+
+## v0.3.11
+
+`2026-10-23`
+
+### ✨ 新增
+
+- 最小示例模块：装上面板里多一张卡片，用来试装试卸

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dsh-workbench contributors
+
+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 @@
+# @dsh-workbench/module-hello
+
+工作台里**最小的可安装模块**：装上面板多一张卡片，卸掉就没了。它同时是模块包的样板 ——
+两个面各注册一次、卡片只有一个标题、没有工具、没有数据源，别的一概不掺。
+
+拿来试装试卸最省事；想知道一个模块**必须**有什么，看它的文件比看文档快。
+
+## 装
+
+```bash
+# 装进工作台的 profile（实例名按你自己的来，默认 workbench）
+dsh plugin --profile workbench add @dsh-workbench/module-hello
+```
+
+也可以在 `:3081` 的「工作台模块市场」里找到它装。装完右栏多一张「示例模块」卡片，
+标题下两行字，刷新按钮接好了但没有数据源 —— 按了只会重画。
+
+卸掉：市场里卸，或 `dsh plugin --profile workbench remove @dsh-workbench/module-hello`。
+
+## 它演示了什么
+
+| 东西 | 在哪 | 说明 |
+|---|---|---|
+| 模块声明 | `package.json` 的 `dsh.workbench` | `apiVersion: 1`、单元 id `hello`、一张卡、零工具、不注入外壳服务 |
+| 宿主面 | `src/host.ts` | 把 `{ unit: 'hello', mount }` 注册进外壳的 `workbenchUnits`；`routes` 空、`registerTools` 空 |
+| 浏览器面 | `src/client.tsx` | 把 `{ unit, messages, card }` 注册进外壳；卡片用 kit 的 `Card` |
+| 文案 | `src/messages.ts` | zh / en 两份字典，键名以前缀分域 |
+| 接线 | `cordis.patch.yml` | 把自己插进 profile 的组合图 |
+| 测试 | `src/plugin.test.ts` | 断言插件名、注入面、两个面各注册一次 |
+
+两个面都只 `inject: ['workbenchUnits']` —— 外壳交出来的那个服务。宿主侧拿不到服务时打一条
+warn 就退，不会把整个 entry 拖挂。
+
+## 文件
+
+```text
+src/
+  host.ts        宿主面：注册单元
+  client.tsx     浏览器面：注册卡片
+  messages.ts    文案（zh / en）
+  plugin.test.ts 两个面的注册测试
+scripts/smoke.mjs  构建后冒烟：产物能 require、导出齐全
+cordis.patch.yml   把自己插进 profile 组合图
+arch.config.mjs    一行：moduleArch()
+eslint.config.mjs  两行：moduleLint()
+client.js / dist/  构建产物（不进 git，但必须进 npm 包）
+```
+
+## 开发与门禁
+
+```bash
+pnpm install
+pnpm build     # dist/host.js + client.js
+pnpm test      # 单元测试
+pnpm check     # 十三条模块判据（契约 / 产物边界 / 源码边界 / 卡片渲染 / arch / lint …）
+pnpm selfcheck # build + 产物冒烟
+```
+
+改了想马上看效果：重新 `pnpm build` 后刷新页面；宿主侧热换，不用重装。
+
+## 想造自己的模块
+
+别从这份抄起，跑工具链：
+
+```bash
+pnpm exec dsh-wb-module init my-unit --template diy
+```
+
+`diy` 模板有真数据源、五态卡片和填好的设计底稿。完整流程见
+[模块 DIY 指引](../core/skills/workbench-module-diy/SKILL.md)，
+判据与工具见 [module-tools](../module-tools/README.md)。
+
+## 相关文档
+
+| 想了解 | 读 |
+|---|---|
+| 模块怎么写、怎么装、怎么验收 | [DIY 指引](../core/skills/workbench-module-diy/SKILL.md) |
+| 构建、接线、注册的细节 | [BUILD.md](../core/skills/workbench-module-diy/BUILD.md) · [WIRING.md](../core/skills/workbench-module-diy/WIRING.md) |
+| 十三条判据、模板、设计底稿 | [module-tools](../module-tools/README.md) |
+| 契约类型与共享组件 | [shared](../shared/README.md) |

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@dsh-workbench/module-hello",
-  "version": "0.3.11",
+  "version": "1.0.0-beta.1",
   "description": "最小示例模块：装上后面板里多一张卡片，用来试装试卸。",
   "type": "module",
   "exports": {
     ".": "./dist/host.js",
     "./client": "./client.js"
   },
-  "//files": "和外壳同一条纪律：client.js 与 dist/ 是构建产物，npm 的兜底是 .gitignore，不显式列出就会漏。",
   "files": [
     "dist",
     "client.js",
-    "cordis.patch.yml"
+    "cordis.patch.yml",
+    "CHANGELOG.md"
   ],
   "dsh": {
     "bundle": {
@@ -27,7 +27,7 @@
       ]
     },
     "workbench": {
-      "apiVersion": 1,
+      "apiVersion": 2,
       "unit": "hello",
       "card": {
         "titleKey": "hello.cardTitle",
@@ -59,18 +59,29 @@
     "react": "^19.3.0",
     "typescript": "5.9",
     "vitest": "^5.0.2",
-    "@dsh-workbench/core": "0.3.11",
-    "@dsh-workbench/module-tools": "0.3.11"
+    "@dsh-workbench/core": "1.0.0-beta.1",
+    "@dsh-workbench/module-tools": "1.0.0-beta.1"
   },
   "publishConfig": {
     "access": "public"
   },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/novaeth/dsh-workbench.git",
+    "directory": "packages/module-hello"
+  },
+  "homepage": "https://github.com/novaeth/dsh-workbench#readme",
+  "bugs": {
+    "url": "https://github.com/novaeth/dsh-workbench/issues"
+  },
   "scripts": {
     "build": "dsh-wb-module build",
     "typecheck": "tsc --noEmit",
     "selfcheck": "dsh-wb-module build && node scripts/smoke.mjs",
     "test": "vitest run",
     "check": "dsh-wb-module check",
+    "arch": "node ../module-tools/bin/dsh-wb-module.mjs check --only arch",
     "lint": "dsh-wb-module lint"
   }
 }