feat: Ability to include the repository URL of a package in pubspec.yaml (#2229)

brianquinlan · web-flow · commit 2f526a329d37 · 2025-09-18T14:28:05.000-04:00
diff --git a/internal/sidekick/internal/dart/annotate.go b/internal/sidekick/internal/dart/annotate.go
@@ -52,6 +52,7 @@ type modelAnnotations struct {
 	Imports             []string
 	DevDependencies     []string
 	DoNotPublish        bool
+	RepositoryURL       string
 }
 
 // HasServices returns true if the model has services.
@@ -210,6 +211,7 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		partFileReference   string
 		doNotPublish        bool
 		devDependencies     = []string{}
+		repositoryURL       string
 	)
 
 	for key, definition := range options {
@@ -234,6 +236,8 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 				)
 			}
 			doNotPublish = value
+		case key == "repository-url":
+			repositoryURL = definition
 		case strings.HasPrefix(key, "proto:"):
 			// "proto:google.protobuf" = "package:google_cloud_protobuf/protobuf.dart"
 			keys := strings.Split(key, ":")
@@ -315,6 +319,7 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		PackageDependencies: packageDependencies,
 		DevDependencies:     devDependencies,
 		DoNotPublish:        doNotPublish,
+		RepositoryURL:       repositoryURL,
 	}
 
 	model.Codec = ann
diff --git a/internal/sidekick/internal/dart/annotate_test.go b/internal/sidekick/internal/dart/annotate_test.go
@@ -44,7 +44,7 @@ func TestAnnotateModel(t *testing.T) {
 func TestAnnotateModel_Options(t *testing.T) {
 	model := api.NewTestAPI([]*api.Message{}, []*api.Enum{}, []*api.Service{})
 
-	var foo = []struct {
+	var tests = []struct {
 		options map[string]string
 		verify  func(*testing.T, *annotateModel)
 	}{
@@ -84,6 +84,15 @@ func TestAnnotateModel_Options(t *testing.T) {
 				}
 			},
 		},
+		{
+			map[string]string{"repository-url": "http://example.com/repo"},
+			func(t *testing.T, am *annotateModel) {
+				codec := model.Codec.(*modelAnnotations)
+				if diff := cmp.Diff("http://example.com/repo", codec.RepositoryURL); diff != "" {
+					t.Errorf("mismatch in Codec.RepositoryURL (-want, +got)\n:%s", diff)
+				}
+			},
+		},
 		{
 			map[string]string{"package:http": "1.2.0"},
 			func(t *testing.T, am *annotateModel) {
@@ -94,7 +103,7 @@ func TestAnnotateModel_Options(t *testing.T) {
 		},
 	}
 
-	for _, tt := range foo {
+	for _, tt := range tests {
 		annotate := newAnnotateModel(model)
 		err := annotate.annotateModel(tt.options)
 		if err != nil {
diff --git a/internal/sidekick/internal/dart/templates/pubspec.yaml.mustache b/internal/sidekick/internal/dart/templates/pubspec.yaml.mustache
@@ -20,6 +20,9 @@ limitations under the License.
 
 name: {{Codec.PackageName}}
 description: The Google Cloud client library for the {{{Title}}}.
+{{#Codec.RepositoryURL}}
+repository: {{Codec.RepositoryURL}}
+{{/Codec.RepositoryURL}}
 {{^Codec.DoNotPublish}}
 version: {{Codec.PackageVersion}}
 {{/Codec.DoNotPublish}}

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@ type modelAnnotations struct {`
`52`	`52`	`Imports []string`
`53`	`53`	`DevDependencies []string`
`54`	`54`	`DoNotPublish bool`
	`55`	`+ RepositoryURL string`
`55`	`56`	`}`
`56`	`57`
`57`	`58`	`// HasServices returns true if the model has services.`
`@@ -210,6 +211,7 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {`
`210`	`211`	`partFileReference string`
`211`	`212`	`doNotPublish bool`
`212`	`213`	`devDependencies = []string{}`
	`214`	`+ repositoryURL string`
`213`	`215`	`)`
`214`	`216`
`215`	`217`	`for key, definition := range options {`
`@@ -234,6 +236,8 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {`
`234`	`236`	`)`
`235`	`237`	`}`
`236`	`238`	`doNotPublish = value`
	`239`	`+ case key == "repository-url":`
	`240`	`+ repositoryURL = definition`
`237`	`241`	`case strings.HasPrefix(key, "proto:"):`
`238`	`242`	`// "proto:google.protobuf" = "package:google_cloud_protobuf/protobuf.dart"`
`239`	`243`	`keys := strings.Split(key, ":")`
`@@ -315,6 +319,7 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {`
`315`	`319`	`PackageDependencies: packageDependencies,`
`316`	`320`	`DevDependencies: devDependencies,`
`317`	`321`	`DoNotPublish: doNotPublish,`
	`322`	`+ RepositoryURL: repositoryURL,`
`318`	`323`	`}`
`319`	`324`
`320`	`325`	`model.Codec = ann`