setup-go-project

Setup Go Project

Scaffold a new Go project with opinionated defaults: a cmd/<name>/main.go layout, a Makefile with build/test/lint/fmt/clean/cover targets, golangci-lint for linting, GitHub Actions for CI, and a two-layer git-hook setup — fast gate at pre-commit (goimports + go vet) and full gate at pre-push (make lint && make test, mirroring CI).

Phase 1 — Determine project name and module path

• If $ARGUMENTS is non-empty, use it as the project name
• Otherwise, infer from basename $PWD
• Ask the user for the Go module path (e.g. github.com/<user>/<name>). Do not guess — wrong module paths are painful to change later. If go.mod already exists, read the module path from it instead of asking.

Present a brief summary, then ask for confirmation. If .git/ exists, include the hook files in the list; otherwise omit them and note that hooks will be skipped until git is initialized.

For new projects:

Project name:    <name>
Module path:     <module-path>
Binary:          <name> (in cmd/<name>/)
Files to create: go.mod, Makefile, .gitignore, README.md, .golangci.yml,
                 cmd/<name>/main.go, .github/workflows/ci.yml
Git hooks:       .git/hooks/pre-commit, .git/hooks/pre-commit.d/go.sh,
                 .git/hooks/pre-push,   .git/hooks/pre-push.d/go.sh
                 (or: "skipped — git not initialized")

Proceed? [y/N]

For existing projects (re-run), show what will be added/updated:

Project name:    <name> (existing project)

Updates:
  .golangci.yml:           add <missing linters>
  Makefile:                add <missing targets>
  .github/workflows/ci.yml: already up to date
  pre-push.d/go.sh:        add (hook is new)

Proceed? [y/N]

Phase 2 — Preflight checks

Before writing anything:

1. Check which target files already exist. Read each existing file so you understand what's already configured.
2. Check if git is initialized (git rev-parse --git-dir 2>/dev/null). If not, note it in the final report — don't run git init yourself.
3. Check if go and golangci-lint are on PATH. If golangci-lint is missing, note the install command (brew install golangci-lint or go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest) in the final report.