feat: detect hunk keywords in annotations and populate EndLine

Author: umputun

docs/plans/20260406-hunk-keyword-expansion.md

@@ -40,13 +40,13 @@ Add an `EndLine` field to `Annotation`. When creating an annotation, if the comm
 - Modify: `ui/annotate.go`
 - Modify: `ui/model_test.go`
 
-- [ ] add `hunkEndLine(idx int) int` method that finds the last line of the hunk containing diffLines[idx]
-- [ ] in the annotation creation path, after building the Annotation, check if comment contains hunk keywords (case-insensitive "hunk" or "block" as whole words)
-- [ ] if keyword found and line is in a change hunk, set `EndLine` to hunk end line number via `hunkEndLine`
-- [ ] write test: annotation with "refactor this hunk" gets EndLine populated
-- [ ] write test: annotation with "this is fine" does NOT get EndLine
-- [ ] write test: annotation on context line (not in hunk) does NOT get EndLine even with keyword
-- [ ] run `make test && make lint`
+- [x] add `hunkEndLine(idx int) int` method that finds the last line of the hunk containing diffLines[idx]
+- [x] in the annotation creation path, after building the Annotation, check if comment contains hunk keywords (case-insensitive "hunk" or "block" as whole words)
+- [x] if keyword found and line is in a change hunk, set `EndLine` to hunk end line number via `hunkEndLine`
+- [x] write test: annotation with "refactor this hunk" gets EndLine populated
+- [x] write test: annotation with "this is fine" does NOT get EndLine
+- [x] write test: annotation on context line (not in hunk) does NOT get EndLine even with keyword
+- [x] run `make test && make lint`
 
 ### Task 3: Verify and document
 

ui/annotate.go

