pants: add shfmt to format packaging scripts

cognifloyd · cognifloyd · commit 2f705fa0d715 · 2025-03-15T23:02:57.000-05:00
disable it for all other scripts that would be reformatted.
Someone can reenable it and run it on files later.
diff --git a/BUILD b/BUILD
@@ -88,6 +88,7 @@ file(
 
 shell_sources(
     name="root",
+    skip_shfmt=True,
 )
 
 file(
diff --git a/contrib/core/actions/send_mail/BUILD b/contrib/core/actions/send_mail/BUILD
@@ -2,4 +2,5 @@ st2_shell_sources_and_resources(
     name="send_mail",
     sources=["send_mail"],
     skip_shellcheck=True,
+    skip_shfmt=True,
 )
diff --git a/contrib/examples/actions/BUILD b/contrib/examples/actions/BUILD
@@ -3,4 +3,7 @@ python_sources()
 shell_sources(
     name="shell",
     skip_shellcheck=True,
+    overrides={
+        "print_to_stdout_and_stderr.sh": dict(skip_shfmt=True),
+    }
 )
diff --git a/contrib/examples/actions/bash_exit_code/BUILD b/contrib/examples/actions/bash_exit_code/BUILD
@@ -1 +1 @@
-shell_sources()
+shell_sources(skip_shfmt=True)
diff --git a/contrib/examples/actions/bash_random/BUILD b/contrib/examples/actions/bash_random/BUILD
@@ -1,4 +1,5 @@
 shell_sources(
+    skip_shfmt=True,
     overrides={
         "random2.sh": dict(skip_shellcheck=True),
     },
diff --git a/contrib/linux/actions/BUILD b/contrib/linux/actions/BUILD
@@ -3,4 +3,5 @@ python_sources()
 shell_sources(
     name="shell",
     skip_shellcheck=True,
+    skip_shfmt=True,
 )
diff --git a/pants-plugins/macros.py b/pants-plugins/macros.py
@@ -181,6 +181,7 @@ def st2_shell_sources_and_resources(**kwargs):
     shell_sources(**kwargs)  # noqa: F821
 
     kwargs.pop("skip_shellcheck", None)
+    kwargs.pop("skip_shfmt", None)
 
     kwargs["name"] += "_resources"
     resources(**kwargs)  # noqa: F821
diff --git a/pants.toml b/pants.toml
@@ -26,6 +26,7 @@ backend_packages = [
   # shell
   "pants.backend.shell",
   "pants.backend.shell.lint.shellcheck",
+  "pants.backend.shell.lint.shfmt",
 
   # packaging
   "pants.backend.experimental.makeself",
@@ -236,6 +237,15 @@ config = "@lint-configs/regex-lint.yaml"
 [setuptools]
 install_from_resolve = "st2"
 
+[shfmt]
+args = [
+  # https://github.com/mvdan/sh/blob/master/cmd/shfmt/shfmt.1.scd#printer-flags
+  "--indent",
+  "4",  # default is 0 (use tabs)
+  "--case-indent",
+  "--simplify",
+]
+
 [test]
 extra_env_vars = [
   # Use this so that the test system does not require the stanley user.
diff --git a/scripts/BUILD b/scripts/BUILD
@@ -2,4 +2,5 @@ python_sources()
 
 shell_sources(
     name="shell",
+    skip_shfmt=True,
 )
diff --git a/scripts/ci/BUILD b/scripts/ci/BUILD
@@ -1 +1,11 @@
-shell_sources()
+shell_sources(
+    overrides={
+        (
+            "add-itest-user-key.sh",
+            "permissions-workaround.sh",
+            "run-nightly-make-task-if-exists.sh",
+            "submit-codecov-coverage.sh",
+            "time-command.sh",
+        ): dict(skip_shfmt=True),
+    },
+)
diff --git a/scripts/github/BUILD b/scripts/github/BUILD
@@ -8,4 +8,12 @@ files(
 
 shell_sources(
     dependencies=[":assets"],
+    overrides={
+        (
+            "install-apt-packages-use-cache.sh",
+            "install-mongosh.sh",
+            "install-virtualenv.sh",
+            "setup-environment.sh",
+        ): dict(skip_shfmt=True),
+    },
 )
diff --git a/st2actions/bin/BUILD b/st2actions/bin/BUILD
@@ -9,4 +9,5 @@ st2_shell_sources_and_resources(
     name="shell",
     sources=["*.sh"],
     skip_shellcheck=True,
+    skip_shfmt=True,
 )
diff --git a/st2common/bin/BUILD b/st2common/bin/BUILD
@@ -15,6 +15,7 @@ st2_shell_sources_and_resources(
     name="shell",
     sources=["st2ctl", "st2-self-check", "st2-run-pack-tests"],
     skip_shellcheck=True,
+    skip_shfmt=True,
     overrides={
         "st2ctl": dict(
             dependencies=[
diff --git a/st2common/bin/migrations/v2.1/BUILD b/st2common/bin/migrations/v2.1/BUILD
@@ -3,4 +3,5 @@ python_sources()
 shell_sources(
     name="shell",
     skip_shellcheck=True,
+    skip_shfmt=True,
 )
diff --git a/st2common/tests/fixtures/BUILD b/st2common/tests/fixtures/BUILD
@@ -3,4 +3,5 @@ python_sources()
 st2_shell_sources_and_resources(
     name="shell",
     sources=["*.sh"],
+    skip_shfmt=True,
 )
diff --git a/st2tests/integration/BUILD b/st2tests/integration/BUILD
@@ -12,4 +12,5 @@ shell_sources(
         "st2tests/conf:vagrant_ssh_key",
     ],
     skip_shellcheck=True,
+    skip_shfmt=True,
 )
diff --git a/st2tests/st2tests/fixtures/generic/actions/BUILD b/st2tests/st2tests/fixtures/generic/actions/BUILD
@@ -1,4 +1,5 @@
 st2_shell_sources_and_resources(
     name="shell",
     sources=["*.sh"],
+    skip_shfmt=True,
 )
diff --git a/st2tests/st2tests/fixtures/packs/BUILD b/st2tests/st2tests/fixtures/packs/BUILD
@@ -18,6 +18,7 @@ st2_shell_sources_and_resources(
     name="test_content_version_shell",
     # do not check across git submodule boundary
     skip_shellcheck=True,
+    skip_shfmt=True,
     sources=[
         "test_content_version/**/*.sh",
     ],
diff --git a/st2tests/st2tests/fixtures/ssl_certs/BUILD b/st2tests/st2tests/fixtures/ssl_certs/BUILD
@@ -17,4 +17,5 @@ python_sources(
 
 shell_sources(
     name="util",
+    skip_shfmt=True,
 )
diff --git a/st2tests/testpacks/errorcheck/actions/BUILD b/st2tests/testpacks/errorcheck/actions/BUILD
@@ -1 +1 @@
-shell_sources(skip_shellcheck=True)
+shell_sources(skip_shellcheck=True, skip_shfmt=True)
diff --git a/tools/BUILD b/tools/BUILD
@@ -51,4 +51,11 @@ shell_sources(
     dependencies=[
         "conf:st2_dev_conf",
     ],
+    overrides={
+        (
+            "db_cleanup.sh",
+            "launchdev.sh",
+            "st2-setup-tests",
+        ): dict(skip_shfmt=True),
+    },
 )

Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,7 @@ file(`
`88`	`88`
`89`	`89`	`shell_sources(`
`90`	`90`	`name="root",`
	`91`	`+ skip_shfmt=True,`
`91`	`92`	`)`
`92`	`93`
`93`	`94`	`file(`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@ st2_shell_sources_and_resources(`
`2`	`2`	`name="send_mail",`
`3`	`3`	`sources=["send_mail"],`
`4`	`4`	`skip_shellcheck=True,`
	`5`	`+ skip_shfmt=True,`
`5`	`6`	`)`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,7 @@ python_sources()`
`3`	`3`	`shell_sources(`
`4`	`4`	`name="shell",`
`5`	`5`	`skip_shellcheck=True,`
	`6`	`+ overrides={`
	`7`	`+ "print_to_stdout_and_stderr.sh": dict(skip_shfmt=True),`
	`8`	`+ }`
`6`	`9`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-shell_sources()`
	`1`	`+shell_sources(skip_shfmt=True)`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`shell_sources(`
	`2`	`+ skip_shfmt=True,`
`2`	`3`	`overrides={`
`3`	`4`	`"random2.sh": dict(skip_shellcheck=True),`
`4`	`5`	`},`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,5 @@ python_sources()`
`3`	`3`	`shell_sources(`
`4`	`4`	`name="shell",`
`5`	`5`	`skip_shellcheck=True,`
	`6`	`+ skip_shfmt=True,`
`6`	`7`	`)`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@ python_sources()`
`2`	`2`
`3`	`3`	`shell_sources(`
`4`	`4`	`name="shell",`
	`5`	`+ skip_shfmt=True,`
`5`	`6`	`)`