bazel: add bazelisk run //:format to format all code

Signed-off-by: Øyvind Harboe <[email protected]>

Author: oharboe

BUILD.bazel

@@ -0,0 +1,41 @@
+# run black and tclfmt on the codebase using python installation
+load("@orfs-pip//:requirements.bzl", "requirement")
+load("@rules_python//python:pip.bzl", "compile_pip_requirements")
+
+exports_files(["open_plots.sh"])
+
+py_binary(
+    name = "black",
+    srcs = [
+        "etc/black.py",
+    ],
+    args = [],
+    main = "etc/black.py",
+    visibility = ["//visibility:public"],
+    deps = [requirement("black")],
+)
+
+py_binary(
+    name = "tclfmt",
+    srcs = [
+        "etc/tclfmt.py",
+    ],
+    args = [],
+    data = [":tclint.toml"],
+    main = "etc/tclfmt.py",
+    visibility = ["//visibility:public"],
+    deps = [requirement("tclint")],
+)
+
+sh_binary(
+    name = "format",
+    srcs = ["etc/format.sh"],
+    args = [
+        "$(location :black)",
+        "$(location :tclfmt)",
+    ],
+    data = [
+        ":black",
+        ":tclfmt",
+    ],
+)

bazel/README.md

@@ -3,6 +3,22 @@
 `bazel-orfs` is a Bazel package containing the definitions and logic governing the build process of ORFS designs.
 The module uses the `openroad/orfs` docker image to extract the flow scripts with dependencies, builds the Bazel environment around them and defines the methods of calling the ORFS Makefiles with selected designs.
 
+## Format all code, including submodules
+
+To format all files, run:
+
+    bazelisk run //:format
+
+In the above command, bazel sets up all dependencies and configuration files, without depending or using local files of configuration.
+
+Bazel expert tip: bearing in mind that `bazelisk run` will have pwd inside the runfiles of the target, you can run only black using:
+
+    bazelisk run :black -- $(pwd)
+
+Or tclfmt:
+
+    bazelisk run :tclfmt -- --in-place $(pwd)
+
 ## Run examples
 
 `flow/BUILD.bazel` contains definitions for various flows to serve as examples.

etc/black.py

@@ -0,0 +1,4 @@
+# wafer-thin wrapper to invoke module
+import black
+
+black.main()

etc/format.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -e
+black=$1
+shift
+tclfmt=$1
+shift
+$tclfmt --in-place ${BUILD_WORKSPACE_DIRECTORY}
+$black ${BUILD_WORKSPACE_DIRECTORY}

etc/tclfmt.py

@@ -0,0 +1,4 @@
+# wafer-thin wrapper to invoke module
+from tclint.cli.tclfmt import main
+
+main()