feat(dart): Allow library name overrides (#3335)

Signed-off-by: Brian Quinlan <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: brianquinlan

internal/sidekick/dart/annotate.go

@@ -62,12 +62,12 @@ type modelAnnotations struct {
 	// The version of the generated package.
 	PackageVersion string
 	// Name of the API in snake_format (e.g. secretmanager).
-	MainFileName      string
-	SourcePackageName string
-	CopyrightYear     string
-	BoilerPlate       []string
-	DefaultHost       string
-	DocLines          []string
+	MainFileNameWithExtension string
+	SourcePackageName         string
+	CopyrightYear             string
+	BoilerPlate               []string
+	DefaultHost               string
+	DocLines                  []string
 	// A reference to an optional hand-written part file.
 	PartFileReference          string
 	PackageDependencies        []packageDependency
@@ -251,6 +251,7 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 	var (
 		packageNameOverride        string
 		generationYear             string
+		libraryPathOverride        string
 		packageVersion             string
 		partFileReference          string
 		doNotPublish               bool
@@ -276,6 +277,10 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 			for i := range apiKeyEnvironmentVariables {
 				apiKeyEnvironmentVariables[i] = strings.TrimSpace(apiKeyEnvironmentVariables[i])
 			}
+		case key == "library-path-override":
+			// library-path-override = "src/buffers.dart"
+			// The path to use for the generated file, relative to the package's "lib/" directory.
+			libraryPathOverride = definition
 		case key == "package-name-override":
 			packageNameOverride = definition
 		case key == "copyright-year":
@@ -403,17 +408,19 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		return err
 	}
 
-	mainFileName := strcase.ToSnake(model.Name)
-	mainFileNameWithExtension := mainFileName + ".dart"
+	mainFileNameWithExtension := strcase.ToSnake(model.Name) + ".dart"
+	if libraryPathOverride != "" {
+		mainFileNameWithExtension = libraryPathOverride
+	}
 
 	slices.Sort(devDependencies)
 
 	ann := &modelAnnotations{
-		Parent:         model,
-		PackageName:    pkgName,
-		PackageVersion: packageVersion,
-		MainFileName:   mainFileName,
-		CopyrightYear:  generationYear,
+		Parent:                    model,
+		PackageName:               pkgName,
+		PackageVersion:            packageVersion,
+		MainFileNameWithExtension: mainFileNameWithExtension,
+		CopyrightYear:             generationYear,
 		BoilerPlate: append(license.LicenseHeaderBulk(),
 			"",
 			" Code generated by sidekick. DO NOT EDIT."),

internal/sidekick/dart/annotate_test.go

@@ -52,8 +52,8 @@ func TestAnnotateModel(t *testing.T) {
 	if diff := cmp.Diff("google_cloud_test", codec.PackageName); diff != "" {
 		t.Errorf("mismatch in Codec.PackageName (-want, +got)\n:%s", diff)
 	}
-	if diff := cmp.Diff("test", codec.MainFileName); diff != "" {
-		t.Errorf("mismatch in Codec.MainFileName (-want, +got)\n:%s", diff)
+	if diff := cmp.Diff("test.dart", codec.MainFileNameWithExtension); diff != "" {
+		t.Errorf("mismatch in Codec.MainFileNameWithExtension (-want, +got)\n:%s", diff)
 	}
 }
 
@@ -64,6 +64,15 @@ func TestAnnotateModel_Options(t *testing.T) {
 		options map[string]string
 		verify  func(*testing.T, *annotateModel)
 	}{
+		{
+			map[string]string{"library-path-override": "src/buffers.dart"},
+			func(t *testing.T, am *annotateModel) {
+				codec := model.Codec.(*modelAnnotations)
+				if diff := cmp.Diff("src/buffers.dart", codec.MainFileNameWithExtension); diff != "" {
+					t.Errorf("mismatch in Codec.MainFileNameWithExtension (-want, +got)\n:%s", diff)
+				}
+			},
+		},
 		{
 			map[string]string{"package-name-override": "google-cloud-type"},
 			func(t *testing.T, am *annotateModel) {

internal/sidekick/dart/generate.go

@@ -59,15 +59,15 @@ func templatesProvider() language.TemplateProvider {
 
 func generatedFiles(model *api.API) []language.GeneratedFile {
 	codec := model.Codec.(*modelAnnotations)
-	mainFileName := codec.MainFileName
+	mainFileNameWithExtension := codec.MainFileNameWithExtension
 
 	files := language.WalkTemplatesDir(dartTemplates, "templates")
 
 	for index, fileInfo := range files {
 		// Replace 'main.dart' with '{servicename}.dart'
 		if filepath.Base(fileInfo.TemplatePath) == "main.dart.mustache" {
 			outDir := filepath.Dir(fileInfo.OutputPath)
-			fileInfo.OutputPath = filepath.Join(outDir, mainFileName+".dart")
+			fileInfo.OutputPath = filepath.Join(outDir, mainFileNameWithExtension)
 
 			files[index] = fileInfo
 		}

internal/sidekick/dart/templates/.gitattributes.mustache

@@ -1 +1 @@
-lib/{{Codec.MainFileName}}.dart linguist-generated=true
+lib/{{Codec.MainFileNameWithExtension}} linguist-generated=true