Appease go report card

conflict/conflict.go

@@ -36,11 +36,14 @@ type Conflict struct {
 	BottomPeek int
 }
 
+// Represents user's conflict resolution decision
 const (
 	Local    = 1
 	Incoming = 2
 )
 
+// ErrInvalidManualInput is thrown when the manual code editing session
+// results in deletion of the conflict markers in the text
 var ErrInvalidManualInput = errors.New("Newly edited code is invalid")
 
 // Valid checks if the parsed conflict has corresponding begin, separator,

conflict/conflict_test.go

@@ -137,7 +137,7 @@ func TestHighlight(t *testing.T) {
 		err := f.Read()
 		testhelper.Ok(t, err)
 
-		conflicts, err := ExtractConflictsIn(f)
+		conflicts, err := ExtractConflicts(f)
 		if test.shouldPass {
 			testhelper.Ok(t, err)
 		} else {

conflict/file_test.go

@@ -30,7 +30,7 @@ func TestWriteChanges(t *testing.T) {
 		}
 
 		// Exract conflicts and resolve them
-		conflicts, err := ExtractConflictsIn(f)
+		conflicts, err := ExtractConflicts(f)
 		testhelper.Ok(t, err)
 		for i := range test.resolveDecision {
 			conflicts[i].Choice = test.resolveDecision[i]

conflict/parse.go

@@ -75,7 +75,11 @@ func GroupConflictMarkers(lines []string) (conflicts []Conflict, err error) {
 	return conflicts, nil
 }
 
-func ExtractConflictsIn(f File) (conflicts []Conflict, err error) {
+// ExtractConflicts extracts all conflicts from the provided `File`
+// It returns an error if it fails to parse the conflict markers
+// and if syntax highlighting fatally fails
+// TODO: Prevent crashes from syntax highlighting
+func ExtractConflicts(f File) (conflicts []Conflict, err error) {
 	conflicts, err = GroupConflictMarkers(f.Lines)
 	if err != nil {
 		return
@@ -119,7 +123,7 @@ func Find(cwd string) (files []File, err error) {
 			return
 		}
 
-		conflicts, err := ExtractConflictsIn(file)
+		conflicts, err := ExtractConflicts(file)
 		if err != nil {
 			return nil, err
 		}

conflict/parse_test.go

@@ -44,7 +44,7 @@ func TestParseConflictsIn(t *testing.T) {
 			t.Error("ParseConflicts/Read failed")
 		}
 
-		_, err := ExtractConflictsIn(f)
+		_, err := ExtractConflicts(f)
 		if test.shouldPass {
 			testhelper.Assert(t, err == nil, "function should have succeeded")
 		} else {

testhelper/testhelper.go

@@ -34,4 +34,3 @@ func Equals(tb testing.TB, exp, act interface{}) {
 		tb.FailNow()
 	}
 }
-