关于 workflow-template-extractor
workflow-template-extractor 是一项将现有项目整理为可复用、可运行模板的技能,适合希望复用成熟项目作为开发起点的团队。它涵盖清理、文档规范、秘密信息移除和验证,并将工作限定为复制与整理,而非重构。
主要功能
- 01复制项目到 templates 目录
- 02移除秘密值并将 ID 替换为环境变量
- 03将品牌内容替换为通用占位符
- 04补齐模板 README、环境示例和元数据
- 05记录安装、dev 和 build 验证
适用场景
- 01将成熟项目用作新项目起点
- 02准备可分享的项目模板
- 03发布基线前移除项目专属内容
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ heyvhuang/ ship-faster --skill workflow-template-extractor安装后在 Claude Code 中输入/workflow-template-extractor确认已加载。
详细介绍
工作流:模板提取器(真实项目 → 模板)
目标:以尽量少的人工清理,将真实项目转化为 templates/ 中可分享、可运行的模板。
此工作流适用于你想作为未来构建基准重复使用的“成熟项目”。
输入(仅传入路径)
source_repo_root:真实项目的路径target_repo_root:Ship Faster 仓库根目录(templates/所在位置)run_dir:runs/template-extractor/active/<run_id>/extract_spec.md:需要保留/移除/通用化的内容(品牌、文案、素材、集成、身份验证门槛)
输出(持久化保存)
03-plans/extract-plan.md05-final/extract-summary.mdtemplates/<NNN>-<slug>/(可运行)
工作流
0)初始化
- 创建
run_dir。 - 确定
<slug>和<NNN>(下一个可用的模板编号)。 - 将
source_repo_root复制到templates/<NNN>-<slug>/(不包含构建产物和缓存)。
1)移除机密信息和品牌元素
必须执行:
- 从所有文件中移除机密值(
.env*、配置、硬编码令牌)。 - 将项目 ID(Stripe 价格 ID、Supabase URL/密钥、Webhook 密钥)替换为环境变量键。
- 将品牌元素(名称/域名/Logo)替换为通用占位符,除非该模板有意保留品牌。
2)规范模板入口文档
必需文件:
README.md(5 分钟内可运行).env.local.example(仅包含键)metadata.json(名称 + 描述)
建议:
- 确保存在
dev、build、start脚本 - 如果仓库以 TS 为主,且缺少 lint/类型检查/格式化工具,则添加最精简的防护措施(避免繁重的治理流程)
3)验证
在 05-final/extract-summary.md 中记录:
- 安装正常
dev可以启动build成功(如果缺少凭据导致无法构建,请清楚说明原因)
约束
- 切勿提交机密值。
- 提取应当是“复制 + 清理”,而不是重构项目。
评论
支持 Markdown