chore: setup a buildifier pre-commit hook (#661)

Matches the one just landed in rules_apple: 61bc7c01ae

.bazelci/config.yaml

@@ -187,4 +187,5 @@ tasks:
 
 buildifier:
   version: latest
+  # keep this argument in sync with .pre-commit-config.yaml
   warnings: "all"

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# See CONTRIBUTING.md for instructions.
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/keith/pre-commit-buildifier
+    rev: 4.0.1.1
+    hooks:
+      - id: buildifier
+        args: &args
+          # Keep this argument in sync with .bazelci/config.yaml
+          - --warnings=all
+      - id: buildifier-lint
+        args: *args

CONTRIBUTING.md

@@ -3,6 +3,19 @@
 We'd love to accept your patches and contributions to this project. There are
 just a few small guidelines you need to follow.
 
+## Formatting
+
+Starlark files should be formatted by buildifier.
+We suggest using a pre-commit hook to automate this.
+First [install pre-commit](https://pre-commit.com/#installation),
+then run
+
+```shell
+pre-commit install
+```
+
+Otherwise the Buildkite CI will yell at you about formatting/linting violations.
+
 ## Contributor License Agreement
 
 Contributions to this project must be accompanied by a Contributor License

examples/cmake_crosstool/compilers/linaro_linux_gcc_5.3.1.BUILD

@@ -1,81 +1,81 @@
-package(default_visibility = ['//visibility:public'])
+package(default_visibility = ["//visibility:public"])
 
 filegroup(
-  name = 'gcc',
+    name = "gcc",
-  srcs = [
+    srcs = [
-    'bin/arm-linux-gnueabihf-gcc',
+        "bin/arm-linux-gnueabihf-gcc",
-  ],
+    ],
 )
 
 filegroup(
-  name = 'ar',
+    name = "ar",
-  srcs = [
+    srcs = [
-    'bin/arm-linux-gnueabihf-ar',
+        "bin/arm-linux-gnueabihf-ar",
-  ],
+    ],
 )
 
 filegroup(
-  name = 'ld',
+    name = "ld",
-  srcs = [
+    srcs = [
-    'bin/arm-linux-gnueabihf-ld',
+        "bin/arm-linux-gnueabihf-ld",
-  ],
+    ],
 )
 
 filegroup(
-  name = 'nm',
+    name = "nm",
-  srcs = [
+    srcs = [
-    'bin/arm-linux-gnueabihf-nm',
+        "bin/arm-linux-gnueabihf-nm",
-  ],
+    ],
 )
 
 filegroup(
-  name = 'objcopy',
+    name = "objcopy",
-  srcs = [
+    srcs = [
-    'bin/arm-linux-gnueabihf-objcopy',
+        "bin/arm-linux-gnueabihf-objcopy",
-  ],
+    ],
 )
 
 filegroup(
-  name = 'objdump',
+    name = "objdump",
-  srcs = [
+    srcs = [
-    'bin/arm-linux-gnueabihf-objdump',
+        "bin/arm-linux-gnueabihf-objdump",
-  ],
+    ],
 )
 
 filegroup(
-  name = 'strip',
+    name = "strip",
-  srcs = [
+    srcs = [
-    'bin/arm-linux-gnueabihf-strip',
+        "bin/arm-linux-gnueabihf-strip",
-  ],
+    ],
 )
 
 filegroup(
-  name = 'as',
+    name = "as",
-  srcs = [
+    srcs = [
-    'bin/arm-linux-gnueabihf-as',
+        "bin/arm-linux-gnueabihf-as",
-  ],
+    ],
 )
 
 filegroup(
-  name = 'compiler_pieces',
+    name = "compiler_pieces",
-  srcs = glob([
+    srcs = glob([
-    'arm-linux-gnueabihf/**',
+        "arm-linux-gnueabihf/**",
-    'libexec/**',
+        "libexec/**",
-    'lib/gcc/arm-linux-gnueabihf/**',
+        "lib/gcc/arm-linux-gnueabihf/**",
-    'include/**',
+        "include/**",
-  ]),
+    ]),
 )
 
 filegroup(
-  name = 'compiler_components',
+    name = "compiler_components",
-  srcs = [
+    srcs = [
-    ':gcc',
+        ":ar",
-    ':ar',
+        ":as",
-    ':ld',
+        ":gcc",
-    ':nm',
+        ":ld",
-    ':objcopy',
+        ":nm",
-    ':objdump',
+        ":objcopy",
-    ':strip',
+        ":objdump",
-    ':as',
+        ":strip",
-  ],
+    ],
 )