markdown

type ActionType string

type Decoration string

type Document struct {
	Title       string     // Leading H1 heading text ("" when the document has none)
	Preamble    string     // Text before the first heading
	Sections    []*Section // Top-level sections
	SourceLines []string   // Raw source lines (for line-level commenting)
}

type File struct {
	Path   string
	Doc    *Document
	Diff   *diff.Info   // nil: review the full source instead of a diff
	Viewed *ViewedState // nil: viewed marks live only for the session
}

type FileResult struct {
	File
	Status Status
	Review *ReviewResult // nil when the file was quit (skipped)
}

type Loader func(path string) (File, error)

type ReloadResult struct {
	Err     error // the file could not be read; the review is unchanged
	Changed bool  // the review now shows the new content
	Moved   int   // comments that could not be placed and were moved (see reload)
	// Sections maps the section IDs before the reload to those of the same
	// sections after it, so a front end can stay on the selected one.
	Sections map[string]string
}

type ReviewComment struct {
	ID         string     `json:"id"`                  // assigned by ReviewState
	SectionID  string     `json:"sectionId"`           // Target section ID
	Action     ActionType `json:"action"`              // Comment action type
	Decoration Decoration `json:"decoration"`          // Comment decoration (e.g. non-blocking, blocking)
	Body       string     `json:"body"`                // Comment body text
	StartLine  int        `json:"startLine,omitempty"` // 1-based start line (0 = section-level comment)
	EndLine    int        `json:"endLine,omitempty"`   // 1-based end line (0 = single line if StartLine > 0)
	Side       string     `json:"side,omitempty"`      // "RIGHT" or "LEFT" (for diff comments)
	Quote      []string   `json:"quote,omitempty"`     // source text of the commented lines (line-level only)
}

type ReviewResult struct {
	Comments []ReviewComment
}

type ReviewState struct {
	File
	// contains filtered or unexported fields
}

type Section struct {
	ID        string     // Auto-numbered: "S1", "S1.1", "S2", etc.
	Title     string     // Heading text (without the "## " prefix)
	Level     int        // Heading level (2=##, 3=###, ...)
	Body      string     // Markdown text from heading to next heading
	Children  []*Section // Sub-sections (lower-level headings)
	Parent    *Section   // Parent section (nil for top-level)
	StartLine int        // 1-based line number of heading (0 = not set)
	EndLine   int        // 1-based line number of last body line (0 = not set)
}

type Status string

type ViewedState struct {
	Sections map[string]string `json:"sections"` // title -> content hash
}