@xiangxinwomenziji/fe-be-contract
v2.0.1
Published
Enforce strict, contract-first front-end / back-end integration discipline. 4-mode state machine + boundary hooks + requirement lifecycle.
Maintainers
Readme
fe-be-contract
English | 中文文档
一个用于 Claude Code 的插件,强制执行严格的、契约优先的前后端集成规范。它不生成代码 —— 它让 Claude 始终处于项目边界的正确一侧。
前提条件
需要安装 Claude Code ≥ 2.x 且在 PATH 中(用 which claude / where claude 验证)。
快速开始
npm install -g @xiangxinwomenziji/fe-be-contract
fb install # 注册插件(user 范围)
cd <your-project>
fb init # 在项目中创建 .fe-be/
# 在 Claude Code 中:
/fb-fe # 切换到 frontend-dev 模式从 1.0.x 升级
v1.1.1 将 dist/ 纳入 npm 包(regression fix:v1.1.0 因 dist/ 被 .npmignore 排除,会发布一个损坏的 fb),并保持插件版本与 marketplace manifest 同步。v1.1.0 引入的官方 marketplace 安装路径继续生效。
BREAKING CHANGES:
- 不再创建
~/.claude/plugins/fe-be-contractsymlink ${CLAUDE_PLUGIN_ROOT}改为指向~/.claude/plugins/marketplaces/xiangxinwomenziji-plugins/fb update不再调用npm update -g(插件运行时用claude plugin update,fbCLI 自身用npm update -g @xiangxinwomenziji/fe-be-contract)
迁移步骤:
- 更新
fbCLI:npm update -g @xiangxinwomenziji/fe-be-contract - 运行
fb install—— 自动检测并清理 v1.0.0 symlink,走官方 install - 验证:
claude plugin list显示fe-be-contract@xiangxinwomenziji-plugins
4 种模式
| 模式 | 命令 | 你写的内容 | 边界 |
|---|---|---|---|
| contract-design | /fb-cd | OpenAPI 契约 | 可读全部;只写契约 |
| backend-impl | /fb-be | 后端代码 | 读契约+后端;写后端;契约写入会告警 |
| frontend-dev | /fb-fe | 前端代码 | 读契约+前端;写前端;绝不碰后端 |
| integration-verify | /fb-verify | 不写 | 只读 |
文件结构
fe-be-contract/包位于~/.npm-global/lib/node_modules/@xiangxinwomenziji/fe-be-contract/fb install调用claude plugin install fe-be-contract@xiangxinwomenziji-plugins(Claude Code 官方)- 项目配置:
.fe-be/config.yaml(git 跟踪),.fe-be/mode/(gitignore),.fe-be/audit.log(gitignore) - 需求文件:
api-requirements/FRONT-NNN-<slug>.md
平台支持
- Linux / macOS: 完整支持
- Windows: 通过
fb.cmd完整支持(由 npm 自动生成) - Windows PowerShell (5.1): 可用;CJK 字符的 slug 需要
--slug选项
文档
许可证
MIT
