Files
any-hub/.specify/templates/plan-template.md
2025-11-14 12:11:44 +08:00

3.7 KiB
Raw Blame History

Implementation Plan: [FEATURE]

Branch: [###-feature-name] | Date: [DATE] | Spec: [link] Input: Feature specification from /specs/[###-feature-name]/spec.md

Note: This template is filled in by the /speckit.plan command. See .specify/templates/commands/plan.md for the execution workflow.

Summary

[Extract from feature spec: primary requirement + technical approach from research]

Technical Context

Language/Version: Go 1.25+ (静态链接,单二进制交付)
Primary Dependencies: Fiber v3HTTP 服务、Viper配置、Logrus + Lumberjack结构化日志 & 滚动)、标准库 net/http/io
Storage: 本地文件系统缓存目录 StoragePath/<Hub>/<path> + .meta 元数据
Testing: go test ./...,使用 httptest、临时目录和自建上游伪服务验证配置/缓存/代理路径
Target Platform: Linux/Unix CLI 进程,由 systemd/supervisor 管理,匿名下游客户端
Project Type: 单 Go 项目(cmd/ 入口 + internal/* 包)
Performance Goals: 缓存命中直接返回;回源路径需流式转发,单请求常驻内存 <256MB命中/回源日志可追踪
Constraints: 禁止 Web UI 或账号体系;所有行为受单一 TOML 配置控制;每个 Hub 需独立 Domain/Port 绑定;仅匿名访问
Scale/Scope: 支撑 Docker/NPM/Go/PyPI 等多仓代理,面向弱网及离线缓存复用场景

Constitution Check

GATE: Must pass before Phase 0 research. Re-check after Phase 1 design.

  • Feature 仍然是“轻量多仓 CLI 代理”,未引入 Web UI、账号体系或与代理无关的能力。
  • 仅使用 Go + 宪法指定依赖;任何新第三方库都已在本计划中说明理由与审核结论。
  • 行为完全由 config.toml 控制,新增配置项已规划默认值、校验与迁移策略。
  • 方案维持缓存优先 + 流式回源路径,并给出命中/回源/失败的日志与观测手段。
  • 计划内列出了配置解析、缓存读写、Host Header 路由等强制测试与中文注释交付范围。

Project Structure

Documentation (this feature)

specs/[###-feature]/
├── plan.md              # This file (/speckit.plan command output)
├── research.md          # Phase 0 output (/speckit.plan command)
├── data-model.md        # Phase 1 output (/speckit.plan command)
├── quickstart.md        # Phase 1 output (/speckit.plan command)
├── contracts/           # Phase 1 output (/speckit.plan command)
└── tasks.md             # Phase 2 output (/speckit.tasks command - NOT created by /speckit.plan)

Source Code (repository root)

cmd/any-hub/main.go        # CLI 入口、参数解析
internal/config/           # TOML 加载、默认值、校验
internal/server/           # Fiber 服务、路由、中间件
internal/cache/            # 磁盘/内存缓存与 .meta 管理
internal/proxy/            # 上游访问、缓存策略、流式复制
configs/                   # 示例 config.toml如需
tests/                     # `go test` 下的单元/集成测试,用临时目录

Structure Decision: 采用单 Go 项目结构,特性代码应放入上述现有目录;如需新增包或目录,必须解释其与 internal/* 的关系并给出后续维护策略。

Complexity Tracking

Fill ONLY if Constitution Check has violations that must be justified

Violation Why Needed Simpler Alternative Rejected Because
[e.g., 4th project] [current need] [why 3 projects insufficient]
[e.g., Repository pattern] [specific problem] [why direct DB access insufficient]