Add sentinel fmt hook (#89)

.pre-commit-hooks.yaml

@@ -110,3 +110,11 @@
   entry: ./hooks/check_skip_env.py
   language: script
   files: \.go$
+
+- id: sentinel-fmt
+  name: Sentinel fmt
+  description: Rewrites all Sentinel configuration files to a canonical format
+  entry: hooks/sentinel-fmt.sh
+  language: script
+  files: \.sentinel$
+  require_serial: true

README.md

@@ -18,6 +18,8 @@ supported hooks are:
 * **helmlint** Automatically run [`helm lint`](https://helm.sh/docs/helm/helm_lint/) on your Helm chart files. [See caveats here](#helm-lint-caveats).
 * **markdown-link-check** Automatically run [markdown-link-check](https://github.com/tcort/markdown-link-check) on
   markdown doc files.
+* **sentinel-fmt**: Automatically run `sentinel fmt` on all Sentinel code (`*.sentinel.*` files).
+
 
 
 

hooks/sentinel-fmt.sh

@@ -0,0 +1,22 @@
+
+#!/usr/bin/env bash
+
+set -e
+
+# OSX GUI apps do not pick up environment variables the same way as Terminal apps and there are no easy solutions,
+# especially as Apple changes the GUI app behavior every release (see https://stackoverflow.com/q/135688/483528). As a
+# workaround to allow GitHub Desktop to work, add this (hopefully harmless) setting here.
+original_path=$PATH
+export PATH=$PATH:/usr/local/bin
+
+# Store and return last failure from fmt so this can validate every directory passed before exiting
+FMT_ERROR=0
+
+for file in "$@"; do
+  sentinel fmt -diff -check "$file" || FMT_ERROR=$?
+done
+
+# reset path to the original value
+export PATH=$original_path
+
+exit ${FMT_ERROR}