traefik/script/validate-misspell.sh

30 lines
813 B
Bash
Raw Normal View History

#!/usr/bin/env bash
2016-11-16 09:12:49 +00:00
SCRIPT_DIR="$( cd "$( dirname "${0}" )" && pwd -P)"
files=()
2019-10-09 17:12:05 +00:00
while IFS='' read -r line; do files+=("$line"); done < <(git ls-files "${SCRIPT_DIR}"/../'docs/*.md' "${SCRIPT_DIR}"/../*.md | grep -v "CHANGELOG.md")
2016-11-16 09:12:49 +00:00
errors=()
for f in "${files[@]}"; do
# we use source text here so we also check spelling of variable names
2021-10-01 07:20:08 +00:00
failedSpell=$(misspell -source=text -i "internetbs" "$f")
2016-11-16 09:12:49 +00:00
if [ "$failedSpell" ]; then
errors+=( "$failedSpell" )
fi
done
if [ ${#errors[@]} -eq 0 ]; then
2017-05-26 21:46:47 +00:00
echo 'Congratulations! All Go source files and docs have been checked for common misspellings.'
2016-11-16 09:12:49 +00:00
else
{
echo "Errors from misspell:"
for err in "${errors[@]}"; do
echo "$err"
done
echo
echo 'Please fix the above errors. You can test via "misspell" and commit the result.'
echo
} >&2
false
fi