build: add linting for bazel build files (#16090)

Author: devversion

.circleci/config.yml

@@ -258,6 +258,7 @@ jobs:
       - *restore_cache
       - *yarn_install
 
+      - run: ./scripts/circleci/lint-bazel-files.sh
       - run: yarn gulp ci:lint
 
   # -------------------------------------------------------------------------------------------

WORKSPACE

@@ -4,17 +4,17 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
 # Add NodeJS rules (explicitly used for sass bundle rules)
 http_archive(
-  name = "build_bazel_rules_nodejs",
-  sha256 = "1db950bbd27fb2581866e307c0130983471d4c3cd49c46063a2503ca7b6770a4",
-  urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/0.29.0/rules_nodejs-0.29.0.tar.gz"],
+    name = "build_bazel_rules_nodejs",
+    sha256 = "1db950bbd27fb2581866e307c0130983471d4c3cd49c46063a2503ca7b6770a4",
+    urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/0.29.0/rules_nodejs-0.29.0.tar.gz"],
 )
 
 # Add sass rules
 http_archive(
-  name = "io_bazel_rules_sass",
-  sha256 = "ea79647e5cd36867568d80811a951c7b3170791058f50a5cbd3d542627e78881",
-  url = "https://github.com/bazelbuild/rules_sass/archive/1.17.3.zip",
-  strip_prefix = "rules_sass-1.17.3",
+    name = "io_bazel_rules_sass",
+    sha256 = "ea79647e5cd36867568d80811a951c7b3170791058f50a5cbd3d542627e78881",
+    strip_prefix = "rules_sass-1.17.3",
+    url = "https://github.com/bazelbuild/rules_sass/archive/1.17.3.zip",
 )
 
 load("@build_bazel_rules_nodejs//:defs.bzl", "check_bazel_version", "node_repositories", "yarn_install")
@@ -23,73 +23,82 @@ load("@build_bazel_rules_nodejs//:defs.bzl", "check_bazel_version", "node_reposi
 check_bazel_version("0.18.0")
 
 node_repositories(
-  # For deterministic builds, specify explicit NodeJS and Yarn versions.
-  node_version = "10.13.0",
-  # Use latest yarn version to support integrity field (added in yarn 1.10)
-  yarn_version = "1.12.1",
+    # For deterministic builds, specify explicit NodeJS and Yarn versions.
+    node_version = "10.13.0",
+    # Use latest yarn version to support integrity field (added in yarn 1.10)
+    yarn_version = "1.12.1",
 )
 
 yarn_install(
-  name = "npm",
-  package_json = "//:package.json",
-  # Ensure that the script is available when running `postinstall` in the Bazel sandbox.
-  data = [
-    "//:tools/npm/check-npm.js",
-    "//:angular-tsconfig.json",
-  ],
-  yarn_lock = "//:yarn.lock",
+    name = "npm",
+    # Ensure that the script is available when running `postinstall` in the Bazel sandbox.
+    data = [
+        "//:angular-tsconfig.json",
+        "//:tools/npm/check-npm.js",
+    ],
+    package_json = "//:package.json",
+    yarn_lock = "//:yarn.lock",
 )
 
 # Install all bazel dependencies of the @ngdeps npm packages
 load("@npm//:install_bazel_dependencies.bzl", "install_bazel_dependencies")
+
 install_bazel_dependencies()
 
 # Setup TypeScript Bazel workspace
 load("@npm_bazel_typescript//:defs.bzl", "ts_setup_workspace")
+
 ts_setup_workspace()
 
 # Fetch transitive dependencies which are needed to use the karma rules.
 load("@npm_bazel_karma//:package.bzl", "rules_karma_dependencies")
+
 rules_karma_dependencies()
 
 # Setup web testing. We need to setup a browser because the web testing rules for TypeScript need
 # a reference to a registered browser (ideally that's a hermetic version of a browser)
 load("@io_bazel_rules_webtesting//web:repositories.bzl", "web_test_repositories")
+
 web_test_repositories()
 
 load("@npm_bazel_karma//:browser_repositories.bzl", "browser_repositories")
+
 browser_repositories()
 
 # Fetch transitive dependencies which are needed to use the Sass rules.
 load("@io_bazel_rules_sass//:package.bzl", "rules_sass_dependencies")
+
 rules_sass_dependencies()
 
 # Setup the Sass rule repositories.
 load("@io_bazel_rules_sass//:defs.bzl", "sass_repositories")
+
 sass_repositories()
 
 # Bring in bazel_toolchains for RBE setup configuration.
 http_archive(
-  name = "bazel_toolchains",
-  sha256 = "67335b3563d9b67dc2550b8f27cc689b64fadac491e69ce78763d9ba894cc5cc",
-  strip_prefix = "bazel-toolchains-cddc376d428ada2927ad359211c3e356bd9c9fbb",
-  url = "https://github.com/bazelbuild/bazel-toolchains/archive/cddc376d428ada2927ad359211c3e356bd9c9fbb.tar.gz",
+    name = "bazel_toolchains",
+    sha256 = "67335b3563d9b67dc2550b8f27cc689b64fadac491e69ce78763d9ba894cc5cc",
+    strip_prefix = "bazel-toolchains-cddc376d428ada2927ad359211c3e356bd9c9fbb",
+    url = "https://github.com/bazelbuild/bazel-toolchains/archive/cddc376d428ada2927ad359211c3e356bd9c9fbb.tar.gz",
 )
 
 load("@bazel_toolchains//repositories:repositories.bzl", bazel_toolchains_repositories = "repositories")
+
 bazel_toolchains_repositories()
 
 load("@bazel_toolchains//rules:rbe_repo.bzl", "rbe_autoconfig")
+
 rbe_autoconfig(
-  name = "rbe_default",
-  # We can't use the default "ubuntu16_04" RBE image provided by the autoconfig because we need
-  # a specific Linux kernel that comes with "libx11" in order to run headless browser tests.
-  repository = "asci-toolchain/nosla-ubuntu16_04-webtest",
-  registry = "gcr.io",
-  digest = "sha256:e874885f5e3d9ac0c0d3176e5369cb5969467dbf9ad8d42b862829cec8d84b9b",
-  # Need to specify a base container digest in order to ensure that we can use the checked-in
-  # platform configurations for the "ubuntu16_04" image. Otherwise the autoconfig rule would
-  # need to pull the image and run it in order determine the toolchain configuration.
-  # See: https://github.com/bazelbuild/bazel-toolchains/blob/master/rules/rbe_repo.bzl#L229
-  base_container_digest = "sha256:da0f21c71abce3bbb92c3a0c44c3737f007a82b60f8bd2930abc55fe64fc2729",
+    name = "rbe_default",
+    # Need to specify a base container digest in order to ensure that we can use the checked-in
+    # platform configurations for the "ubuntu16_04" image. Otherwise the autoconfig rule would
+    # need to pull the image and run it in order determine the toolchain configuration.
+    # See: https://github.com/bazelbuild/bazel-toolchains/blob/master/rules/rbe_repo.bzl#L229
+    base_container_digest = "sha256:da0f21c71abce3bbb92c3a0c44c3737f007a82b60f8bd2930abc55fe64fc2729",
+    digest = "sha256:e874885f5e3d9ac0c0d3176e5369cb5969467dbf9ad8d42b862829cec8d84b9b",
+    registry = "gcr.io",
+    # We can't use the default "ubuntu16_04" RBE image provided by the autoconfig because we need
+    # a specific Linux kernel that comes with "libx11" in order to run headless browser tests.
+    repository = "asci-toolchain/nosla-ubuntu16_04-webtest",
 )

guides/BUILD.bazel

@@ -1,8 +1,8 @@
-package(default_visibility=["//visibility:public"])
+package(default_visibility = ["//visibility:public"])
 
 load("//tools:defaults.bzl", "markdown_to_html")
 
 markdown_to_html(
-  name = "guides",
-  srcs = glob(["**/*.md"]),
+    name = "guides",
+    srcs = glob(["**/*.md"]),
 )

package.json

@@ -14,9 +14,11 @@
   "scripts": {
     "postinstall": "ngc -p angular-tsconfig.json",
     "build": "gulp build-release-packages",
+    "bazel:buildifier": "find . -type f \\( -name \"*.bzl\" -or -name WORKSPACE -or -name BUILD -or -name BUILD.bazel \\) ! -path \"*/node_modules/*\" | xargs buildifier -v --warnings=attr-cfg,attr-license,attr-non-empty,attr-output-default,attr-single-file,constant-glob,ctx-args,depset-iteration,depset-union,dict-concatenation,duplicated-name,filetype,git-repository,http-archive,integer-division,load,load-on-top,native-build,native-package,output-group,package-name,package-on-top,redefined-variable,repository-name,same-origin-load,string-iteration,unused-variable",
+    "bazel:format-lint": "yarn -s bazel:buildifier --lint=warn --mode=check",
     "dev-app": "gulp serve:devapp",
     "test": "bazel test //src/... --test_tag_filters=-e2e",
-    "lint": "gulp lint",
+    "lint": "gulp lint && yarn -s bazel:format-lint",
     "e2e": "bazel test //src/... --test_tag_filters=e2e",
     "deploy": "gulp deploy:devapp",
     "webdriver-manager": "webdriver-manager",
@@ -26,7 +28,9 @@
     "publish-release": "ts-node --project tools/release/ tools/release/publish-release.ts",
     "check-release-output": "ts-node --project tools/release tools/release/check-release-output.ts",
     "preinstall": "node ./tools/npm/check-npm.js",
-    "format": "git-clang-format HEAD $(git diff HEAD --name-only | grep -v \"\\.d\\.ts\")"
+    "format:ts": "git-clang-format HEAD $(git diff HEAD --name-only | grep -v \"\\.d\\.ts\")",
+    "format:bazel": "yarn -s bazel:buildifier --lint=fix --mode=fix",
+    "format": "yarn -s format:ts && yarn -s format:bazel"
   },
   "version": "8.0.0",
   "requiredAngularVersion": "^8.0.0 || ^9.0.0-0",
@@ -39,6 +43,7 @@
     "@angular/elements": "^8.0.0",
     "@angular/forms": "^8.0.0",
     "@angular/platform-browser": "^8.0.0",
+    "@bazel/buildifier": "^0.25.1",
     "@webcomponents/custom-elements": "^1.1.0",
     "core-js": "^2.6.1",
     "material-components-web": "^1.1.0",