Przeglądaj źródła

protoc-gen-go: stop generating package "// import" comment (#701)

Usage of the import comment is being deprecated in favor of a go.mod
file as the Go ecosystem moves towards modules.

Fixes #678
Damien Neil 7 lat temu
rodzic
commit
b9c4db9580
35 zmienionych plików z 34 dodań i 98 usunięć
  1. 1 1
      proto/test_proto/test.pb.go
  2. 1 1
      protoc-gen-go/descriptor/descriptor.pb.go
  3. 1 6
      protoc-gen-go/generator/generator.go
  4. 1 60
      protoc-gen-go/golden_test.go
  5. BIN
      protoc-gen-go/protoc-gen-go
  6. 1 1
      protoc-gen-go/testdata/deprecated/deprecated.pb.go
  7. 1 1
      protoc-gen-go/testdata/extension_base/extension_base.pb.go
  8. 1 1
      protoc-gen-go/testdata/extension_extra/extension_extra.pb.go
  9. 1 1
      protoc-gen-go/testdata/extension_user/extension_user.pb.go
  10. 1 1
      protoc-gen-go/testdata/grpc/grpc.pb.go
  11. 1 1
      protoc-gen-go/testdata/import_public/a.pb.go
  12. 1 1
      protoc-gen-go/testdata/import_public/b.pb.go
  13. 1 1
      protoc-gen-go/testdata/import_public/sub/a.pb.go
  14. 1 1
      protoc-gen-go/testdata/import_public/sub/b.pb.go
  15. 1 1
      protoc-gen-go/testdata/imports/fmt/m.pb.go
  16. 1 1
      protoc-gen-go/testdata/imports/test_a_1/m1.pb.go
  17. 1 1
      protoc-gen-go/testdata/imports/test_a_1/m2.pb.go
  18. 1 1
      protoc-gen-go/testdata/imports/test_a_2/m3.pb.go
  19. 1 1
      protoc-gen-go/testdata/imports/test_a_2/m4.pb.go
  20. 1 1
      protoc-gen-go/testdata/imports/test_b_1/m1.pb.go
  21. 1 1
      protoc-gen-go/testdata/imports/test_b_1/m2.pb.go
  22. 1 1
      protoc-gen-go/testdata/imports/test_import_a1m1.pb.go
  23. 1 1
      protoc-gen-go/testdata/imports/test_import_a1m2.pb.go
  24. 1 1
      protoc-gen-go/testdata/imports/test_import_all.pb.go
  25. 1 1
      protoc-gen-go/testdata/multi/multi1.pb.go
  26. 1 1
      protoc-gen-go/testdata/multi/multi2.pb.go
  27. 1 1
      protoc-gen-go/testdata/multi/multi3.pb.go
  28. 1 1
      protoc-gen-go/testdata/my_test/test.pb.go
  29. 1 1
      protoc-gen-go/testdata/proto3/proto3.pb.go
  30. 1 1
      ptypes/any/any.pb.go
  31. 1 1
      ptypes/duration/duration.pb.go
  32. 1 1
      ptypes/empty/empty.pb.go
  33. 1 1
      ptypes/struct/struct.pb.go
  34. 1 1
      ptypes/timestamp/timestamp.pb.go
  35. 1 1
      ptypes/wrappers/wrappers.pb.go

+ 1 - 1
proto/test_proto/test.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: test_proto/test.proto
 
-package test_proto // import "github.com/golang/protobuf/proto/test_proto"
+package test_proto
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/descriptor/descriptor.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: google/protobuf/descriptor.proto
 
-package descriptor // import "github.com/golang/protobuf/protoc-gen-go/descriptor"
+package descriptor
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 6
protoc-gen-go/generator/generator.go

@@ -1208,12 +1208,7 @@ func (g *Generator) generateHeader() {
 	}
 	g.P()
 
-	importPath, _, _ := g.file.goPackageOption()
-	if importPath == "" {
-		g.P("package ", g.file.packageName)
-	} else {
-		g.P("package ", g.file.packageName, " // import ", GoImportPath(g.ImportPrefix)+importPath)
-	}
+	g.P("package ", g.file.packageName)
 	g.P()
 
 	if loc, ok := g.file.comments[strconv.Itoa(packagePath)]; ok {

+ 1 - 60
protoc-gen-go/golden_test.go

@@ -3,7 +3,6 @@ package main
 import (
 	"bytes"
 	"flag"
-	"fmt"
 	"go/build"
 	"go/parser"
 	"go/token"
@@ -150,7 +149,7 @@ func TestParameters(t *testing.T) {
 		wantPackageB: "test_beta",
 		wantImportsA: map[string]bool{
 			"github.com/golang/protobuf/proto": true,
-			"beta": true,
+			"beta":                             true,
 		},
 	}, {
 		parameters: "import_prefix=prefix",
@@ -323,64 +322,6 @@ func TestParameters(t *testing.T) {
 	}
 }
 
-func TestPackageComment(t *testing.T) {
-	workdir, err := ioutil.TempDir("", "proto-test")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer os.RemoveAll(workdir)
-
-	var packageRE = regexp.MustCompile(`(?m)^package .*`)
-
-	for i, test := range []struct {
-		goPackageOption string
-		wantPackage     string
-	}{{
-		goPackageOption: ``,
-		wantPackage:     `package proto_package`,
-	}, {
-		goPackageOption: `option go_package = "go_package";`,
-		wantPackage:     `package go_package`,
-	}, {
-		goPackageOption: `option go_package = "import/path/of/go_package";`,
-		wantPackage:     `package go_package // import "import/path/of/go_package"`,
-	}, {
-		goPackageOption: `option go_package = "import/path/of/something;go_package";`,
-		wantPackage:     `package go_package // import "import/path/of/something"`,
-	}, {
-		goPackageOption: `option go_package = "import_path;go_package";`,
-		wantPackage:     `package go_package // import "import_path"`,
-	}} {
-		srcName := filepath.Join(workdir, fmt.Sprintf("%d.proto", i))
-		tgtName := filepath.Join(workdir, fmt.Sprintf("%d.pb.go", i))
-
-		buf := &bytes.Buffer{}
-		fmt.Fprintln(buf, `syntax = "proto3";`)
-		fmt.Fprintln(buf, `package proto_package;`)
-		fmt.Fprintln(buf, test.goPackageOption)
-		if err := ioutil.WriteFile(srcName, buf.Bytes(), 0666); err != nil {
-			t.Fatal(err)
-		}
-
-		protoc(t, []string{"-I" + workdir, "--go_out=paths=source_relative:" + workdir, srcName})
-
-		out, err := ioutil.ReadFile(tgtName)
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		pkg := packageRE.Find(out)
-		if pkg == nil {
-			t.Errorf("generated .pb.go contains no package line\n\nsource:\n%v\n\noutput:\n%v", buf.String(), string(out))
-			continue
-		}
-
-		if got, want := string(pkg), test.wantPackage; got != want {
-			t.Errorf("unexpected package statement with go_package = %q\n got: %v\nwant: %v", test.goPackageOption, got, want)
-		}
-	}
-}
-
 // parseFile returns a file's package name and a list of all packages it imports.
 func parseFile(source string) (packageName string, imports []string, err error) {
 	fset := token.NewFileSet()

BIN
protoc-gen-go/protoc-gen-go


+ 1 - 1
protoc-gen-go/testdata/deprecated/deprecated.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // deprecated/deprecated.proto is a deprecated file.
 
-package deprecated // import "github.com/golang/protobuf/protoc-gen-go/testdata/deprecated"
+package deprecated
 
 /*
 package deprecated contains only deprecated messages and services.

+ 1 - 1
protoc-gen-go/testdata/extension_base/extension_base.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: extension_base/extension_base.proto
 
-package extension_base // import "github.com/golang/protobuf/protoc-gen-go/testdata/extension_base"
+package extension_base
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/extension_extra/extension_extra.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: extension_extra/extension_extra.proto
 
-package extension_extra // import "github.com/golang/protobuf/protoc-gen-go/testdata/extension_extra"
+package extension_extra
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/extension_user/extension_user.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: extension_user/extension_user.proto
 
-package extension_user // import "github.com/golang/protobuf/protoc-gen-go/testdata/extension_user"
+package extension_user
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/grpc/grpc.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: grpc/grpc.proto
 
-package testing // import "github.com/golang/protobuf/protoc-gen-go/testdata/grpc"
+package testing
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/import_public/a.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: import_public/a.proto
 
-package import_public // import "github.com/golang/protobuf/protoc-gen-go/testdata/import_public"
+package import_public
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/import_public/b.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: import_public/b.proto
 
-package import_public // import "github.com/golang/protobuf/protoc-gen-go/testdata/import_public"
+package import_public
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/import_public/sub/a.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: import_public/sub/a.proto
 
-package sub // import "github.com/golang/protobuf/protoc-gen-go/testdata/import_public/sub"
+package sub
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/import_public/sub/b.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: import_public/sub/b.proto
 
-package sub // import "github.com/golang/protobuf/protoc-gen-go/testdata/import_public/sub"
+package sub
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/fmt/m.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/fmt/m.proto
 
-package fmt // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports/fmt"
+package fmt
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_a_1/m1.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_a_1/m1.proto
 
-package test_a_1 // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports/test_a_1"
+package test_a_1
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_a_1/m2.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_a_1/m2.proto
 
-package test_a_1 // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports/test_a_1"
+package test_a_1
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_a_2/m3.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_a_2/m3.proto
 
-package test_a_2 // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports/test_a_2"
+package test_a_2
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_a_2/m4.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_a_2/m4.proto
 
-package test_a_2 // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports/test_a_2"
+package test_a_2
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_b_1/m1.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_b_1/m1.proto
 
-package beta // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports/test_b_1"
+package beta
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_b_1/m2.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_b_1/m2.proto
 
-package beta // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports/test_b_1"
+package beta
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_import_a1m1.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_import_a1m1.proto
 
-package imports // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports"
+package imports
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_import_a1m2.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_import_a1m2.proto
 
-package imports // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports"
+package imports
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/imports/test_import_all.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: imports/test_import_all.proto
 
-package imports // import "github.com/golang/protobuf/protoc-gen-go/testdata/imports"
+package imports
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/multi/multi1.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: multi/multi1.proto
 
-package multitest // import "github.com/golang/protobuf/protoc-gen-go/testdata/multi"
+package multitest
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/multi/multi2.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: multi/multi2.proto
 
-package multitest // import "github.com/golang/protobuf/protoc-gen-go/testdata/multi"
+package multitest
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/multi/multi3.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: multi/multi3.proto
 
-package multitest // import "github.com/golang/protobuf/protoc-gen-go/testdata/multi"
+package multitest
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
protoc-gen-go/testdata/my_test/test.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: my_test/test.proto
 
-package test // import "github.com/golang/protobuf/protoc-gen-go/testdata/my_test"
+package test
 
 /*
 This package holds interesting messages.

+ 1 - 1
protoc-gen-go/testdata/proto3/proto3.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: proto3/proto3.proto
 
-package proto3 // import "github.com/golang/protobuf/protoc-gen-go/testdata/proto3"
+package proto3
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
ptypes/any/any.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: google/protobuf/any.proto
 
-package any // import "github.com/golang/protobuf/ptypes/any"
+package any
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
ptypes/duration/duration.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: google/protobuf/duration.proto
 
-package duration // import "github.com/golang/protobuf/ptypes/duration"
+package duration
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
ptypes/empty/empty.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: google/protobuf/empty.proto
 
-package empty // import "github.com/golang/protobuf/ptypes/empty"
+package empty
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
ptypes/struct/struct.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: google/protobuf/struct.proto
 
-package structpb // import "github.com/golang/protobuf/ptypes/struct"
+package structpb
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
ptypes/timestamp/timestamp.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: google/protobuf/timestamp.proto
 
-package timestamp // import "github.com/golang/protobuf/ptypes/timestamp"
+package timestamp
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"

+ 1 - 1
ptypes/wrappers/wrappers.pb.go

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // source: google/protobuf/wrappers.proto
 
-package wrappers // import "github.com/golang/protobuf/ptypes/wrappers"
+package wrappers
 
 import proto "github.com/golang/protobuf/proto"
 import fmt "fmt"