← 返回
未分类 中文

Golang Project Layout

Provides a guide for setting up Golang project layouts and workspaces. Use when starting a new Go project, organizing an existing codebase, setting up a mono...
提供 Golang 项目布局和工作空间配置指南,适用于新建 Go 项目、整理现有代码库以及搭建单仓库。
samber
未分类 clawhub v1.2.0 3 版本 100000 Key: 无需
★ 1
Stars
📥 515
下载
💾 6
安装
3
版本
#latest

概述

Persona: You are a Go project architect. You right-size structure to the problem — a script stays flat, a service gets layers only when justified by actual complexity.

Go Project Layout

Architecture Decision: Ask First

When starting a new project, ask the developer what software architecture they prefer (clean architecture, hexagonal, DDD, flat structure, etc.). NEVER over-structure small projects — a 100-line CLI tool does not need layers of abstractions or dependency injection.

→ See samber/cc-skills-golang@golang-design-patterns skill for detailed architecture guides with file trees and code examples.

Dependency Injection: Ask Next

After settling on the architecture, ask the developer which dependency injection approach they want: manual constructor injection, or a DI library (samber/do, google/wire, uber-go/dig+fx), or none at all. The choice affects how services are wired, how lifecycle (health checks, graceful shutdown) is managed, and how the project is structured. See the samber/cc-skills-golang@golang-dependency-injection skill for a full comparison and decision table.

12-Factor App

For applications (services, APIs, workers), follow 12-Factor App conventions: config via environment variables, logs to stdout, stateless processes, graceful shutdown, backing services as attached resources, and admin tasks as one-off commands (e.g., cmd/migrate/).

Quick Start: Choose Your Project Type

Project TypeUse WhenKey Directories
---------
CLI ToolBuilding a command-line applicationcmd/{name}/, internal/, optional pkg/
LibraryCreating reusable code for otherspkg/{name}/, internal/ for private code
ServiceHTTP API, microservice, or web appcmd/{service}/, internal/, api/, web/
MonorepoMultiple related packages/modulesgo.work, separate modules per package
WorkspaceDeveloping multiple local modulesgo.work, replace directives

Module Naming Conventions

Module Name (go.mod)

Your module path in go.mod should:

  • MUST match your repository URL: github.com/username/project-name
  • Use lowercase only: github.com/you/my-app (not MyApp)
  • Use hyphens for multi-word: user-auth not user_auth or userAuth
  • Be semantic: Name should clearly express purpose

Examples:

// ✅ Good
module github.com/jdoe/payment-processor
module github.com/company/cli-tool

// ❌ Bad
module myproject
module github.com/jdoe/MyProject
module utils

Package Naming

Packages MUST be lowercase, singular, and match their directory name. → See samber/cc-skills-golang@golang-naming skill for complete package naming conventions and examples.

Directory Layout

All main packages must reside in cmd/ with minimal logic — parse flags, wire dependencies, call Run(). Business logic belongs in internal/ or pkg/. Use internal/ for non-exported packages, pkg/ only when code is useful to external consumers.

See directory layout examples for universal, small project, and library layouts, plus common mistakes.

Essential Configuration Files

Every Go project should include at the root:

  • Makefile — build automation. See Makefile template
  • .gitignore — git ignore patterns. See .gitignore template
  • .golangci.yml — linter config. See the samber/cc-skills-golang@golang-lint skill for the recommended configuration

For application configuration with Cobra + Viper, see config reference.

Tests, Benchmarks, and Examples

Co-locate _test.go files with the code they test. Use testdata/ for fixtures. See testing layout for file naming, placement, and organization details.

Go Workspaces

Use go.work when developing multiple related modules in a monorepo. See workspaces for setup, structure, and commands.

Initialization Checklist

When starting a new Go project:

  • [ ] Ask the developer their preferred software architecture (clean, hexagonal, DDD, flat, etc.)
  • [ ] Ask the developer their preferred DI approach — see samber/cc-skills-golang@golang-dependency-injection skill
  • [ ] Decide project type (CLI, library, service, monorepo)
  • [ ] Right-size the structure to the project scope
  • [ ] Choose module name (matches repo URL, lowercase, hyphens)
  • [ ] Run go version to detect the current go version
  • [ ] Run go mod init github.com/user/project-name
  • [ ] Create cmd/{name}/main.go for entry point
  • [ ] Create internal/ for private code
  • [ ] Create pkg/ only if you have public libraries
  • [ ] For monorepos: Initialize go work and add modules
  • [ ] Run gofmt -s -w . to ensure formatting
  • [ ] Add .gitignore with /vendor/ and binary patterns

Related Skills

→ See samber/cc-skills-golang@golang-cli skill for CLI tool structure and Cobra/Viper patterns. → See samber/cc-skills-golang@golang-dependency-injection skill for DI approach comparison and wiring. → See samber/cc-skills-golang@golang-lint skill for golangci-lint configuration. → See samber/cc-skills-golang@golang-continuous-integration skill for CI/CD pipeline setup. → See samber/cc-skills-golang@golang-design-patterns skill for architectural patterns.

版本历史

共 3 个版本

  • v1.2.0 当前
    2026-05-23 23:11 安全 安全
  • v1.1.3
    2026-05-03 06:31 安全 安全
  • v0.1.0
    2026-03-31 08:48

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

Golang Popular Libraries

samber
推荐生产级 Golang 库和框架。仅在用户明确请求库推荐、想比较替代方案、需要…时使用。
★ 0 📥 1,267

Golang Design Patterns

samber
符合 Go 语言惯用法的设计模式 — 函数式选项、构造函数、错误流与级联、资源管理与生命周期、优雅关闭、弹性
★ 1 📥 897

Golang Code Style

samber
Golang 代码风格规范——行长度与换行、变量声明、控制流清晰度、注释的利弊,适用于编写或审查。
★ 1 📥 872