Merge branch 'main' into st/buildifier-rule-load-location

bazelbuild · Jan 29, 2025 · 3a2c86a · 3a2c86a
2 parents 283c8f9 + 1d76340
commit 3a2c86a
Show file tree

Hide file tree

Showing 15 changed files with 479 additions and 83 deletions.
diff --git a/WARNINGS.md b/WARNINGS.md
@@ -39,8 +39,25 @@ Warning categories supported by buildifier's linter:
   * [`name-conventions`](#name-conventions)
   * [`native-android`](#native-android)
   * [`native-build`](#native-build)
-  * [`native-cc`](#native-cc)
+  * [`native-cc-binary`](#native-cc-binary)
+  * [`native-cc-common`](#native-cc-common)
+  * [`native-cc-debug-package-info`](#native-cc-debug-package-info)
+  * [`native-cc-fdo-prefetch-hints`](#native-cc-fdo-prefetch-hints)
+  * [`native-cc-fdo-profile`](#native-cc-fdo-profile)
+  * [`native-cc-import`](#native-cc-import)
+  * [`native-cc-info`](#native-cc-info)
+  * [`native-cc-library`](#native-cc-library)
+  * [`native-cc-memprof-profile`](#native-cc-memprof-profile)
+  * [`native-cc-objc-import`](#native-cc-objc-import)
+  * [`native-cc-objc-library`](#native-cc-objc-library)
+  * [`native-cc-propeller-optimize`](#native-cc-propeller-optimize)
   * [`native-cc-proto`](#native-cc-proto)
+  * [`native-cc-shared-library`](#native-cc-shared-library)
+  * [`native-cc-shared-library-hint-info`](#native-cc-shared-library-hint-info)
+  * [`native-cc-shared-library-info`](#native-cc-shared-library-info)
+  * [`native-cc-test`](#native-cc-test)
+  * [`native-cc-toolchain`](#native-cc-toolchain)
+  * [`native-cc-toolchain-suite`](#native-cc-toolchain-suite)
   * [`native-java-binary`](#native-java-binary)
   * [`native-java-common`](#native-java-common)
   * [`native-java-import`](#native-java-import)
@@ -61,6 +78,9 @@ Warning categories supported by buildifier's linter:
   * [`native-proto-lang-toolchain`](#native-proto-lang-toolchain)
   * [`native-proto-lang-toolchain-info`](#native-proto-lang-toolchain-info)
   * [`native-py`](#native-py)
+  * [`native-sh-binary`](#native-sh-binary)
+  * [`native-sh-library`](#native-sh-library)
+  * [`native-sh-test`](#native-sh-test)
   * [`no-effect`](#no-effect)
   * [`out-of-order-load`](#out-of-order-load)
   * [`output-group`](#output-group)
@@ -696,18 +716,32 @@ as global symbols there.
 
 --------------------------------------------------------------------------------
 
-## <a name="native-cc"></a>All C++ build rules should be loaded from Starlark
+## <a name="native-cc-binary"></a><a name="native-cc-common"></a><a name="native-cc-debug-package-info"></a><a name="native-cc-fdo-prefetch-hints"></a><a name="native-cc-fdo-profile"></a><a name="native-cc-import"></a><a name="native-cc-info"></a><a name="native-cc-library"></a><a name="native-cc-memprof-profile"></a><a name="native-cc-objc-import"></a><a name="native-cc-objc-library"></a><a name="native-cc-propeller-optimize"></a><a name="native-cc-shared-library"></a><a name="native-cc-shared-library-hint-info"></a><a name="native-cc-shared-library-info"></a><a name="native-cc-test"></a><a name="native-cc-toolchain"></a><a name="native-cc-toolchain-suite"></a>All C++ build rules should be loaded from Starlark
 
-  * Category name: `native-cc`
-  * Flag in Bazel: [`--incompatible_load_cc_rules_from_bzl`](https://github.com/bazelbuild/bazel/issues/8743)
+  * Category names:
+    * `native-cc-binary`
+    * `native-cc-common`
+    * `native-cc-debug-package-info`
+    * `native-cc-fdo-prefetch-hints`
+    * `native-cc-fdo-profile`
+    * `native-cc-import`
+    * `native-cc-info`
+    * `native-cc-library`
+    * `native-cc-memprof-profile`
+    * `native-cc-objc-import`
+    * `native-cc-objc-library`
+    * `native-cc-propeller-optimize`
+    * `native-cc-shared-library`
+    * `native-cc-shared-library-hint-info`
+    * `native-cc-shared-library-info`
+    * `native-cc-test`
+    * `native-cc-toolchain`
+    * `native-cc-toolchain-suite`
+  * Flag in Bazel: [`--incompatible_autoload_externally`](https://github.com/bazelbuild/bazel/issues/23043)
   * Automatic fix: yes
-  * [Suppress the warning](#suppress): `# buildifier: disable=native-cc`
-
-The CC build rules should be loaded from Starlark.
+  * [Suppress the warning](#suppress): `# buildifier: disable=native-cc-binary`, `# buildifier: disable=native-cc-common`, `# buildifier: disable=native-cc-debug-package-info`, `# buildifier: disable=native-cc-fdo-prefetch-hints`, `# buildifier: disable=native-cc-fdo-profile`, `# buildifier: disable=native-cc-import`, `# buildifier: disable=native-cc-info`, `# buildifier: disable=native-cc-library`, `# buildifier: disable=native-cc-memprof-profile`, `# buildifier: disable=native-cc-objc-import`, `# buildifier: disable=native-cc-objc-library`, `# buildifier: disable=native-cc-propeller-optimize`, `# buildifier: disable=native-cc-shared-library`, `# buildifier: disable=native-cc-shared-library-hint-info`, `# buildifier: disable=native-cc-shared-library-info`, `# buildifier: disable=native-cc-test`, `# buildifier: disable=native-cc-toolchain`, `# buildifier: disable=native-cc-toolchain-suite`
 
-Update: the plans for disabling native rules
-[have been postponed](https://groups.google.com/g/bazel-discuss/c/XNvpWcge4AE/m/aJ-aQzszAwAJ),
-at the moment it's not required to load Starlark rules.
+The C++ build rules should be loaded from @rules_cc.
 
 --------------------------------------------------------------------------------
 
@@ -946,6 +980,36 @@ at the moment it's not required to load Starlark rules.
 
 --------------------------------------------------------------------------------
 
+## <a name="native-sh-binary"></a>sh_binary build rules should be loaded from Starlark
+
+  * Category name: `native-sh-binary`
+  * Automatic fix: yes
+  * [Suppress the warning](#suppress): `# buildifier: disable=native-sh-binary`
+
+The sh_binary build rules should be loaded from Starlark.
+
+--------------------------------------------------------------------------------
+
+## <a name="native-sh-library"></a>sh_library build rules should be loaded from Starlark
+
+  * Category name: `native-sh-library`
+  * Automatic fix: yes
+  * [Suppress the warning](#suppress): `# buildifier: disable=native-sh-library`
+
+The sh_library build rules should be loaded from Starlark.
+
+--------------------------------------------------------------------------------
+
+## <a name="native-sh-test"></a>sh_test build rules should be loaded from Starlark
+
+  * Category name: `native-sh-test`
+  * Automatic fix: yes
+  * [Suppress the warning](#suppress): `# buildifier: disable=native-sh-test`
+
+The sh_test build rules should be loaded from Starlark.
+
+--------------------------------------------------------------------------------
+
 ## <a name="no-effect"></a>Expression result is not used
 
   * Category name: `no-effect`

diff --git a/build/print.go b/build/print.go
@@ -955,6 +955,10 @@ func (p *printer) useCompactMode(start *Position, list *[]Expr, end *End, mode s
 	if mode == modeSeq {
 		return true
 	}
+	// Use compact mode for empty call expressions if ForceMultiLine is not set
+	if mode == modeCall && len(*list) == 0 && !forceMultiLine {
+		return true
+	}
 
 	// In the Default and .bzl printing modes try to keep the original printing style.
 	// Non-top-level statements and lists of arguments of a function definition

diff --git a/build/rewrite.go b/build/rewrite.go
@@ -138,6 +138,7 @@ var rewrites = []struct {
 	{"reorderarguments", reorderArguments, scopeBoth},
 	{"editoctal", editOctals, scopeBoth},
 	{"editfloat", editFloats, scopeBoth},
+	{"collapseEmpty", collapseEmpty, scopeBoth},
 }
 
 // leaveAlone reports whether any of the nodes on the stack are marked
@@ -1459,3 +1460,12 @@ func removeParens(f *File, _ *Rewriter) {
 
 	Edit(f, simplify)
 }
+
+// collapseEmpty unsets ForceMultiLine for empty call expressions.
+func collapseEmpty(f *File, _ *Rewriter) {
+	Walk(f, func(expr Expr, stack []Expr) {
+		if c, ok := expr.(*CallExpr); ok && len(c.List) == 0 { // No arguments
+			c.ForceMultiLine = false
+		}
+	})
+}
diff --git a/build/testdata/076.golden b/build/testdata/076.golden
@@ -0,0 +1,18 @@
+# Test collapse empty call expressions
+
+func()
+
+func()
+
+# before comment
+func()
+
+func()  # after comment
+
+func(
+    # line comment
+)
+
+func(
+    name = "not_empty",
+)
diff --git a/build/testdata/076.in b/build/testdata/076.in
@@ -0,0 +1,22 @@
+# Test collapse empty call expressions
+
+func(
+)
+
+func(
+)
+
+# before comment
+func(
+)
+
+func(
+)  # after comment
+
+func(
+    # line comment
+)
+
+func(
+    name = "not_empty",
+)
diff --git a/buildifier/config/config_test.go b/buildifier/config/config_test.go
@@ -78,8 +78,25 @@ func ExampleExample() {
 	//     "name-conventions",
 	//     "native-android",
 	//     "native-build",
-	//     "native-cc",
+	//     "native-cc-binary",
+	//     "native-cc-common",
+	//     "native-cc-debug-package-info",
+	//     "native-cc-fdo-prefetch-hints",
+	//     "native-cc-fdo-profile",
+	//     "native-cc-import",
+	//     "native-cc-info",
+	//     "native-cc-library",
+	//     "native-cc-memprof-profile",
+	//     "native-cc-objc-import",
+	//     "native-cc-objc-library",
+	//     "native-cc-propeller-optimize",
 	//     "native-cc-proto",
+	//     "native-cc-shared-library",
+	//     "native-cc-shared-library-hint-info",
+	//     "native-cc-shared-library-info",
+	//     "native-cc-test",
+	//     "native-cc-toolchain",
+	//     "native-cc-toolchain-suite",
 	//     "native-java-binary",
 	//     "native-java-common",
 	//     "native-java-import",
@@ -100,6 +117,9 @@ func ExampleExample() {
 	//     "native-proto-lang-toolchain",
 	//     "native-proto-lang-toolchain-info",
 	//     "native-py",
+	//     "native-sh-binary",
+	//     "native-sh-library",
+	//     "native-sh-test",
 	//     "no-effect",
 	//     "output-group",
 	//     "overly-nested-depset",
@@ -277,8 +297,25 @@ func TestValidate(t *testing.T) {
 			"name-conventions",
 			"native-android",
 			"native-build",
-			"native-cc",
+			"native-cc-binary",
+			"native-cc-common",
+			"native-cc-debug-package-info",
+			"native-cc-fdo-prefetch-hints",
+			"native-cc-fdo-profile",
+			"native-cc-import",
+			"native-cc-info",
+			"native-cc-library",
+			"native-cc-memprof-profile",
+			"native-cc-objc-import",
+			"native-cc-objc-library",
+			"native-cc-propeller-optimize",
 			"native-cc-proto",
+			"native-cc-shared-library",
+			"native-cc-shared-library-hint-info",
+			"native-cc-shared-library-info",
+			"native-cc-test",
+			"native-cc-toolchain",
+			"native-cc-toolchain-suite",
 			"native-java-binary",
 			"native-java-common",
 			"native-java-import",
@@ -299,6 +336,9 @@ func TestValidate(t *testing.T) {
 			"native-proto-lang-toolchain",
 			"native-proto-lang-toolchain-info",
 			"native-py",
+			"native-sh-binary",
+			"native-sh-library",
+			"native-sh-test",
 			"no-effect",
 			"output-group",
 			"overly-nested-depset",
@@ -357,8 +397,25 @@ func TestValidate(t *testing.T) {
 			"name-conventions",
 			"native-android",
 			"native-build",
-			"native-cc",
+			"native-cc-binary",
+			"native-cc-common",
+			"native-cc-debug-package-info",
+			"native-cc-fdo-prefetch-hints",
+			"native-cc-fdo-profile",
+			"native-cc-import",
+			"native-cc-info",
+			"native-cc-library",
+			"native-cc-memprof-profile",
+			"native-cc-objc-import",
+			"native-cc-objc-library",
+			"native-cc-propeller-optimize",
 			"native-cc-proto",
+			"native-cc-shared-library",
+			"native-cc-shared-library-hint-info",
+			"native-cc-shared-library-info",
+			"native-cc-test",
+			"native-cc-toolchain",
+			"native-cc-toolchain-suite",
 			"native-java-binary",
 			"native-java-common",
 			"native-java-import",
@@ -379,6 +436,9 @@ func TestValidate(t *testing.T) {
 			"native-proto-lang-toolchain",
 			"native-proto-lang-toolchain-info",
 			"native-py",
+			"native-sh-binary",
+			"native-sh-library",
+			"native-sh-test",
 			"no-effect",
 			"output-group",
 			"overly-nested-depset",
@@ -437,8 +497,25 @@ func TestValidate(t *testing.T) {
 			"name-conventions",
 			"native-android",
 			"native-build",
-			"native-cc",
+			"native-cc-binary",
+			"native-cc-common",
+			"native-cc-debug-package-info",
+			"native-cc-fdo-prefetch-hints",
+			"native-cc-fdo-profile",
+			"native-cc-import",
+			"native-cc-info",
+			"native-cc-library",
+			"native-cc-memprof-profile",
+			"native-cc-objc-import",
+			"native-cc-objc-library",
+			"native-cc-propeller-optimize",
 			"native-cc-proto",
+			"native-cc-shared-library",
+			"native-cc-shared-library-hint-info",
+			"native-cc-shared-library-info",
+			"native-cc-test",
+			"native-cc-toolchain",
+			"native-cc-toolchain-suite",
 			"native-java-binary",
 			"native-java-common",
 			"native-java-import",
@@ -459,6 +536,9 @@ func TestValidate(t *testing.T) {
 			"native-proto-lang-toolchain",
 			"native-proto-lang-toolchain-info",
 			"native-py",
+			"native-sh-binary",
+			"native-sh-library",
+			"native-sh-test",
 			"no-effect",
 			"output-group",
 			"overly-nested-depset",
@@ -481,7 +561,7 @@ func TestValidate(t *testing.T) {
 			"unused-variable",
 			"unsorted-dict-items",
 		}},
-		"warnings error": {options: "--warnings=native-cc,-print,-deprecated-function", wantErr: fmt.Errorf(`warning categories with modifiers ("+" or "-") can't be mixed with raw warning categories`)},
+		"warnings error": {options: "--warnings=native-py,-print,-deprecated-function", wantErr: fmt.Errorf(`warning categories with modifiers ("+" or "-") can't be mixed with raw warning categories`)},
 	} {
 		t.Run(name, func(t *testing.T) {
 			c := New()

diff --git a/buildifier/integration_test.sh b/buildifier/integration_test.sh
@@ -283,8 +283,25 @@ cat > golden/.buildifier.example.json <<EOF
     "name-conventions",
     "native-android",
     "native-build",
-    "native-cc",
+    "native-cc-binary",
+    "native-cc-common",
+    "native-cc-debug-package-info",
+    "native-cc-fdo-prefetch-hints",
+    "native-cc-fdo-profile",
+    "native-cc-import",
+    "native-cc-info",
+    "native-cc-library",
+    "native-cc-memprof-profile",
+    "native-cc-objc-import",
+    "native-cc-objc-library",
+    "native-cc-propeller-optimize",
     "native-cc-proto",
+    "native-cc-shared-library",
+    "native-cc-shared-library-hint-info",
+    "native-cc-shared-library-info",
+    "native-cc-test",
+    "native-cc-toolchain",
+    "native-cc-toolchain-suite",
     "native-java-binary",
     "native-java-common",
     "native-java-import",
@@ -305,6 +322,9 @@ cat > golden/.buildifier.example.json <<EOF
     "native-proto-lang-toolchain",
     "native-proto-lang-toolchain-info",
     "native-py",
+    "native-sh-binary",
+    "native-sh-library",
+    "native-sh-test",
     "no-effect",
     "output-group",
     "overly-nested-depset",

diff --git a/buildozer/README.md b/buildozer/README.md
@@ -265,6 +265,7 @@ the attribute, a warning is printed on stderr.
 There are some special attributes in the `print` command:
 
   * `kind`: displays the name of the function
+  * `attrs`: displays the attribute names of the rule
   * `label`: the fully qualified label
   * `rule`: the entire rule definition
   * `startline`: the line number on which the rule begins in the BUILD file