跳转到内容

从零搭建项目脚手架实战

从空目录到一个可运行的项目。描述技术栈和约定,OpenCode 会生成目录布局、配置文件,以及首次即可构建成功的入门框架。

何时使用此案例

  • 要开始一个新项目,想要合理的默认结构。
  • 团队有希望一致应用的约定。
  • 想要一个能立即构建并运行的入门框架。

前置配置

  • 一个空的或已初始化的 git 仓库。
  • 已安装 OpenCode。

步骤

  1. 描述技术栈和目标

    明确技术、约定以及”完成”的含义。

    用 TypeScript Node.js 搭建 Fastify 服务。包含 src/ 布局,区分 routes、services 和 config。添加 ESLint、Prettier、Vitest 和健康检查路由。项目必须能首次构建,且健康检查必须通过。

  2. 审查建议的结构

    OpenCode 先给出目录树,在写文件前先调整。

    src/
      routes/health.ts
      services/
      config/index.ts
      index.ts
  3. 生成文件

    让 OpenCode 写入布局、配置和样板代码。

  4. 验证构建

    npm install
    npm run build
    npm test
  5. 提交基线

    git add -A && git commit -m "chore: initial scaffold"

关键提示词

创建 TypeScript Fastify 服务。使用布局:src/routessrc/servicessrc/config。添加 ESLint + Prettier + Vitest、一个 /health 路由和一个基于环境变量的配置加载器。确保 npm install && npm run build 无报错。

常见坑点

  • 规格含糊:“做个 Web 应用”会得到通用输出——明确技术栈、布局和成功标准。
  • 缺少成功校验:在提示词中始终包含构建/测试命令,确保脚手架是被验证过的,而非仅写完。
  • 忽视约定:如果团队使用特定模式(如功能文件夹),明确说明,否则脚手架不会匹配。

相关文档

  • 快速开始 — 几分钟内在新项目中运行 OpenCode
  • 配置 — 为你的项目布局设置 opencode.json

相关案例

相关文档

下一步