Merge pull request #2323 from tweag/cb/fix-lint-warnings

Enable default buildifier lint warnings and clean up

Author: mergify[bot]

MODULE.bazel

@@ -32,6 +32,10 @@ bazel_dep(
     name = "rules_python",
     version = "0.21.0",
 )
+bazel_dep(
+    name = "rules_shell",
+    version = "0.2.0",
+)
 bazel_dep(
     name = "bazel_skylib",
     version = "1.5.0",

WORKSPACE

@@ -9,6 +9,12 @@ load("//haskell:repositories.bzl", "rules_haskell_dependencies")
 
 rules_haskell_dependencies()
 
+load("@rules_shell//shell:repositories.bzl", "rules_shell_dependencies", "rules_shell_toolchains")
+
+rules_shell_dependencies()
+
+rules_shell_toolchains()
+
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
 http_archive(
@@ -85,6 +91,7 @@ load(
     "nixpkgs_package",
 )
 
+# buildifier: disable=no-effect
 asterius_dependencies_nix(
     nix_repository = "@nixpkgs_default",
     nixpkgs_package_rule = nixpkgs_package,

buildifier/BUILD.bazel

@@ -5,8 +5,20 @@ buildifier_exclude_patterns = [
 ]
 
 _lint_warnings = [
-    "load",
-    "unused-variable",
+    "-function-docstring",  # TODO
+    "-function-docstring-args",  # TODO
+    "-function-docstring-header",  # TODO
+    "-function-docstring-return",  # TODO
+    "-native-cc-common",
+    "-native-cc-info",
+    "-native-cc-library",
+    "-native-cc-shared-library-info",
+    "-native-java-common",
+    "-native-java-info",
+    "-native-proto",
+    "-native-proto-common",
+    "-native-proto-info",
+    "-module-docstring",
 ]
 
 # Run this to fix the errors in BUILD files.

debug/linking_utils/ldd.py

@@ -44,7 +44,7 @@ def memoized(cache, f, arg):
 
 ### IO functions that find elf dependencies
 
-_field_matcher = re.compile(b"  ([A-Z0-9_]+) +(.*)$")
+_field_matcher = re.compile(b"  ([A-Zx0-9_]+) +(.*)$")
 
 def read_dynamic_fields(elf_path):
     """Read the dynamic header fields from an elf binary
@@ -70,7 +70,10 @@ def read_dynamic_fields(elf_path):
     dyn_section = to_end[: 1 + to_end.find(b"\n\n")]
     def read_dynamic_field(s):
         """return (field_key, field_value)"""
-        return _field_matcher.match(s).groups()
+        m = _field_matcher.match(s)
+        if not m:
+            raise Exception("{}: could not match {}".format(elf_path, s))
+        return m.groups()
     return list(map(read_dynamic_field, dyn_section.splitlines(True)))
 
 def __query_dynamic_fields(df, key):

docs/BUILD.bazel

@@ -62,6 +62,7 @@ bzl_library(
             deps = [
                 ":haskell_nix",
                 "//haskell",
+                "@rules_shell//shell:rules_bzl",
             ],
         ),
         # Generate markdown API documentation.
@@ -78,6 +79,7 @@ bzl_library(
             deps = [
                 ":haskell_nix",
                 "//haskell",
+                "@rules_shell//shell:rules_bzl",
             ],
         ),
         # Convert markdown to html.

haskell/BUILD.bazel

@@ -23,6 +23,7 @@ load(
     "haskell_toolchain_info",
 )
 load("@rules_python//python:defs.bzl", "py_binary", "py_library")
+load("@rules_shell//shell:sh_binary.bzl", "sh_binary")
 
 exports_files(
     glob(["*.bzl"]) + [

haskell/asterius/asterius_dependencies.bzl

@@ -67,6 +67,7 @@ npm_repositories()
 def asterius_dependencies_nix(
         nix_repository,
         nixpkgs_package_rule,
+        name = "rules_haskell",
         nixpkgs_nodejs = DEFAULT_NIXPKGS_NODEJS,
         register = True):
     """Install asterius dependencies based on nix.
@@ -87,22 +88,23 @@ npm_repositories()
 
     _nixpkgs_nodejs(nixpkgs_nodejs, nix_repository, nixpkgs_package_rule)
 
+    node_toolchain_name = name + "_nix_node_toolchain"
     _declare_nix_node_toolchain(
-        name = "rules_haskell_nix_node_toolchain",
+        name = node_toolchain_name,
         nixpkgs_nodejs = nixpkgs_nodejs,
     )
     if register:
-        native.register_toolchains("@rules_haskell_nix_node_toolchain//:node_nixpkgs_toolchain")
+        native.register_toolchains("@{}//:node_nixpkgs_toolchain".format(node_toolchain_name))
         npm_translate_lock(
-            name = "rules_haskell_npm",
+            name = name + "_npm",
             pnpm_lock = DEFAULT_PNPM_LOCK,
             verify_node_modules_ignored = "@rules_haskell//:.bazelignore",
             link_workspace = "rules_haskell",
         )
-    _ahc_target_build_setting(name = "rules_haskell_asterius_build_setting")
+    _ahc_target_build_setting(name = name + "_asterius_build_setting")
 
     _declare_webpack(
-        name = "rules_haskell_asterius_webpack",
+        name = name + "_asterius_webpack",
     )
 
 def asterius_dependencies_custom(webpack_cli_package_json_bzl):

haskell/asterius/defs.bzl

@@ -334,8 +334,8 @@ browser_transition = rule(
     doc = "Wrapper rule used to execute webpack and its ahc_dist dependency in a configuration where asterius targets the browser",
 )
 
-def _name_of_label(l):
-    return l.split(":")[-1]
+def _name_of_label(label):
+    return label.split(":")[-1]
 
 def asterius_webpack(name, ahc_dist_dep, entry_point, tags = [], srcs = [], **kwargs):
     """

haskell/asterius/repositories.bzl

@@ -274,6 +274,7 @@ def rules_haskell_asterius_toolchain(
         native.register_toolchains("@{}//:wasm_cc_toolchain".format(toolchain_name))
 
 def rules_haskell_asterius_toolchains(
+        name = "asterius",
         version = AHC_DEFAULT_VERSION,
         ghcopts = [],
         cabalopts = [],
@@ -297,7 +298,7 @@ def rules_haskell_asterius_toolchains(
         fail("Binary distribution of Asterius {} not available.".format(version))
     for platform in AHC_BINDIST[version]:
         # Download the asterius bundle.
-        bundle_repo_name = "asterius_bundle_{}".format(platform)
+        bundle_repo_name = "{}_bundle_{}".format(name, platform)
         _asterius_bundle(
             name = bundle_repo_name,
             version = version,
@@ -319,7 +320,7 @@ def rules_haskell_asterius_toolchains(
         (asterius_lib_setting_file, ahc_pkg, asterius_binaries, full_bundle, wasm_cc_toolchain) = _labels_from_bundle_name(bundle_repo_name, version)
 
         rules_haskell_asterius_toolchain(
-            "{}_asterius".format(platform),
+            "{}_{}".format(platform, name),
             version,
             exec_constraints,
             asterius_lib_setting_file,

haskell/cabal.bzl

@@ -144,6 +144,7 @@ def _cabal_tool_flag(tool):
     """Return a --with-PROG=PATH flag if input is a recognized Cabal tool. None otherwise."""
     if tool.basename in _CABAL_TOOLS:
         return "--with-{}={}".format(tool.basename, tool.path)
+    return None
 
 def _binary_paths(binaries):
     return [binary.dirname for binary in binaries.to_list()]
@@ -2333,13 +2334,13 @@ _stack_update = repository_rule(
     # Marked as local so that stack update is always executed before
     # _stack_snapshot is executed.
     local = True,
-)
-"""Execute stack update.
+    doc = """Execute stack update.
 
 This is extracted into a singleton repository rule to avoid concurrent
 invocations of stack update.
 See https://github.com/tweag/rules_haskell/issues/1090
-"""
+""",
+)
 
 def _get_platform(repository_ctx):
     """Map OS name and architecture to Stack platform identifiers."""
@@ -2387,8 +2388,8 @@ def _fetch_stack_impl(repository_ctx):
     if not error:
         repository_ctx.symlink(stack_cmd, "stack")
         return
-    print(error)
-    print("Downloading Stack {} ...".format(_STACK_DEFAULT_VERSION))
+    print(error)  # buildifier: disable=print
+    print("Downloading Stack {} ...".format(_STACK_DEFAULT_VERSION))  # buildifier: disable=print
     (os, arch) = _get_platform(repository_ctx)
     version = _STACK_DEFAULT_VERSION
     (url, sha256) = _STACK_BINDISTS[version]["{}-{}".format(os, arch)]
@@ -2424,8 +2425,9 @@ _fetch_stack = repository_rule(
     _fetch_stack_impl,
     configure = True,
     environ = ["PATH"],
+    doc =
+        """Find a suitably recent local Stack or download it.""",
 )
-"""Find a suitably recent local Stack or download it."""
 
 def stack_snapshot(
         name,