Add annotation positions to schema error messages

pkg/cmd/template/schema_author_test.go

@@ -194,10 +194,11 @@ Invalid schema
 unknown @schema/type annotation keyword argument
 schema.yml:
     |
+  3 | #@schema/type unknown_kwarg=False
   4 | foo: 0
     |
 
-    = found: unknown_kwarg
+    = found: unknown_kwarg (by schema.yml:3)
     = expected: A valid kwarg
     = hint: Supported kwargs are 'any'
 `
@@ -222,10 +223,11 @@ Invalid schema
 unknown @schema/type annotation keyword argument
 schema.yml:
     |
+  3 | #@schema/type any=1
   4 | foo: 0
     |
 
-    = found: starlark.Int
+    = found: starlark.Int (by schema.yml:3)
     = expected: starlark.Bool
     = hint: Supported kwargs are 'any'
 `
@@ -250,10 +252,11 @@ Invalid schema
 expected @schema/type annotation to have keyword argument and value
 schema.yml:
     |
+  3 | #@schema/type
   4 | foo: 0
     |
 
-    = found: missing keyword argument and value
+    = found: missing keyword argument and value (by schema.yml:3)
     = expected: valid keyword argument and value
     = hint: Supported key-value pairs are 'any=True', 'any=False'
 `
@@ -269,11 +272,27 @@ schema.yml:
 #@schema/type any
 foo: 0
 `
+		expectedErr2 := `
+Invalid schema
+==============
+
+expected @schema/type annotation to have keyword argument and value
+schema.yml:
+    |
+  3 | #@schema/type any
+  4 | foo: 0
+    |
+
+    = found: missing keyword argument and value (by schema.yml:3)
+    = expected: valid keyword argument and value
+    = hint: Supported key-value pairs are 'any=True', 'any=False'
+`
+
 		filesToProcess = files.NewSortedFiles([]*files.File{
 			files.MustNewFileFromSource(files.NewBytesSource("schema.yml", []byte(schemaYAML2))),
 		})
 
-		assertFails(t, filesToProcess, expectedErr, opts)
+		assertFails(t, filesToProcess, expectedErr2, opts)
 	})
 	t.Run("when schema/type and schema/nullable annotate a map", func(t *testing.T) {
 		schemaYAML := `#@data/values-schema
@@ -290,6 +309,8 @@ Invalid schema
 @schema/nullable, and @schema/type any=True are mutually exclusive
 schema.yml:
     |
+  3 | #@schema/type any=True
+  4 | #@schema/nullable
   5 | foo: 0
     |
 
@@ -319,10 +340,11 @@ Invalid schema
 syntax error in @schema/default annotation
 schema.yml:
     |
+  3 | #@schema/default
   4 | foo: 0
     |
 
-    = found: missing value (in @schema/default above this item)
+    = found: missing value in @schema/default (by schema.yml:3)
     = expected: integer (by schema.yml:4)
 `
 
@@ -345,10 +367,11 @@ Invalid schema
 syntax error in @schema/default annotation
 schema.yml:
     |
+  3 | #@schema/default 1, 2
   4 | foo: 0
     |
 
-    = found: 2 values (in @schema/default above this item)
+    = found: 2 values in @schema/default (by schema.yml:3)
     = expected: integer (by schema.yml:4)
 `
 
@@ -371,10 +394,11 @@ Invalid schema
 syntax error in @schema/default annotation
 schema.yml:
     |
+  3 | #@schema/default any=True
   4 | foo: 0
     |
 
-    = found: (keyword argument in @schema/default above this item)
+    = found: keyword argument in @schema/default (by schema.yml:3)
     = expected: integer (by schema.yml:4)
     = hint: this annotation only accepts one argument: the default value.
     = hint: value must be in Starlark format, e.g.: {'key': 'value'}, True.
@@ -401,6 +425,7 @@ Invalid schema - @schema/default not supported on array item
 
 schema.yml:
     |
+  4 | #@schema/default "baz"
   5 | - bar
     |
 
@@ -489,10 +514,11 @@ Invalid schema
 syntax error in @schema/desc annotation
 schema.yml:
     |
+  3 | #@schema/desc
   4 | key: val
     |
 
-    = found: missing value (in @schema/desc above this item)
+    = found: missing value in @schema/desc (by schema.yml:3)
     = expected: string
 `
 
@@ -515,10 +541,11 @@ Invalid schema
 syntax error in @schema/desc annotation
 schema.yml:
     |
+  3 | #@schema/desc "two", "strings"
   4 | key: val
     |
 
-    = found: 2 values (in @schema/desc above this item)
+    = found: 2 values in @schema/desc (by schema.yml:3)
     = expected: string
 `
 
@@ -541,10 +568,11 @@ Invalid schema
 syntax error in @schema/desc annotation
 schema.yml:
     |
+  3 | #@schema/desc 1
   4 | key: val
     |
 
-    = found: Non-string value (in @schema/desc above this item)
+    = found: Non-string value in @schema/desc (by schema.yml:3)
     = expected: string
 `
 
@@ -567,10 +595,11 @@ Invalid schema
 syntax error in @schema/desc annotation
 schema.yml:
     |
+  3 | #@schema/desc key=True
   4 | key: val
     |
 
-    = found: keyword argument (in @schema/desc above this item)
+    = found: keyword argument in @schema/desc (by schema.yml:3)
     = expected: string
     = hint: this annotation only accepts one argument: a string.
 `

pkg/filepos/position.go

@@ -109,3 +109,16 @@ func (p *Position) DeepCopyWithLineOffset(offset int) *Position {
 	*newPos.lineNum += offset
 	return newPos
 }
+
+// IsNextTo compares the location of one position with another.
+func (p *Position) IsNextTo(otherPostion *Position) bool {
+	if p.IsKnown() && otherPostion.IsKnown() {
+		if p.GetFile() == otherPostion.GetFile() {
+			diff := p.LineNum() - otherPostion.LineNum()
+			if -1 <= diff && 1 >= diff {
+				return true
+			}
+		}
+	}
+	return false
+}