hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-13 19:33:55 +03:00
Code Issues Projects Releases Wiki Activity

Makefile: Run ormolu --check and shellcheck as part of linting.

Browse Source 
In the interest of having a single command to run before committing in order to check for basic errors, I propose `make lint-changed`.

This enhances `make lint` and `make lint-changed` to run `ormolu` and `shellcheck`, in line with CI.

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4727
GitOrigin-RevId: 05c860a86ce40b0f52c6aa2d333c0af23aea070e
This commit is contained in:
Samir Talwar 2022-06-15 12:26:00 +02:00 committed by hasura-bot
parent 1f2f9a8f94
commit f72d8f09d9
1 changed files with 33 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Makefile
View File

@ -1,8 +1,10 @@
# skip contrib with its generated .hs file because it doesn't
# come with a cabal file, which can trigger a bug in ormolu
HS_FILES = $(shell git ls-files '*.hs' '*.hs-boot' | grep -v '^contrib/')
CHANGED_HS_FILES = $(shell git diff --diff-filter=d --name-only `git merge-base HEAD origin/main` \
| grep '.*\(hs\|hs-boot\)$$' | grep -v '^contrib/')
CHANGED_HS_FILES = $(shell git diff --diff-filter=d --name-only `git merge-base HEAD origin/main` | grep '.*\(\.hs\|hs-boot\)$$' | grep -v '^contrib/')
SHELL_FILES = $(shell git ls-files '*.sh')
CHANGED_SHELL_FILES = $(shell git diff --diff-filter=d --name-only `git merge-base HEAD origin/main` | grep '.*\.sh$$')
HLINT = hlint
@ -11,6 +13,8 @@ ORMOLU_ARGS = --cabal-default-extensions
ORMOLU = ormolu
ORMOLU_VERSION = $(shell $(ORMOLU) --version | awk 'NR==1 { print $$2 }')
SHELLCHECK = shellcheck
# default target
.PHONY: help
## help: prints help message
@ -44,6 +48,14 @@ check-format-hs: check-ormolu-version
@echo running ormolu --mode check
@$(ORMOLU) $(ORMOLU_ARGS) --mode check $(HS_FILES)
.PHONY: check-format-hs-changed
## check-format-hs-changed: check Haskell source code formatting using ormolu (changed-files-only)
check-format-hs-changed: check-ormolu-version
@echo running ormolu --mode check
@if [ -n "$(CHANGED_HS_FILES)" ]; then \
$(ORMOLU) $(ORMOLU_ARGS) --mode check $(CHANGED_HS_FILES); \
fi
.PHONY: format
format: format-hs
@ -53,6 +65,9 @@ format-changed: format-hs-changed
.PHONY: check-format
check-format: check-format-hs
.PHONY: check-format-changed
check-format-changed: check-format-hs-changed
.PHONY: lint-hs
## lint-hs: lint Haskell code using `hlint`
lint-hs:
@ -67,8 +82,22 @@ lint-hs-changed:
$(HLINT) $(CHANGED_HS_FILES); \
fi
.PHONY: lint-shell
## lint-shell: lint shell scripts using `shellcheck`
lint-shell:
@echo running shellcheck
@$(SHELLCHECK) $(SHELL_FILES)
.PHONY: lint-shell-changed
## lint-shell-changed: lint shell scripts using `shellcheck` (changed files only)
lint-shell-changed:
@echo running shellcheck
@if [ -n "$(CHANGED_SHELL_FILES)" ]; then \
$(SHELLCHECK) $(CHANGED_SHELL_FILES); \
fi
.PHONY: lint
lint: lint-hs
lint: lint-hs lint-shell check-format
.PHONY: lint-changed
lint-changed: lint-hs-changed
lint-changed: lint-hs-changed lint-shell-changed check-format-changed