Do not generate wildcard (glob/native.glob) "srcs" in gazelle

Gazelle cannot merge such values when updating existing build files,
and adding custom logic to do so is non-trivial, especially when
applied to BUILD files (app.bzl files are less arduous but still
non-trivial).

This means that if new files are added, it's always necessary to run
gazelle.

Addresses #185

Author: HoloRin

gazelle/erlang_app.go

@@ -115,49 +115,6 @@ func multilineList[T any](values []T) build.Expr {
 	}
 }
 
-func multilineGlob(glob rule.GlobValue, macro bool) build.Expr {
-	var patternsValue build.Expr
-	if len(glob.Patterns) < 2 {
-		patternsValue = rule.ExprFromValue(glob.Patterns)
-	} else {
-		patternsValue = multilineList(glob.Patterns)
-	}
-	globArgs := []build.Expr{patternsValue}
-	if len(glob.Excludes) > 0 {
-		excludesValue := multilineList(glob.Excludes)
-		globArgs = append(globArgs, &build.AssignExpr{
-			LHS: &build.LiteralExpr{Token: "exclude"},
-			Op:  "=",
-			RHS: excludesValue,
-		})
-	}
-	token := "glob"
-	if macro {
-		token = "native.glob"
-	}
-	return &build.CallExpr{
-		X:              &build.LiteralExpr{Token: token},
-		List:           globArgs,
-		ForceMultiLine: len(glob.Excludes) > 0,
-	}
-}
-
-func explicitPlusGlobExpr(
-	explicit []string,
-	glob rule.GlobValue,
-	macro bool,
-) build.Expr {
-	if len(explicit) == 0 {
-		return multilineGlob(glob, macro)
-	}
-
-	return &build.BinaryExpr{
-		X:  multilineList(explicit),
-		Op: "+",
-		Y:  multilineGlob(glob, macro),
-	}
-}
-
 func (erlangApp *ErlangApp) pathFor(from, include string) string {
 	directPath := filepath.Join(filepath.Dir(from), include)
 	privatePath := filepath.Join("src", include)
@@ -317,18 +274,7 @@ func (erlangApp *ErlangApp) BeamFilesRules(args language.GenerateArgs, erlParser
 			othersRule = rule.NewRule(erlangBytecodeKind, "other_beam")
 			othersRule.SetAttr("app_name", erlangApp.Name)
 			othersRule.SetAttr("erlc_opts", "//:"+erlcOptsRuleName)
-			othersSrcsGen := mutable_set.Map(others.Filter(func(v *ErlangAppFileParsed) bool {
-				return v.IsGenFile
-			}), (*ErlangAppFileParsed).path).Values(strings.Compare)
-			otherSrcsExcludes := mutable_set.Map(mutable_set.Union(transforms, behaviours), (*ErlangAppFileParsed).path).Values(strings.Compare)
-			othersRule.SetAttr("srcs", explicitPlusGlobExpr(
-				othersSrcsGen,
-				rule.GlobValue{
-					Patterns: []string{"src/**/*.erl"},
-					Excludes: otherSrcsExcludes,
-				},
-				erlangConfig.GenerateBeamFilesMacro,
-			))
+			othersRule.SetAttr("srcs", multilineList(others.Values(comparePaths)))
 			othersRule.SetAttr("hdrs", []string{":public_and_private_hdrs"})
 			othersRule.SetAttr("dest", "ebin")
 			if len(beamFilesGroupRules) > 0 {
@@ -480,18 +426,7 @@ func (erlangApp *ErlangApp) testBeamFilesRules(args language.GenerateArgs, erlPa
 			othersRule.SetAttr("testonly", true)
 			othersRule.SetAttr("app_name", erlangApp.Name)
 			othersRule.SetAttr("erlc_opts", "//:"+testErlcOptsRuleName)
-			othersSrcsGen := mutable_set.Map(others.Filter(func(v *ErlangAppFileParsed) bool {
-				return v.IsGenFile
-			}), (*ErlangAppFileParsed).path).Values(strings.Compare)
-			otherSrcsExcludes := mutable_set.Map(mutable_set.Union(transforms, behaviours), (*ErlangAppFileParsed).path).Values(strings.Compare)
-			othersRule.SetAttr("srcs", explicitPlusGlobExpr(
-				othersSrcsGen,
-				rule.GlobValue{
-					Patterns: []string{"src/**/*.erl"},
-					Excludes: otherSrcsExcludes,
-				},
-				erlangConfig.GenerateBeamFilesMacro,
-			))
+			othersRule.SetAttr("srcs", multilineList(others.Values(comparePaths)))
 			othersRule.SetAttr("hdrs", []string{":public_and_private_hdrs"})
 			othersRule.SetAttr("dest", "test")
 			if len(beamFilesGroupRules) > 0 {
@@ -555,121 +490,52 @@ func (erlangApp *ErlangApp) allSrcsRules(args language.GenerateArgs) (rules []*r
 	erlangConfig := erlangConfigForRel(args.Config, args.Rel)
 
 	srcs := rule.NewRule("filegroup", "srcs")
-	if erlangConfig.GenerateFewerBytecodeRules {
-		srcsGen := mutable_set.Map(erlangApp.Srcs.Filter(func(v *ErlangAppFileParsed) bool {
-			return v.IsGenFile
-		}), (*ErlangAppFileParsed).path).Values(strings.Compare)
-		srcs.SetAttr("srcs", explicitPlusGlobExpr(
-			srcsGen,
-			rule.GlobValue{
-				Patterns: []string{
-					"src/**/*.erl",
-					"src/**/*.app.src",
-				},
-			},
-			erlangConfig.GenerateBeamFilesMacro,
-		))
-	} else {
-		srcsSrcs := mutable_set.Union(
-			mutable_set.Map(erlangApp.Srcs, (*ErlangAppFileParsed).path),
-			mutable_set.Map(erlangApp.AppSrc, (*ErlangAppFile).path),
-		).Values(strings.Compare)
-		if len(srcsSrcs) > 0 {
-			srcs.SetAttr("srcs", multilineList(srcsSrcs))
-		}
+	srcsSrcs := mutable_set.Union(
+		mutable_set.Map(erlangApp.Srcs, (*ErlangAppFileParsed).path),
+		mutable_set.Map(erlangApp.AppSrc, (*ErlangAppFile).path),
+	).Values(strings.Compare)
+	if len(srcsSrcs) > 0 {
+		srcs.SetAttr("srcs", multilineList(srcsSrcs))
 	}
 	if erlangConfig.Testonly {
 		srcs.SetAttr("testonly", true)
 	}
 	rules = append(rules, srcs)
 
 	private_hdrs := rule.NewRule("filegroup", "private_hdrs")
-	if erlangConfig.GenerateFewerBytecodeRules {
-		privateHdrsGen := mutable_set.Map(erlangApp.PrivateHdrs.Filter(func(v *ErlangAppFile) bool {
-			return v.IsGenFile
-		}), (*ErlangAppFile).path).Values(strings.Compare)
-		private_hdrs.SetAttr("srcs", explicitPlusGlobExpr(
-			privateHdrsGen,
-			rule.GlobValue{
-				Patterns: []string{"src/**/*.hrl"},
-			},
-			erlangConfig.GenerateBeamFilesMacro,
-		))
-	} else {
-		if !erlangApp.PrivateHdrs.IsEmpty() {
-			private_hdrs.SetAttr("srcs", multilineList(
-				erlangApp.PrivateHdrs.Values(comparePaths2)))
-		}
+	if !erlangApp.PrivateHdrs.IsEmpty() {
+		private_hdrs.SetAttr("srcs", multilineList(
+			erlangApp.PrivateHdrs.Values(comparePaths2)))
 	}
 	if erlangConfig.Testonly {
 		private_hdrs.SetAttr("testonly", true)
 	}
 	rules = append(rules, private_hdrs)
 
 	public_hdrs := rule.NewRule("filegroup", "public_hdrs")
-	if erlangConfig.GenerateFewerBytecodeRules {
-		publicHdrsGen := mutable_set.Map(erlangApp.PublicHdrs.Filter(func(v *ErlangAppFile) bool {
-			return v.IsGenFile
-		}), (*ErlangAppFile).path).Values(strings.Compare)
-		public_hdrs.SetAttr("srcs", explicitPlusGlobExpr(
-			publicHdrsGen,
-			rule.GlobValue{
-				Patterns: []string{"include/**/*.hrl"},
-			},
-			erlangConfig.GenerateBeamFilesMacro,
-		))
-	} else {
-		if !erlangApp.PublicHdrs.IsEmpty() {
-			public_hdrs.SetAttr("srcs", multilineList(
-				erlangApp.PublicHdrs.Values(comparePaths2)))
-		}
-
+	if !erlangApp.PublicHdrs.IsEmpty() {
+		public_hdrs.SetAttr("srcs", multilineList(
+			erlangApp.PublicHdrs.Values(comparePaths2)))
 	}
 	if erlangConfig.Testonly {
 		public_hdrs.SetAttr("testonly", true)
 	}
 	rules = append(rules, public_hdrs)
 
 	priv := rule.NewRule("filegroup", "priv")
-	if erlangConfig.GenerateFewerBytecodeRules {
-		privGen := mutable_set.Map(erlangApp.Priv.Filter(func(v *ErlangAppFile) bool {
-			return v.IsGenFile
-		}), (*ErlangAppFile).path).Values(strings.Compare)
-		priv.SetAttr("srcs", explicitPlusGlobExpr(
-			privGen,
-			rule.GlobValue{
-				Patterns: []string{"priv/**/*"},
-			},
-			erlangConfig.GenerateBeamFilesMacro,
-		))
-	} else {
-		if !erlangApp.Priv.IsEmpty() {
-			priv.SetAttr("srcs", multilineList(
-				erlangApp.Priv.Values(comparePaths2)))
-		}
+	if !erlangApp.Priv.IsEmpty() {
+		priv.SetAttr("srcs", multilineList(
+			erlangApp.Priv.Values(comparePaths2)))
 	}
 	if erlangConfig.Testonly {
 		priv.SetAttr("testonly", true)
 	}
 	rules = append(rules, priv)
 
 	licenses := rule.NewRule("filegroup", "license_files")
-	if erlangConfig.GenerateFewerBytecodeRules {
-		licensesGen := mutable_set.Map(erlangApp.LicenseFiles.Filter(func(v *ErlangAppFile) bool {
-			return v.IsGenFile
-		}), (*ErlangAppFile).path).Values(strings.Compare)
-		licenses.SetAttr("srcs", explicitPlusGlobExpr(
-			licensesGen,
-			rule.GlobValue{
-				Patterns: []string{"LICENSE*"},
-			},
-			erlangConfig.GenerateBeamFilesMacro,
-		))
-	} else {
-		if !erlangApp.LicenseFiles.IsEmpty() {
-			licenses.SetAttr("srcs", multilineList(
-				erlangApp.LicenseFiles.Values(comparePaths2)))
-		}
+	if !erlangApp.LicenseFiles.IsEmpty() {
+		licenses.SetAttr("srcs", multilineList(
+			erlangApp.LicenseFiles.Values(comparePaths2)))
 	}
 	if erlangConfig.Testonly {
 		licenses.SetAttr("testonly", true)

test/gazelle/erlang_test.go

@@ -407,10 +407,8 @@ var _ = Describe("an ErlangApp", func() {
 			Expect(rules[2].Name()).To(Equal("other_beam"))
 			Expect(rules[2].AttrString("app_name")).To(Equal(app.Name))
 			Expect(rules[2].AttrString("erlc_opts")).To(Equal("//:erlc_opts"))
-			Expect(strings.NewReplacer("\n", "", " ", "").Replace(
-				build.FormatString(rules[2].Attr("srcs"))),
-			).To(
-				Equal("glob([\"src/**/*.erl\"],exclude=[\"src/bar.erl\",\"src/baz.erl\",\"src/xform.erl\",],)"),
+			Expect(rules[2].AttrStrings("srcs")).To(
+				ConsistOf("src/foo.erl"),
 			)
 			Expect(rules[2].AttrString("dest")).To(Equal("ebin"))
 			Expect(rules[2].AttrStrings("beam")).To(

test/gazelle/testdata/basic_hex_tar_no_tests/BUILD.out

@@ -50,7 +50,7 @@ erlang_bytecode(
         "src/aten_emitter.erl",
         "src/aten_sink.erl",
         "src/aten_sup.erl",
-    ] + glob(["src/**/*.erl"]),
+    ],
     hdrs = [":public_and_private_hdrs"],
     app_name = "aten",
     dest = "ebin",
@@ -65,41 +65,30 @@ filegroup(
 filegroup(
     name = "srcs",
     srcs = [
+        "src/aten.app.src",
         "src/aten.erl",
         "src/aten_app.erl",
         "src/aten_detect.erl",
         "src/aten_detector.erl",
         "src/aten_emitter.erl",
         "src/aten_sink.erl",
         "src/aten_sup.erl",
-    ] + glob([
-        "src/**/*.app.src",
-        "src/**/*.erl",
-    ]),
+    ],
 )
 
-filegroup(
-    name = "private_hdrs",
-    srcs = glob(["src/**/*.hrl"]),
-)
+filegroup(name = "private_hdrs")
 
-filegroup(
-    name = "public_hdrs",
-    srcs = glob(["include/**/*.hrl"]),
-)
+filegroup(name = "public_hdrs")
 
-filegroup(
-    name = "priv",
-    srcs = glob(["priv/**/*"]),
-)
+filegroup(name = "priv")
 
 filegroup(
     name = "license_files",
     srcs = [
         "LICENSE",
         "LICENSE-APACHE2",
         "LICENSE-MPL-RabbitMQ",
-    ] + glob(["LICENSE*"]),
+    ],
 )
 
 filegroup(

test/gazelle/testdata/basic_rebar_compact_rules/BUILD.out

@@ -52,7 +52,12 @@ plt(
 
 erlang_bytecode(
     name = "other_beam",
-    srcs = glob(["src/**/*.erl"]),
+    srcs = [
+        "src/seshat.erl",
+        "src/seshat_app.erl",
+        "src/seshat_counters_server.erl",
+        "src/seshat_sup.erl",
+    ],
     hdrs = [":public_and_private_hdrs"],
     app_name = "seshat",
     dest = "ebin",
@@ -62,7 +67,12 @@ erlang_bytecode(
 erlang_bytecode(
     name = "test_other_beam",
     testonly = True,
-    srcs = glob(["src/**/*.erl"]),
+    srcs = [
+        "src/seshat.erl",
+        "src/seshat_app.erl",
+        "src/seshat_counters_server.erl",
+        "src/seshat_sup.erl",
+    ],
     hdrs = [":public_and_private_hdrs"],
     app_name = "seshat",
     dest = "test",
@@ -100,30 +110,28 @@ erlang_bytecode(
 
 filegroup(
     name = "srcs",
-    srcs = glob([
-        "src/**/*.app.src",
-        "src/**/*.erl",
-    ]),
+    srcs = [
+        "src/seshat.app.src",
+        "src/seshat.erl",
+        "src/seshat_app.erl",
+        "src/seshat_counters_server.erl",
+        "src/seshat_sup.erl",
+    ],
 )
 
-filegroup(
-    name = "private_hdrs",
-    srcs = glob(["src/**/*.hrl"]),
-)
+filegroup(name = "private_hdrs")
 
-filegroup(
-    name = "public_hdrs",
-    srcs = glob(["include/**/*.hrl"]),
-)
+filegroup(name = "public_hdrs")
 
-filegroup(
-    name = "priv",
-    srcs = glob(["priv/**/*"]),
-)
+filegroup(name = "priv")
 
 filegroup(
     name = "license_files",
-    srcs = glob(["LICENSE*"]),
+    srcs = [
+        "LICENSE",
+        "LICENSE-APACHE2",
+        "LICENSE-MPL-RabbitMQ",
+    ],
 )
 
 filegroup(