navigate

type CodeChange struct {
	Commits int    `json:"commits"`
	Date    string `json:"date"`
	Latest  string `json:"latest"`
	// Summary is the sentence every surface shows — the text map and the
	// code-map hook — so they cannot word the warning differently.
	Summary string `json:"summary"`
}

type CodeFile struct {
	Rel  string
	Repo string
	// Root is the repository's folder, empty outside a repository. It is where
	// the file's history is read.
	Root string
}

type Dir struct {
	Path  string `json:"path"`
	Total int    `json:"total"`
	// Summary is what the folder covers: its overview note's first sentence,
	// else its most used tags. SummaryFrom says which ("overview", "tags").
	Summary     string `json:"summary,omitempty"`
	SummaryFrom string `json:"summary_from,omitempty"`
	// Overview is the folder's overview note, kept out of Notes and Total.
	Overview *Note  `json:"overview,omitempty"`
	Dirs     []*Dir `json:"dirs,omitempty"`
	Notes    []Note `json:"notes,omitempty"`
}

type Filter struct {
	PathPrefix string
	Type       string
}

type Note struct {
	ID     string `json:"id"`
	Path   string `json:"path"`
	Title  string `json:"title"`
	Type   string `json:"type"`
	Status string `json:"status,omitempty"`
	Line   string `json:"line,omitempty"`
	// CodeChanged is set by `tree --for` when the file was committed to after
	// the note was.
	CodeChanged *CodeChange `json:"code_changed,omitempty"`
	// Tags and Mtime feed a folder's summary and doctor's staleness check;
	// they are not part of the printed map.
	Tags  []string `json:"-"`
	Mtime int64    `json:"-"`
}

type Querier interface {
	Query(query string, args ...interface{}) (*sql.Rows, error)
}

type RenderOptions struct {
	// Depth limits how many folder levels are listed; deeper folders are folded
	// into their parent's count. Notes are listed only inside listed folders
	// above the limit. 0 lists everything.
	Depth int
	// Brief prints titles and ids without the one-line descriptions.
	Brief bool
}