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 27f0c0b5d2 Fetch in the background and follow changes in the repositories

- On startup, after the local state is shown, fetch the superproject and
  every initialized submodule (all remotes, prune, at most 8 at once).
  Fetches never prompt; failures show git's message. --no-fetch skips it,
  f fetches again.
- The header shows "fetching n/m", then the fetch age and failures; the
  detail pane shows each submodule's last fetch and fetch errors.
- The git provider polls each repository's metadata (refs, HEAD, index,
  .gitmodules) every 2 s and reports changes. The app reloads only what
  changed, keeping old values, expansion and cursor; loads are
  single-flight with coalesced reruns. Refresh is driven by the
  repositories, so a fetch in another shell updates the view like ours.
- r reloads everything (worktree edits are not watched).
- Docs: F50-F53, N1/N8 rewritten, D18-D20 (D12 superseded).

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

2026-10-21 16:15:22 +02:00

2.1 KiB

Raw Blame History

AGENTS.md

submarine: a Go + Bubble Tea TUI for repositories with many git submodules. Currently a prototype with a git provider (with background fetch) 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
go run ./cmd/submarine --no-fetch [dir]  # without background fetch
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 (and its optional Fetcher / Watcher). The git provider only uses the network in Fetch, and git must never prompt.
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.1 KiB Raw Blame History

AGENTS.md

Read first

Commands

Rules

2.1 KiB

Raw Blame History