36 lines
902 B
Bash
Executable file
36 lines
902 B
Bash
Executable file
#!/bin/bash
|
|
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
#
|
|
# Copyright (C) 2020-2021 kcgen <kcgen@users.noreply.github.com>
|
|
#
|
|
# This is a convenient helper to run mdl (markdownlint) on the
|
|
# *.md files in the repo, except for those inside directories
|
|
# that are likely to hold 3rd party documentation.
|
|
#
|
|
# You can pass additional mdl arguments to this script itself, e.g.:
|
|
#
|
|
# ./verify-markdown.sh --verbose --json
|
|
|
|
set -euo pipefail
|
|
|
|
list_markdown_files () {
|
|
git ls-files -- \
|
|
'*.md' \
|
|
':!:.github/*.md' \
|
|
':!:.github/**/*.md' \
|
|
':!:src/libs/*.md' \
|
|
':!:src/hardware/reelmagic/docs/*.md' \
|
|
':!:contrib/resources/*.md' \
|
|
':!:contrib/resources/translations/*.md'
|
|
}
|
|
|
|
main () {
|
|
repo_root="$(git rev-parse --show-toplevel)"
|
|
mdl --version
|
|
echo "Checking files:"
|
|
list_markdown_files
|
|
list_markdown_files | xargs -L 1000 mdl --style "$repo_root/.mdl-styles" "$@"
|
|
}
|
|
|
|
>&2 main "$@"
|