用途
environment-bootstrap 用于开发环境的搭建与维护,目标是让每次会话都从一个已知可用的环境开始。它通过创建和维护 init 脚本,把环境准备过程标准化,减少因环境不一致导致的问题。
主要能力
- 创建并维护 init 脚本,标准位置为
scripts/init.sh。 - 检查前置条件:如 node、pnpm、git、gh 等命令是否存在,并校验 Node 版本(示例要求 18+)以及 gh 认证状态。
- 安装依赖:示例使用
pnpm install --frozen-lockfile --silent。 - 环境变量配置:若缺少
.env且存在.env.example,则复制生成.env并提示检查更新。 - 构建项目:示例使用
pnpm build --silent。 - 运行测试:示例使用
pnpm test --silent,失败则退出。 - 启动开发服务:若存在
docker-compose.yml或docker-compose.yaml,执行docker-compose up -d,并检查 postgres、redis 等服务是否就绪。 - 可选启动开发服务器:通过
START_DEV_SERVER=true控制,启动后执行健康检查(优先 IPv6[::1],回退 IPv4127.0.0.1)。 - 提供冒烟测试脚本示例,验证构建、测试、开发服务器、健康检查与基础流程。
- 提供环境文档模板(README 中的开发设置、环境变量说明)与故障排查、重置环境清单。
使用方式
- 首次克隆仓库时创建 init 脚本,标准位置为
scripts/init.sh。 - 赋予可执行权限:
chmod +x scripts/init.sh。 - 标准运行:
./scripts/init.sh。 - 需要同时启动开发服务器时:
START_DEV_SERVER=true ./scripts/init.sh。 - 拉取变更后重新运行:
git pull origin main后执行./scripts/init.sh。 - 环境疑似损坏时运行 init 脚本进行重置。
技能在开始时声明:"I'm using environment-bootstrap to set up the development environment."
适用场景
- 首次克隆仓库,需要创建 init 脚本。
- 开始新会话,需要运行 init 脚本。
- 拉取变更后依赖发生变化,需要重新运行 init。
- 环境疑似损坏,需要运行 init 重置。
- 需要冒烟测试验证基本功能。
- 需要编写或更新环境文档。
限制与注意事项
- 资料中未提供该技能的收费、价格、平台支持范围等信息。
- 示例脚本中的命令(如 pnpm、docker-compose、curl 健康检查)为模板内容,实际使用需根据项目调整。
- 资料未说明该技能是否支持除示例之外的语言或包管理器。
- 资料未提供官方安装命令或发布渠道信息。
- 资料未说明该技能的具体运行环境依赖或版本要求。