Allow extra option locations in source info when building an image (#…

…2803)

This opts into a feature in protocompile to produce more source code
locations (for span and comment info) than protoc produces. This
allows us to potentially report lint warnings with more precise position
information, and it should also allows us to carry more comment
information about custom option values into generated docs.

private/bufpkg/bufcheck/buflint/buflint_test.go

@@ -625,7 +625,8 @@ func TestRunProtovalidateRules(t *testing.T) {
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 35, 5, 35, 43, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 39, 5, 39, 43, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 42, 5, 42, 42, "PROTOVALIDATE"),
-		bufanalysistesting.NewFileAnnotation(t, "number.proto", 45, 48, 48, 4, "PROTOVALIDATE"),
+		bufanalysistesting.NewFileAnnotation(t, "number.proto", 46, 5, 46, 11, "PROTOVALIDATE"),
+		bufanalysistesting.NewFileAnnotation(t, "number.proto", 47, 5, 47, 12, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 56, 5, 56, 39, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 65, 5, 65, 41, "PROTOVALIDATE"),
 		bufanalysistesting.NewFileAnnotation(t, "number.proto", 74, 5, 74, 40, "PROTOVALIDATE"),

private/bufpkg/bufcheck/buflint/testdata/protovalidate_rules/number.proto

@@ -41,10 +41,10 @@ message Int32Test {
     // the next line should be annotated
     (buf.validate.field).sfixed64.gt = 10
   ];
-  // the entire option should be annotated. (45, 48) to (48, 4)
+  // annotating items inside an option value
   fixed32 invalid_bound_aggregate_syntax = 11 [(buf.validate.field).fixed32 = {
-    lt: 10
-    gte: 10
+    lt: 10 // this line should be annotated
+    gte: 10 // and this one, too
   }];
   // valid
   google.protobuf.Int32Value int32_value_match = 12 [

private/bufpkg/bufimage/bufimagebuild/builder.go

@@ -310,7 +310,10 @@ func getBuildResult(
 ) *buildResult {
 	var errorsWithPos []reporter.ErrorWithPos
 	var warningErrorsWithPos []reporter.ErrorWithPos
-	sourceInfoMode := protocompile.SourceInfoStandard
+	// With "extra option locations", buf can include more comments
+	// for an option value than protoc can. In particular, this allows
+	// it to preserve comments inside of message literals.
+	sourceInfoMode := protocompile.SourceInfoExtraOptionLocations
 	if excludeSourceCodeInfo {
 		sourceInfoMode = protocompile.SourceInfoNone
 	}