Zhin Plugin Refactoring

What it does

When your agent uses it

• Asked to reorganize plugin files
• Migrate a messy plugin to standard layout
• Reduce coupling
• Clean lifecycle logic

Example prompts

• “/zhin-plugin-refactoring”

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

1. 1配置与 Schema
2. 2模型定义
3. 3数据访问与共享服务
4. 4命令与中间件
5. 5事件、定时任务、AI 工具
6. 6HTTP Host 与 Console 页面入口

What it can do on your machine

Read from SKILL.md and the folder at commit fd5029a. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Shell commands in SKILL.md call:

  • pnpm

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Zhin Plugin Refactoring loads about 1.1k tokens when it runs, and up to ~2.2k if it reads all its reference files. Until then it costs about 85 tokens; SKILL.md has 245 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~85

When it runs · the whole SKILL.md, loaded when a task matches

~1.1k

With references · SKILL.md plus every file in references/, read only if the agent opens them

~2.2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from zhinjs/zhin at commit fd5029a, republished under its MIT licence (© zhinjs). 245 words, ~1,140 tokens.

name

zhin-plugin-refactoring

description

Refactor existing Zhin.js plugins into a cleaner standard structure. Use when asked to reorganize plugin files, split commands or services, migrate a messy plugin to standard layout, reduce coupling, clean lifecycle logic, or standardize plugin structure without changing behavior. 适用于已有 Zhin 插件重构、结构整理、职责拆分与标准化迁移。

argument-hint

Describe the plugin to refactor, current problems such as mixed responsibilities or duplicated logic, and the target outcome such as split modules, cleaner…

user-invocable

true

pnpm --filter <pkg> build
pnpm --filter <pkg> test
pnpm check:plugin-capability-publish
pnpm check:agent-tool-authoring-boundaries
pnpm check:skill-authoring-boundaries
pnpm check:agent-authoring-boundaries
pnpm check:hook-authoring-boundaries
# 手测：Sandbox 或 test-bot 触发原命令 / 访问原控制台路由

## 重构验证
- [ ] build 通过
- [ ] test 通过
- [ ] 命令 A：通过 / 未测
- [ ] 路由/页面 B：通过 / 未测
- 回滚风险：（仅列未覆盖路径）

© zhinjs, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 4 other files (references, assets) in .github/skills/zhin-plugin-refactoring of zhinjs/zhin.

• SKILL.md
• assets/refactor-target-layout.md
• references/refactor-before-after-example.md
• references/refactor-decision-guide.md
• references/refactor-migration-checklist.md

Open the folder on GitHubat commit fd5029a