mirror of
https://github.com/corona-warn-app/cwa-documentation
synced 2024-05-29 04:48:03 +02:00
ff34c16450
This Makefile provides several targets for linting documents. It utilizes several npm packages. Functionality includes: * Spellcheck * Linting of markdown * Check for broken links * Sorting of dictionary file * Detect inconsidered language All targets (excluding the sorting of the dict file) are part of the Github Action pipeline and will fail if quality standards are not met. Signed-off-by: Johannes Amorosa <johannes.amorosa@endocode.com>
35 lines
911 B
Makefile
35 lines
911 B
Makefile
.PHONY: all install check markdownlint clean checklinks spellcheck-en spellcheck detect-inconsiderate-language
|
|
|
|
SHELL := /bin/bash
|
|
export PATH := ./node_modules/.bin:$(PATH)
|
|
|
|
install:
|
|
# https://stackoverflow.com/a/56254478
|
|
npm ci
|
|
|
|
check: markdownlint checklinks spellcheck format-spelling detect-inconsiderate-language
|
|
spellcheck: spellcheck-en
|
|
|
|
spellcheck-en:
|
|
mdspell '**/*.md' --en-us -t -n -a --report \
|
|
'!**/node_modules/**/*.md' \
|
|
'!**/.github/**/*.md' \
|
|
'!**/translations/**/*.md'
|
|
|
|
markdownlint:
|
|
markdownlint '**/*.md' --ignore node_modules
|
|
|
|
checklinks:
|
|
# https://github.com/tcort/markdown-link-check/issues/57
|
|
find . -not -path "*node_modules*" -not -path "*.github*" -name \*.md | \
|
|
xargs -n 1 markdown-link-check
|
|
|
|
detect-inconsiderate-language:
|
|
alex
|
|
|
|
format-spelling:
|
|
sort < .spelling | sort | uniq | tee .spelling.tmp > /dev/null && mv .spelling.tmp .spelling
|
|
|
|
clean:
|
|
rm -rf node_modules
|