dsh-plugin-toolkit 0.13.0 → 0.13.1

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.13.1
+
+- **A badge you can put on a plugin that passes.** `docs/badge.svg` plus the
+  snippet in both READMEs. It is a claim, not a decoration: the README says to
+  add it only when `verify` exits 0.
+- **Every scaffolded plugin links back.** `init` now writes the badge into the
+  generated README, so a plugin created with the toolkit advertises the toolkit
+  it was checked with.
+- **README badges** for version, downloads, CI and license, and the repository
+  homepage now points at the npm page.
+
 ## 0.13.0
 
 Three more rounds of the panel, and one new thing to point it at.

package/README.md

@@ -1,5 +1,11 @@
 # dsh-plugin-toolkit
 
+[![npm](https://img.shields.io/npm/v/dsh-plugin-toolkit)](https://www.npmjs.com/package/dsh-plugin-toolkit)
+[![downloads](https://img.shields.io/npm/dw/dsh-plugin-toolkit)](https://www.npmjs.com/package/dsh-plugin-toolkit)
+[![CI](https://github.com/WJDdidi-1/dsh-plugin-toolkit/actions/workflows/ci.yml/badge.svg)](https://github.com/WJDdidi-1/dsh-plugin-toolkit/actions/workflows/ci.yml)
+[![license](https://img.shields.io/npm/l/dsh-plugin-toolkit)](LICENSE)
+
+
 ![dsh-plugin-toolkit](docs/card.png)
 
 English · [中文](./README.zh.md)
@@ -210,6 +216,16 @@ $ npx dsh-plugin mount ../ai-context-doctor/plugin/client.js
 AIignore No workspace yet Could not read the report …
 ```
 
+## Put the badge on a plugin that passes
+
+If `verify` passes on your plugin, this badge says so and links back here:
+
+```md
+[![checked with dsh-plugin-toolkit](https://raw.githubusercontent.com/WJDdidi-1/dsh-plugin-toolkit/main/docs/badge.svg)](https://github.com/WJDdidi-1/dsh-plugin-toolkit)
+```
+
+It is a claim, not a decoration: add it only when `dsh-plugin verify .` exits 0.
+
 ## Start from the example
 
 [`dsh-plugin-example`](https://github.com/WJDdidi-1/dsh-plugin-example) is a ~70-line plugin: one sidebar tab, two languages, one behaviour test, CI that runs `verify` through the composite action. It is the shape this toolkit expects, so it is also the fastest way to see whether the toolkit fits your plugin. It is a GitHub template too: **Use this template** starts you on a plugin whose first publish already passes.

package/README.zh.md

@@ -36,6 +36,16 @@ npx dsh-plugin-toolkit@latest release --pr --merge              # 打 tag、等
 - Node.js 18 或更新（CI 在 18/20/22 × ubuntu/macos/windows 上跑）。
 - 要发布时需要一个能写 `market/index.json` 的仓库和 `gh`（已登录）。
 
+## 通过检查就挂个徽章
+
+`verify` 过了，可以用这个徽章，点回这里：
+
+```md
+[![checked with dsh-plugin-toolkit](https://raw.githubusercontent.com/WJDdidi-1/dsh-plugin-toolkit/main/docs/badge.svg)](https://github.com/WJDdidi-1/dsh-plugin-toolkit)
+```
+
+这是声明不是装饰：`dsh-plugin verify .` 退出码为 0 才挂。
+
 ## 从一个已经能通过检查的插件开始
 
 ```sh

package/docs/badge.svg

@@ -0,0 +1,19 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="196" height="20" role="img" aria-label="dsh plugin: verify passed">
+  <title>dsh plugin: verify passed</title>
+  <linearGradient id="s" x2="0" y2="100%">
+    <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+    <stop offset="1" stop-opacity=".1"/>
+  </linearGradient>
+  <clipPath id="r"><rect width="196" height="20" rx="3" fill="#fff"/></clipPath>
+  <g clip-path="url(#r)">
+    <rect width="82" height="20" fill="#2f3542"/>
+    <rect x="82" width="114" height="20" fill="#1a7f37"/>
+    <rect width="196" height="20" fill="url(#s)"/>
+  </g>
+  <g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" font-size="11">
+    <text x="41" y="15" fill="#010101" fill-opacity=".3">dsh plugin</text>
+    <text x="41" y="14">dsh plugin</text>
+    <text x="139" y="15" fill="#010101" fill-opacity=".3">✓ verify passed</text>
+    <text x="139" y="14">✓ verify passed</text>
+  </g>
+</svg>

package/lib/init.mjs

@@ -150,7 +150,7 @@ export function files({ name, title = 'My panel', version = '0.1.0' }) {
     'index.js': `export const name = '${name}';\n\n// The host half runs in Node. Most panels need nothing here.\nexport function apply() {}\n`,
     'client.js': client({ name, title }),
     'test/panel.test.mjs': test({ name, title }),
-    'README.md': `# ${slug}\n\n${title} — a panel for DeepSeek Harness.\n\n## Requirements\n\n| What | Version | Why |\n| --- | --- | --- |\n| DeepSeek Harness | >= 0.2.0 | provides \`sidebarRightTabs\` |\n| Node | >= 18 | the host half |\n\n## Develop\n\n\`\`\`sh\nnpm install\nnpm test            # mounts client.js in Node\nnpm run doctor      # checks the manifest before you publish\n\`\`\`\n\n## Install\n\n\`\`\`sh\ndsh plugin add ${name}\n\`\`\`\n`,
+    'README.md': `# ${slug}\n\n${title} — a panel for DeepSeek Harness.\n\n[![checked with dsh-plugin-toolkit](https://raw.githubusercontent.com/WJDdidi-1/dsh-plugin-toolkit/main/docs/badge.svg)](https://github.com/WJDdidi-1/dsh-plugin-toolkit)\n\n## Requirements\n\n| What | Version | Why |\n| --- | --- | --- |\n| DeepSeek Harness | >= 0.2.0 | provides \`sidebarRightTabs\` |\n| Node | >= 18 | the host half |\n\n## Develop\n\n\`\`\`sh\nnpm install\nnpm test            # mounts client.js in Node\nnpm run doctor      # checks the manifest before you publish\n\`\`\`\n\n## Install\n\n\`\`\`sh\ndsh plugin add ${name}\n\`\`\`\n`,
     '.gitignore': 'node_modules/\n',
     '.github/workflows/ci.yml': `name: ci\n\non:\n  push:\n    branches: [main]\n  pull_request:\n\njobs:\n  test:\n    runs-on: ubuntu-latest\n    strategy:\n      matrix:\n        node: [18, 20, 22]\n    steps:\n      - uses: actions/checkout@v4\n      - uses: actions/setup-node@v4\n        with:\n          node-version: \${{ matrix.node }}\n      - run: npm install\n      - run: npm test\n      # verify, not doctor: doctor reads the working copy, so a \`files\` list\n      # that forgets client.js passes it and the installed plugin has no panel.\n      - uses: WJDdidi-1/dsh-plugin-toolkit@v1\n        with:\n          dir: .\n          version: ${VERSION}\n`,
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-plugin-toolkit",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "description": "Preflight, release and test DeepSeek Harness plugins: check a folder or any GitHub repository, wait for npm to actually serve the version, and keep the market index honest.",
   "type": "module",
   "bin": {
@@ -21,7 +21,8 @@
     "README.md",
     "README.zh.md",
     "LICENSE",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "docs/badge.svg"
   ],
   "engines": {
     "node": ">=18",