Merge pull request #364 from ianlewis/288-feature-create-format-check-makefile-target

chore: add format-check make target

Author: ianlewis

.github/workflows/pull_request.tests.yml

@@ -31,10 +31,10 @@ permissions:
 #       just a human-readable label.
 
 jobs:
-  # formatting
+  # format-check
   ###############################
-  formatting:
-    uses: ./.github/workflows/workflow_call.formatting.yml
+  format-check:
+    uses: ./.github/workflows/workflow_call.format-check.yml
 
   # linters
   ###############################

.github/workflows/workflow_call.formatting.yml renamed to .github/workflows/workflow_call.format-check.yml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: formatting
+name: format-check
 
 on:
   workflow_call:
@@ -22,7 +22,7 @@ permissions:
 
 jobs:
   formatting:
-    name: formatting
+    name: format-check
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
@@ -34,21 +34,10 @@ jobs:
         with:
           node-version-file: ".node-version"
 
-      # TODO(github.com/ianlewis/repo-template/issues/288): Use make format-check target.
-      - name: format
+      - name: format-check
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
+          # Set the git user for the license-headers target.
           git config user.name "Unknown"
-          make format
-
-      - name: check diff
-        run: |
-          set -euo pipefail
-          if [ "$(GIT_PAGER="cat" git diff --ignore-space-at-eol | wc -l)" -gt "0" ]; then
-              echo "Detected formatting changes.  See status below:"
-              echo "::group::git diff"
-              GIT_PAGER="cat" git diff
-              echo "::endgroup::"
-              exit 1
-          fi
+          make format-check

Makefile

@@ -157,18 +157,17 @@ $(AQUA_ROOT_DIR)/.installed: .aqua.yaml .bin/aqua-$(AQUA_VERSION)/aqua
 
 # TODO: Add all target dependencies.
 .PHONY: all
-all: ## Build everything.
+all: test ## Build everything.
 	@# bash \
 	echo "Nothing to build."
+	exit 1
 
 ## Testing
 #####################################################################
 
 # TODO: Add test target dependencies.
 .PHONY: test
-test: ## Run all tests.
-	@# bash \
-	echo "Nothing to test."
+test: lint ## Run all tests.
 
 ## Formatting
 #####################################################################
@@ -285,7 +284,7 @@ yaml-format: node_modules/.installed ## Format YAML files.
 #####################################################################
 
 .PHONY: lint
-lint: actionlint checkmake commitlint fixme markdownlint renovate-config-validator textlint yamllint zizmor ## Run all linters.
+lint: actionlint checkmake commitlint fixme format-check markdownlint renovate-config-validator textlint yamllint zizmor ## Run all linters.
 
 .PHONY: actionlint
 actionlint: $(AQUA_ROOT_DIR)/.installed ## Runs the actionlint linter.
@@ -380,6 +379,23 @@ fixme: $(AQUA_ROOT_DIR)/.installed ## Check for outstanding FIXMEs.
 		--output "$${output}" \
 		--todo-types="FIXME,Fixme,fixme,BUG,Bug,bug,XXX,COMBAK"
 
+.PHONY: format-check
+format-check: ## Check that files are properly formatted.
+	@# bash \
+	if [ -n "$$(git diff)" ]; then \
+		>&2 echo "The working directory is dirty. Please commit, stage, or stash changes and try again."; \
+		exit 1; \
+	fi; \
+	make format; \
+	exit_code=0; \
+	if [ -n "$$(git diff)" ]; then \
+		>&2 echo "Some files need to be formatted. Please run 'make format' and try again."; \
+		git --no-pager diff; \
+		exit_code=1; \
+	fi; \
+	git restore .; \
+	exit "$${exit_code}"
+
 .PHONY: markdownlint
 markdownlint: node_modules/.installed $(AQUA_ROOT_DIR)/.installed ## Runs the markdownlint linter.
 	@# bash \

README.md

@@ -247,7 +247,7 @@ to achieve the highest Tier and score as possible.
     - [ ] `actionlint / actionlint`
     - [ ] `checkmake / checkmake`
     - [ ] `commitlint / commitlint`
-    - [ ] `formatting / formatting`
+    - [ ] `format-check / format-check`
     - [ ] `markdownlint / markdownlint`
     - [ ] `renovate-config-validator / renovate-config-validator`
     - [ ] `textlint / textlint`