Update PluginInfo (#7)

bufdev · web-flow · commit 6989c2f999f9 · 2024-10-23T21:36:20.000-04:00
diff --git a/.golangci.yml b/.golangci.yml
@@ -75,6 +75,9 @@ issues:
     - linters:
         - unparam
       path: check/response.go
+    - linters:
+        - unparam
+      path: info/plugin_info.go
     - linters:
         - varnamelen
       path: check/internal/example
diff --git a/check/internal/example/cmd/buf-plugin-field-lower-snake-case/main.go b/check/internal/example/cmd/buf-plugin-field-lower-snake-case/main.go
@@ -62,7 +62,6 @@ var (
 		},
 		// Optional.
 		Info: &info.Spec{
-			URL:           "https://github.com/bufbuild/bufplugin-go",
 			SPDXLicenseID: "apache-2.0",
 			LicenseURL:    "https://github.com/bufbuild/bufplugin-go/blob/main/LICENSE",
 		},
diff --git a/check/internal/example/cmd/buf-plugin-field-option-safe-for-ml/main.go b/check/internal/example/cmd/buf-plugin-field-option-safe-for-ml/main.go
@@ -110,7 +110,6 @@ var (
 		},
 		// Optional.
 		Info: &info.Spec{
-			URL:           "https://github.com/bufbuild/bufplugin-go",
 			SPDXLicenseID: "apache-2.0",
 			LicenseURL:    "https://github.com/bufbuild/bufplugin-go/blob/main/LICENSE",
 		},
diff --git a/check/internal/example/cmd/buf-plugin-syntax-specified/main.go b/check/internal/example/cmd/buf-plugin-syntax-specified/main.go
@@ -63,7 +63,6 @@ var (
 		},
 		// Optional.
 		Info: &info.Spec{
-			URL:           "https://github.com/bufbuild/bufplugin-go",
 			SPDXLicenseID: "apache-2.0",
 			LicenseURL:    "https://github.com/bufbuild/bufplugin-go/blob/main/LICENSE",
 		},
diff --git a/check/internal/example/cmd/buf-plugin-timestamp-suffix/main.go b/check/internal/example/cmd/buf-plugin-timestamp-suffix/main.go
@@ -79,10 +79,9 @@ var (
 		},
 		// Optional.
 		Info: &info.Spec{
-			URL:           "https://github.com/bufbuild/bufplugin-go",
+			Documentation: `A simple plugin that checks that all google.protobuf.Timestamp fields end in a specific suffix (default is "_time").`,
 			SPDXLicenseID: "apache-2.0",
 			LicenseURL:    "https://github.com/bufbuild/bufplugin-go/blob/main/LICENSE",
-			DocShort:      `A simple plugin that checks that all google.protobuf.Timestamp fields end in a specific suffix (default is "_time").`,
 		},
 	}
 )