@@ -2,6 +2,7 @@ package ui
 
 import (
 	"fmt"
+	"regexp"
 
 	"github.com/charmbracelet/bubbles/textinput"
 	tea "github.com/charmbracelet/bubbletea"
@@ -11,6 +12,9 @@ import (
 	"github.com/umputun/revdiff/diff"
 )
 
+// hunkKeywordRe matches whole-word "hunk" or "block" (case-insensitive).
+var hunkKeywordRe = regexp.MustCompile(`(?i)\b(hunk|block)\b`)
+
 // newAnnotationInput creates and focuses a text input for annotation editing.
 // prefixWidth accounts for the visible prefix characters (cursor col + emoji + label + margin).
 func (m *Model) newAnnotationInput(placeholder string, prefixWidth int) (textinput.Model, tea.Cmd) {
@@ -104,7 +108,13 @@ func (m *Model) saveAnnotation() {
 	}
 
 	lineNum := m.diffLineNum(dl)
-	m.store.Add(annotation.Annotation{File: m.currFile, Line: lineNum, Type: string(dl.ChangeType), Comment: text})
+	a := annotation.Annotation{File: m.currFile, Line: lineNum, Type: string(dl.ChangeType), Comment: text}
+	if hunkKeywordRe.MatchString(text) {
+		if endLine := m.hunkEndLine(m.diffCursor); endLine > lineNum {
+			a.EndLine = endLine
+		}
+	}
+	m.store.Add(a)
 	m.annotating = false
 	m.tree.refreshFilter(m.annotatedFiles())
 	m.viewport.SetContent(m.renderDiff())
@@ -221,6 +231,29 @@ func (m Model) diffLineNum(dl diff.DiffLine) int {
 	return dl.NewNum
 }
 
+// hunkEndLine returns the display line number of the last line in the change hunk
+// containing diffLines[idx]. returns 0 if idx is not inside a change hunk.
+func (m Model) hunkEndLine(idx int) int {
+	if idx < 0 || idx >= len(m.diffLines) {
+		return 0
+	}
+	dl := m.diffLines[idx]
+	if dl.ChangeType != diff.ChangeAdd && dl.ChangeType != diff.ChangeRemove {
+		return 0
+	}
+
+	// walk forward from idx to find the last contiguous change line
+	last := idx
+	for i := idx + 1; i < len(m.diffLines); i++ {
+		ct := m.diffLines[i].ChangeType
+		if ct != diff.ChangeAdd && ct != diff.ChangeRemove {
+			break
+		}
+		last = i
+	}
+	return m.diffLineNum(m.diffLines[last])
+}
+
 // wrappedAnnotationLineCount returns the number of visual rows an annotation occupies.
 // annotations always wrap at the pane width regardless of wrapMode.
 func (m Model) wrappedAnnotationLineCount(key string) int {

ui/model_test.go

@@ -478,7 +478,6 @@ func TestModel_BlameFromConfig(t *testing.T) {
 	})
 }
 
-
 func TestModel_StatusModeIcons(t *testing.T) {
 	t.Run("all icons always present", func(t *testing.T) {
 		m := testModel(nil, nil)
@@ -939,6 +938,107 @@ func TestModel_AnnotateEnterEmptyTextCancels(t *testing.T) {
 	assert.Empty(t, model.store.Get("a.go"))
 }
 
+func TestModel_AnnotateHunkKeywordSetsEndLine(t *testing.T) {
+	lines := []diff.DiffLine{
+		{OldNum: 1, NewNum: 1, Content: "ctx before", ChangeType: diff.ChangeContext},
+		{OldNum: 2, Content: "old line", ChangeType: diff.ChangeRemove},
+		{NewNum: 2, Content: "new line", ChangeType: diff.ChangeAdd},
+		{NewNum: 3, Content: "added line", ChangeType: diff.ChangeAdd},
+		{OldNum: 3, NewNum: 4, Content: "ctx after", ChangeType: diff.ChangeContext},
+	}
+
+	t.Run("hunk keyword populates EndLine", func(t *testing.T) {
+		m := testModel([]string{"a.go"}, nil)
+		m.tree = newFileTree([]string{"a.go"})
+		m.focus = paneDiff
+		m.currFile = "a.go"
+		m.diffLines = lines
+		m.diffCursor = 2 // on "new line" (add, NewNum=2)
+		m.startAnnotation()
+		m.annotateInput.SetValue("refactor this hunk")
+		m.saveAnnotation()
+		anns := m.store.Get("a.go")
+		require.Len(t, anns, 1)
+		assert.Equal(t, 2, anns[0].Line)
+		assert.Equal(t, 3, anns[0].EndLine, "EndLine should be last add line's NewNum")
+	})
+
+	t.Run("block keyword populates EndLine", func(t *testing.T) {
+		m := testModel([]string{"a.go"}, nil)
+		m.tree = newFileTree([]string{"a.go"})
+		m.focus = paneDiff
+		m.currFile = "a.go"
+		m.diffLines = lines
+		m.diffCursor = 1 // on "old line" (remove, OldNum=2)
+		m.startAnnotation()
+		m.annotateInput.SetValue("review this BLOCK carefully")
+		m.saveAnnotation()
+		anns := m.store.Get("a.go")
+		require.Len(t, anns, 1)
+		assert.Equal(t, 2, anns[0].Line)
+		assert.Equal(t, 3, anns[0].EndLine, "EndLine should be last add line's NewNum")
+	})
+
+	t.Run("no keyword does not set EndLine", func(t *testing.T) {
+		m := testModel([]string{"a.go"}, nil)
+		m.tree = newFileTree([]string{"a.go"})
+		m.focus = paneDiff
+		m.currFile = "a.go"
+		m.diffLines = lines
+		m.diffCursor = 2
+		m.startAnnotation()
+		m.annotateInput.SetValue("this is fine")
+		m.saveAnnotation()
+		anns := m.store.Get("a.go")
+		require.Len(t, anns, 1)
+		assert.Equal(t, 0, anns[0].EndLine, "EndLine should be 0 when no hunk keyword")
+	})
+
+	t.Run("context line with keyword does not set EndLine", func(t *testing.T) {
+		m := testModel([]string{"a.go"}, nil)
+		m.tree = newFileTree([]string{"a.go"})
+		m.focus = paneDiff
+		m.currFile = "a.go"
+		m.diffLines = lines
+		m.diffCursor = 0 // context line
+		m.startAnnotation()
+		m.annotateInput.SetValue("rewrite this hunk")
+		m.saveAnnotation()
+		anns := m.store.Get("a.go")
+		require.Len(t, anns, 1)
+		assert.Equal(t, 0, anns[0].EndLine, "EndLine should be 0 for context line even with keyword")
+	})
+}
+
+func TestModel_HunkEndLine(t *testing.T) {
+	lines := []diff.DiffLine{
+		{OldNum: 1, NewNum: 1, Content: "ctx", ChangeType: diff.ChangeContext},
+		{OldNum: 2, Content: "removed", ChangeType: diff.ChangeRemove},
+		{NewNum: 2, Content: "added1", ChangeType: diff.ChangeAdd},
+		{NewNum: 3, Content: "added2", ChangeType: diff.ChangeAdd},
+		{OldNum: 3, NewNum: 4, Content: "ctx", ChangeType: diff.ChangeContext},
+	}
+	m := testModel(nil, nil)
+	m.diffLines = lines
+
+	t.Run("returns last line of hunk from first change", func(t *testing.T) {
+		assert.Equal(t, 3, m.hunkEndLine(1), "hunk ending at add NewNum=3")
+	})
+	t.Run("returns last line from middle of hunk", func(t *testing.T) {
+		assert.Equal(t, 3, m.hunkEndLine(2))
+	})
+	t.Run("returns last line from last change line", func(t *testing.T) {
+		assert.Equal(t, 3, m.hunkEndLine(3))
+	})
+	t.Run("returns 0 for context line", func(t *testing.T) {
+		assert.Equal(t, 0, m.hunkEndLine(0))
+	})
+	t.Run("returns 0 for out of bounds", func(t *testing.T) {
+		assert.Equal(t, 0, m.hunkEndLine(-1))
+		assert.Equal(t, 0, m.hunkEndLine(99))
+	})
+}
+
 func TestModel_AnnotateEscCancels(t *testing.T) {
 	lines := []diff.DiffLine{
 		{NewNum: 1, Content: "line1", ChangeType: diff.ChangeContext},