mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-09-11 10:46:25 +03:00
a206d04062
### Description - sets up a Makefile target for running ormolu to format and check source code - updates CI to run ormolu instead of stylish-haskell (and to check instead of format actively) Compare #1679. Here's the plan for merging this: 1. merge this PR; at this point, all PRs will fail CI unless they have the `ignore-server-format-checks` label set 2. merge follow-up PR #2404 that does nothing but actually reformats the codebase 3. tag the merge commit as `post-ormolu` (also on `graphql-engine`, for the benefits of community contributors) 4. provide the following script to any devs in order to update their branches: ``` $ git checkout my-feature-branch $ git merge post-ormolu^ $ make format $ git commit -a -m "reformat with ormolu" $ git merge -s ours post-ormolu ``` (I'll put this in the commit message) https://github.com/hasura/graphql-engine-mono/pull/2020 Co-authored-by: Philip Lykke Carlsen <358550+plcplc@users.noreply.github.com> Co-authored-by: Swann Moreau <62569634+evertedsphere@users.noreply.github.com> GitOrigin-RevId: 130f480a6d79967c8d045b7f3a6dec30b10472a7
53 lines
1.7 KiB
Makefile
53 lines
1.7 KiB
Makefile
# skip contrib with its generated .hs file because it doesn't
|
|
# come with a cabal file, which can trigger a bug in ormolu
|
|
FORMAT_HS_FILES = $(shell git ls-files '*.hs' '*.hs-boot' | grep -v '^contrib/')
|
|
FORMAT_CHANGED_HS_FILES = $(shell git diff --diff-filter=d --name-only `git merge-base HEAD origin/main` \
|
|
| grep '.*\(hs\|hs-boot\)$$' | grep -v '^contrib/')
|
|
|
|
ORMOLU_CHECK_VERSION = 0.3.0.0
|
|
ORMOLU_ARGS = --cabal-default-extensions
|
|
ORMOLU = ormolu
|
|
ORMOLU_VERSION = $(shell $(ORMOLU) --version | awk 'NR==1 { print $$2 }')
|
|
|
|
# default target
|
|
.PHONY: help
|
|
## help: prints help message
|
|
help:
|
|
@echo "Usage:"
|
|
@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /'
|
|
|
|
.PHONY: check-ormolu-version
|
|
check-ormolu-version:
|
|
@if ! [ "$(ORMOLU_VERSION)" = "$(ORMOLU_CHECK_VERSION)" ]; then \
|
|
echo "WARNING: ormolu version mismatch, expected $(ORMOLU_CHECK_VERSION)"; \
|
|
fi
|
|
|
|
.PHONY: format-hs
|
|
## format-hs: auto-format Haskell source code using ormolu
|
|
format-hs: check-ormolu-version
|
|
@echo running ormolu --mode inplace
|
|
@$(ORMOLU) $(ORMOLU_ARGS) --mode inplace $(FORMAT_HS_FILES)
|
|
|
|
.PHONY: format-hs-changed
|
|
## format-hs-changed: auto-format Haskell source code using ormolu (changed files only)
|
|
format-hs-changed: check-ormolu-version
|
|
@echo running ormolu --mode inplace
|
|
@if [ -n "$(FORMAT_CHANGED_HS_FILES)" ]; then \
|
|
$(ORMOLU) $(ORMOLU_ARGS) --mode inplace $(FORMAT_CHANGED_HS_FILES); \
|
|
fi
|
|
|
|
.PHONY: check-format-hs
|
|
## check-format-hs: check Haskell source code formatting using ormolu
|
|
check-format-hs: check-ormolu-version
|
|
@echo running ormolu --mode check
|
|
@$(ORMOLU) $(ORMOLU_ARGS) --mode check $(FORMAT_HS_FILES)
|
|
|
|
.PHONY: format
|
|
format: format-hs
|
|
|
|
.PHONY: format-changed
|
|
format-changed: format-hs-changed
|
|
|
|
.PHONY: check-format
|
|
check-format: check-format-hs
|