Fix pre-push hook to fail if working tree dirty

Now that we've instructed the lint pipeline to update the ESLint warning
thresholds file, if you introduce changes to lint violations prior to
pushing, and you have the `pre-push` Git hook installed, you could
forget to push changes to this file.

This commit extracts the "working tree dirty" check that we perform in
the `lint-build-test` GitHub workflow to a script so that we can not
only call it in the workflow but also after running `yarn lint` in the
`pre-push` hook.

Note that you'll need to re-run `yarn simple-git-hooks` for this change
to take effect.

Author: mcmire

.github/workflows/lint-build-test.yml

@@ -55,12 +55,7 @@ jobs:
       - run: yarn --immutable
       - run: yarn lint
       - name: Require clean working directory
-        shell: bash
-        run: |
-          if ! git diff --exit-code; then
-            echo "Working tree dirty at end of job"
-            exit 1
-          fi
+        run: yarn git:fail-on-changes
 
   validate-changelog:
     name: Validate changelog
@@ -86,12 +81,7 @@ jobs:
       - run: yarn --immutable
       - run: yarn workspace ${{ matrix.package-name }} changelog:validate
       - name: Require clean working directory
-        shell: bash
-        run: |
-          if ! git diff --exit-code; then
-            echo "Working tree dirty at end of job"
-            exit 1
-          fi
+        run: yarn git:fail-on-changes
 
   build:
     name: Build
@@ -116,12 +106,7 @@ jobs:
       - run: yarn --immutable
       - run: yarn build
       - name: Require clean working directory
-        shell: bash
-        run: |
-          if ! git diff --exit-code; then
-            echo "Working tree dirty at end of job"
-            exit 1
-          fi
+        run: yarn git:fail-on-changes
 
   test:
     name: Test
@@ -149,8 +134,4 @@ jobs:
       - run: yarn workspace ${{ matrix.package-name }} run test
       - name: Require clean working directory
         shell: bash
-        run: |
-          if ! git diff --exit-code; then
-            echo "Working tree dirty at end of job"
-            exit 1
-          fi
+        run: yarn git:fail-on-changes

package.json

@@ -21,6 +21,7 @@
     "changelog:update": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run changelog:update",
     "changelog:validate": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run changelog:validate",
     "create-package": "ts-node scripts/create-package",
+    "git:fail-on-changes": "./scripts/fail-on-changes.sh",
     "lint": "yarn lint:eslint && yarn lint:misc --check && yarn constraints && yarn lint:dependencies && yarn lint:teams",
     "lint:dependencies": "depcheck && yarn dedupe --check",
     "lint:dependencies:fix": "depcheck && yarn dedupe",
@@ -41,7 +42,7 @@
     "workspaces:list-versions": "./scripts/list-workspace-versions.sh"
   },
   "simple-git-hooks": {
-    "pre-push": "yarn lint"
+    "pre-push": "yarn lint && yarn git:fail-on-changes"
   },
   "resolutions": {
     "[email protected]": "^6.5.7",

scripts/fail-on-changes.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+red() {
+  printf "\x1B[31m"
+  echo -n "$@"
+  printf "\x1B[0m"
+}
+
+diff="$(git diff --stat --exit-code --color)"
+exitcode=$?
+
+if [[ $exitcode -ne 0 ]]; then
+  red "ERROR: The working tree is dirty. Please commit or remove these changes to continue:" $'\n'
+  echo "$diff"
+  exit 1
+fi