diff --git a/check/internal/example/gen/acme/option/v1/option.pb.go b/check/internal/example/gen/acme/option/v1/option.pb.go
diff --git a/check/server.go b/check/server.go
@@ -84,10 +84,10 @@ func NewServer(spec *Spec, options ...ServerOption) (pluginrpc.Server, error) {
 		if err != nil {
 			return nil, err
 		}
-		if doc := pluginInfo.Doc(); doc != nil {
+		if documentation := pluginInfo.Documentation(); documentation != "" {
 			pluginrpcServerOptions = append(
 				pluginrpcServerOptions,
-				pluginrpc.ServerWithDoc(doc.String()),
+				pluginrpc.ServerWithDoc(documentation),
 			)
 		}
 	}
diff --git a/go.mod b/go.mod
@@ -5,17 +5,17 @@ go 1.21
 toolchain go1.23.1
 
 require (
-	buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.34.2-20240928190436-5e8abcfd7a7e.2
+	buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.35.1-20241023225133-42bdb4b67625.1
 	buf.build/go/spdx v0.2.0
 	github.com/bufbuild/protocompile v0.14.1
-	github.com/bufbuild/protovalidate-go v0.7.0
+	github.com/bufbuild/protovalidate-go v0.7.3-0.20241015162221-1446f1e1d576
 	github.com/stretchr/testify v1.9.0
-	google.golang.org/protobuf v1.34.2
+	google.golang.org/protobuf v1.35.1
 	pluginrpc.com/pluginrpc v0.5.0
 )
 
 require (
-	buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.34.2-20240920164238-5a7b106cbb87.2 // indirect
+	buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.35.1-20240920164238-5a7b106cbb87.1 // indirect
 	buf.build/gen/go/pluginrpc/pluginrpc/protocolbuffers/go v1.34.2-20240828222655-5345c0a56177.2 // indirect
 	github.com/antlr4-go/antlr/v4 v4.13.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
diff --git a/go.sum b/go.sum
@@ -1,7 +1,7 @@
-buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.34.2-20240928190436-5e8abcfd7a7e.2 h1:BQVQ0fcYgqpe6F/2ZPJUR1rTN+nwdrj2z7IAbAu9XAQ=
-buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.34.2-20240928190436-5e8abcfd7a7e.2/go.mod h1:B+9TKHRYqoAUW57pLjhkLOnBCu0DQYMV+f7imQ9nXwI=
-buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.34.2-20240920164238-5a7b106cbb87.2 h1:hl0FrmGlNpQZIGvU1/jDz0lsPDd0BhCE0QDRwPfLZcA=
-buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.34.2-20240920164238-5a7b106cbb87.2/go.mod h1:ylS4c28ACSI59oJrOdW4pHS4n0Hw4TgSPHn8rpHl4Yw=
+buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.35.1-20241023225133-42bdb4b67625.1 h1:O31Hu5Oho5suEWOD7FuMU9vfzeQT07ukTu4YuBVjLbw=
+buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go v1.35.1-20241023225133-42bdb4b67625.1/go.mod h1:rYPnjsUZ2lGpoQ/T322HWZQil9/MIZF2njP+/u/0GKg=
+buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.35.1-20240920164238-5a7b106cbb87.1 h1:9wP6ZZYWnF2Z0TxmII7m3XNykxnP4/w8oXeth6ekcRI=
+buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go v1.35.1-20240920164238-5a7b106cbb87.1/go.mod h1:Duw/9JoXkXIydyASnLYIiufkzySThoqavOsF+IihqvM=
 buf.build/gen/go/pluginrpc/pluginrpc/protocolbuffers/go v1.34.2-20240828222655-5345c0a56177.2 h1:oSi+Adw4xvIjXrW8eY8QGR3sBdfWeY5HN/RefnRt52M=
 buf.build/gen/go/pluginrpc/pluginrpc/protocolbuffers/go v1.34.2-20240828222655-5345c0a56177.2/go.mod h1:GjH0gjlY/ns16X8d6eaXV2W+6IFwsO5Ly9WVnzyd1E0=
 buf.build/go/spdx v0.2.0 h1:IItqM0/cMxvFJJumcBuP8NrsIzMs/UYjp/6WSpq8LTw=
@@ -10,8 +10,8 @@ github.com/antlr4-go/antlr/v4 v4.13.0 h1:lxCg3LAv+EUK6t1i0y1V6/SLeUi0eKEKdhQAlS8
 github.com/antlr4-go/antlr/v4 v4.13.0/go.mod h1:pfChB/xh/Unjila75QW7+VU4TSnWnnk9UTnmpPaOR2g=
 github.com/bufbuild/protocompile v0.14.1 h1:iA73zAf/fyljNjQKwYzUHD6AD4R8KMasmwa/FBatYVw=
 github.com/bufbuild/protocompile v0.14.1/go.mod h1:ppVdAIhbr2H8asPk6k4pY7t9zB1OU5DoEw9xY/FUi1c=
-github.com/bufbuild/protovalidate-go v0.7.0 h1:MYU9GSZM7TSsWNywvyXoEc8y3kc1MNqD3k5mddIBEL4=
-github.com/bufbuild/protovalidate-go v0.7.0/go.mod h1:PHV5pFuWlRzdDW02/cmVyNzdiQ+RNNwo7idGxdzS7o4=
+github.com/bufbuild/protovalidate-go v0.7.3-0.20241015162221-1446f1e1d576 h1:A4TfjZJqApnAvGKDgxHqA1rG6BK1OswyNcTcnSrDbJc=
+github.com/bufbuild/protovalidate-go v0.7.3-0.20241015162221-1446f1e1d576/go.mod h1:R/UFeIPyFAh0eH7Ic/JJbO2ABdkxFuZZKDbzsI5UiwM=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -54,8 +54,8 @@ google.golang.org/genproto/googleapis/api v0.0.0-20240924160255-9d4c2d233b61 h1:
 google.golang.org/genproto/googleapis/api v0.0.0-20240924160255-9d4c2d233b61/go.mod h1:O6rP0uBq4k0mdi/b4ZEMAZjkhYWhS815kCvaMha4VN8=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20240924160255-9d4c2d233b61 h1:N9BgCIAUvn/M+p4NJccWPWb3BWh88+zyL0ll9HgbEeM=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20240924160255-9d4c2d233b61/go.mod h1:UqMtugtsSgubUsoxbuAoiCXvqvErP7Gf0so0mK9tHxU=
-google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=
-google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw=
+google.golang.org/protobuf v1.35.1 h1:m3LfL6/Ca+fqnjnlqQXNpFPABW1UD7mjh8KO2mKFytA=
+google.golang.org/protobuf v1.35.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
diff --git a/info/doc.go b/info/doc.go
diff --git a/info/plugin_info.go b/info/plugin_info.go
@@ -15,30 +15,21 @@
 package info
 
 import (
-	"fmt"
 	"net/url"
 
 	infov1 "buf.build/gen/go/bufbuild/bufplugin/protocolbuffers/go/buf/plugin/info/v1"
 )
 
 // PluginInfo contains information about a plugin.
 type PluginInfo interface {
-	// URL returns the URL for a plugin.
+	// Documentation returns the documentation of the plugin.
 	//
 	// Optional.
-	//
-	// Will always be absolute.
-	//
-	// This typically is the source control repository that contains the plugin's implementation.
-	URL() *url.URL
+	Documentation() string
 	// License returns the license of the plugin.
 	//
 	// Optional.
 	License() License
-	// Doc returns the documentation of the plugin.
-	//
-	// Optional.
-	Doc() Doc
 
 	toProto() *infov1.PluginInfo
 
@@ -51,18 +42,10 @@ func NewPluginInfoForSpec(spec *Spec) (PluginInfo, error) {
 		return nil, err
 	}
 
-	var uri *url.URL
-	var err error
-	if spec.URL != "" {
-		uri, err = url.Parse(spec.URL)
-		if err != nil {
-			return nil, err
-		}
-	}
-
 	var license *license
 	if spec.SPDXLicenseID != "" || spec.LicenseText != "" || spec.LicenseURL != "" {
 		var licenseURI *url.URL
+		var err error
 		if spec.LicenseURL != "" {
 			licenseURI, err = url.Parse(spec.LicenseURL)
 			if err != nil {
@@ -78,44 +61,29 @@ func NewPluginInfoForSpec(spec *Spec) (PluginInfo, error) {
 			return nil, err
 		}
 	}
-
-	var doc *doc
-	if spec.DocShort != "" {
-		doc, err = newDoc(spec.DocShort, spec.DocLong)
-		if err != nil {
-			return nil, err
-		}
-	}
-	return newPluginInfo(uri, license, doc)
+	return newPluginInfo(spec.Documentation, license)
 }
 
 // *** PRIVATE ***
 
 type pluginInfo struct {
-	url *url.URL
+	documentation string
 	// Need to keep as pointer for Go nil is not nil problem.
 	license *license
-	// Need to keep as pointer for Go nil is not nil problem.
-	doc *doc
 }
 
 func newPluginInfo(
-	url *url.URL,
+	documentation string,
 	license *license,
-	doc *doc,
 ) (*pluginInfo, error) {
-	if url != nil && url.Host == "" {
-		return nil, fmt.Errorf("url %v must be absolute", url)
-	}
 	return &pluginInfo{
-		url:     url,
-		license: license,
-		doc:     doc,
+		documentation: documentation,
+		license:       license,
 	}, nil
 }
 
-func (p *pluginInfo) URL() *url.URL {
-	return p.url
+func (p *pluginInfo) Documentation() string {
+	return p.documentation
 }
 
 func (p *pluginInfo) License() License {
@@ -126,23 +94,10 @@ func (p *pluginInfo) License() License {
 	return p.license
 }
 
-func (p *pluginInfo) Doc() Doc {
-	// Go nil is not nil problem.
-	if p.doc == nil {
-		return nil
-	}
-	return p.doc
-}
-
 func (p *pluginInfo) toProto() *infov1.PluginInfo {
-	var urlString string
-	if p.url != nil {
-		urlString = p.url.String()
-	}
 	return &infov1.PluginInfo{
-		Url:     urlString,
-		License: p.license.toProto(),
-		Doc:     p.doc.toProto(),
+		Documentation: p.documentation,
+		License:       p.license.toProto(),
 	}
 }
 
@@ -152,21 +107,9 @@ func pluginInfoForProtoPluginInfo(protoPluginInfo *infov1.PluginInfo) (PluginInf
 	if protoPluginInfo == nil {
 		return nil, nil
 	}
-	var uri *url.URL
-	if urlString := protoPluginInfo.GetUrl(); urlString != "" {
-		var err error
-		uri, err = url.Parse(urlString)
-		if err != nil {
-			return nil, err
-		}
-	}
 	license, err := licenseForProtoLicense(protoPluginInfo.GetLicense())
 	if err != nil {
 		return nil, err
 	}
-	doc, err := docForProtoDoc(protoPluginInfo.GetDoc())
-	if err != nil {
-		return nil, err
-	}
-	return newPluginInfo(uri, license, doc)
+	return newPluginInfo(protoPluginInfo.GetDocumentation(), license)
 }
diff --git a/info/spec.go b/info/spec.go

Original file line number	Diff line number	Diff line change
`@@ -79,10 +79,9 @@ var (`
`79`	`79`	`},`
`80`	`80`	`// Optional.`
`81`	`81`	`Info: &info.Spec{`
`82`		`- URL: "https://github.com/bufbuild/bufplugin-go",`
	`82`	+ Documentation: `A simple plugin that checks that all google.protobuf.Timestamp fields end in a specific suffix (default is "_time").`,
`83`	`83`	`SPDXLicenseID: "apache-2.0",`
`84`	`84`	`LicenseURL: "https://github.com/bufbuild/bufplugin-go/blob/main/LICENSE",`
`85`		- DocShort: `A simple plugin that checks that all google.protobuf.Timestamp fields end in a specific suffix (default is "_time").`,
`86`	`85`	`},`
`87`	`86`	`}`
`88`	`87`	`)`
Original file line number	Diff line number	Diff line change
`@@ -84,10 +84,10 @@ func NewServer(spec *Spec, options ...ServerOption) (pluginrpc.Server, error) {`
`84`	`84`	`if err != nil {`
`85`	`85`	`return nil, err`
`86`	`86`	`}`
`87`		`- if doc := pluginInfo.Doc(); doc != nil {`
	`87`	`+ if documentation := pluginInfo.Documentation(); documentation != "" {`
`88`	`88`	`pluginrpcServerOptions = append(`
`89`	`89`	`pluginrpcServerOptions,`
`90`		`- pluginrpc.ServerWithDoc(doc.String()),`
	`90`	`+ pluginrpc.ServerWithDoc(documentation),`
`91`	`91`	`)`
`92`	`92`	`}`
`93`	`93`	`}`