Add typos makefile, workflow and configuration, refs #560

- Only ignore dist- folder
- Try but reject use typos github action
- Write changes for hs-fix-typos
- Add alse (parse "f" then "alse") to expected words

Author: philderbeast

.github/workflows/typos.yml

@@ -0,0 +1,35 @@
+name: Typos
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+  push:
+
+env:
+  TYPOS_VER: v1.29.1
+  TYPOS_PLATFORM: x86_64-unknown-linux-musl
+  CLICOLOR: 1
+
+jobs:
+  typos:
+    defaults:
+      run:
+        shell: bash
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - uses: actions/checkout@v4
+
+    - run: |
+        wget -q https://github.com/crate-ci/typos/releases/download/${{ env.TYPOS_VER }}/typos-${{ env.TYPOS_VER }}-${{ env.TYPOS_PLATFORM }}.tar.gz
+        tar -xf typos-${{ env.TYPOS_VER }}-${{ env.TYPOS_PLATFORM }}.tar.gz --one-top-level=typos-${{ env.TYPOS_VER }}
+        mkdir -p "$HOME/.local/bin"
+        mv typos-${{ env.TYPOS_VER }} "$HOME/.local/bin/typos-${{ env.TYPOS_VER }}"
+        chmod +x "$HOME/.local/bin/typos-${{ env.TYPOS_VER }}/typos"
+        echo "$HOME/.local/bin/typos-${{ env.TYPOS_VER }}" >> $GITHUB_PATH
+
+    - run: make markdown-typos
+    - run: make hs-typos

.typos.toml

@@ -0,0 +1,16 @@
+[type.hs]
+extend-glob = []
+extend-ignore-identifiers-re = []
+extend-ignore-words-re = []
+extend-ignore-re = []
+
+[type.hs.extend-identifiers]
+sIy = "sIy"
+vIy = "vIy"
+tre = "tre"
+inh = "inh"
+TypeLits = "TypeLits"
+fof = "fof"
+
+[type.hs.extend-words]
+alse = "alse"

Makefile

@@ -0,0 +1,36 @@
+all: help
+
+PHONY: help
+help: ## Show the commented targets.
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
+	sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+PHONY: help-banner
+help-banner: ## Show the help banner.
+	@echo "===================================================================="
+	@echo "§ all                  make with no arguments also shows this banner"
+	@echo "§ help                 make help will list targets with descriptions"
+	@echo "===================================================================="
+
+.PHONY: typos-install
+typos-install: ## Install typos-cli for typos target using cargo.
+	cargo install typos-cli
+
+GREP_EXCLUDE := grep -v -E 'dist-'
+FIND_NAMED := find . -type f -name
+
+.PHONY: markdown-typos
+markdown-typos: ## Find typos in Markdown .md files.
+	$(FIND_NAMED) '*.md' | $(GREP_EXCLUDE) | xargs typos
+
+.PHONY: markdown-fix-typos
+markdown-fix-typos: ## Fix typos in Markdown .md files.
+	$(FIND_NAMED) '*.md' | $(GREP_EXCLUDE) | xargs typos --write-changes
+
+.PHONY: hs-typos
+hs-typos: ## Find typos in Haskell .hs files.
+	$(FIND_NAMED) '*.hs' | $(GREP_EXCLUDE) | xargs typos
+
+.PHONY: hs-fix-typos
+hs-fix-typos: ## Fix typos in Haskell .hs files.
+	$(FIND_NAMED) '*.hs' | $(GREP_EXCLUDE) | xargs typos --write-changes