Archived

This repository has been archived on 2026-10-25. You can view files and clone it. You cannot open issues or pull requests or push a commit.

Files

T

Simon FrankenandClaude Opus 5.5 64fe34b5b0 Add read-only git provider

Implement submodule.Provider with the git CLI so submarine reads real
repositories: `submarine [dir]`, with `--mock` for the built-in data.

- Tree reads .gitmodules recursively; Status derives presence, checkout,
  worktree, staged pin, pushed state and pin -> ref resolution from local
  git commands only (no network).
- Concurrent Status calls are bounded by runtime.NumCPU().
- scripts/make-fixture.sh builds a superproject covering every state; the
  integration tests run against it.
- theme.Ago shows "never" for a zero time.
- Docs updated; decisions D14-D16 added.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

2026-10-21 15:32:21 +02:00

2.0 KiB

Raw Blame History

AGENTS.md

submarine: a Go + Bubble Tea TUI for repositories with many git submodules. Currently a prototype with a read-only git provider and mock data.

Read first

The docs/ folder is the source of truth for requirements, state rules, UX and decisions. Read the relevant document before changing behavior:

docs/README.md: overview, status, next steps
docs/requirements.md: what the tool must do
docs/state-model.md: states, issues, levels, pin → ref resolution
docs/ux-guide.md: layout, colors, wording, key bindings
docs/architecture.md: packages, provider boundary, loading, testing
docs/decisions.md: decision log with rationale

Commands

go run ./cmd/submarine [dir]  # run on a repository (default: cwd)
go run ./cmd/submarine --mock # run on mock data
scripts/make-fixture.sh DIR   # build a test superproject in DIR
go vet ./...
go test ./...
gofmt -l .                    # must print nothing

Rules

Keep docs in sync. A change to behavior, keys, colors, wording or architecture updates the matching document in docs/. A new significant decision gets an entry in docs/decisions.md.
Layering. internal/submodule has no UI imports and decides what a state means (Status.Issues()). internal/tui/theme decides how it looks. Components never classify states or define colors themselves.
Data access only through submodule.Provider. The git provider is read-only and must never use the network.
Colors only from theme.Theme, ANSI 16 colors for meaning (see docs/ux-guide.md#colors). Render segments on a background with a base style (LevelStyle(level, base), Delta(pin, base)).
Tree navigation stays in plain methods on tree.Model with unit tests in internal/tui/tree/tree_test.go.
Verify UI changes by running the app, e.g. headless in tmux (see docs/architecture.md#testing), not only by tests.

2.0 KiB Raw Blame History

AGENTS.md

Read first

Commands

Rules

2.0 KiB

Raw Blame History