Makefile

# All documents to be used in spell check.
ALL_DOCS := $(shell find . -name '*.md' -type f | sort)

TOOLS_DIR := ./.tools
MISSPELL_BINARY=$(TOOLS_DIR)/misspell
MARKDOWN_LINK_CHECK=markdown-link-check

.PHONY: install-misspell
install-misspell:
	go build -o $(MISSPELL_BINARY) github.com/client9/misspell/cmd/misspell

.PHONY: misspell
misspell:
	$(MISSPELL_BINARY) -error $(ALL_DOCS)

.PHONY: misspell-correction
misspell-correction:
	$(MISSPELL_BINARY) -w $(ALL_DOCS)

.PHONY: install-markdown-link-check
install-markdown-link-check:
	npm install -g $(MARKDOWN_LINK_CHECK)

.PHONY: markdown-link-check
markdown-link-check:
	find . -name \*.md -exec sleep 5 \; -exec  $(MARKDOWN_LINK_CHECK) {} \;

.PHONY: enforce-markdown-link-check
enforce-markdown-link-check:
	@LINKCHECKOUT=`find . -name \*.md -exec sleep 5 \; -exec $(MARKDOWN_LINK_CHECK) {} 2>&1 >/dev/null \;`; \
		if [ "$$LINKCHECKOUT" ]; then \
			echo "$(MARKDOWN_LINK_CHECK) FAILED => errors:\n"; \
			echo "Run 'make $(MARKDOWN_LINK_CHECK)' to see the errors"; \
			exit 1; \
		else \
			echo "Check markdown links finished successfully"; \
		fi

.PHONY: install-markdown-lint
install-markdown-lint:
	npm install -g markdownlint-cli@0.30.0

.PHONY: markdown-lint
markdown-lint:
	markdownlint -c .markdownlint.yaml '**/*.md'