mirror of https://github.com/istio/istio.io.git
89 lines
2.5 KiB
Bash
Executable File
89 lines
2.5 KiB
Bash
Executable File
#!/usr/bin/env sh
|
|
|
|
FAILED=0
|
|
|
|
echo -ne "mdspell "
|
|
mdspell --version
|
|
echo -ne "mdl "
|
|
mdl --version
|
|
htmlproofer --version
|
|
|
|
# This performs spell checking and style checking over markdown files in a content
|
|
# directory. It transforms the shortcode sequences we use to annotate code blocks
|
|
# blocks into classic markdown ``` code blocks, so that the linters aren't confused
|
|
# by the code blocks
|
|
check_content() {
|
|
DIR=$1
|
|
LANG=$2
|
|
TMP=$(mktemp -d)
|
|
OUT=$(mktemp)
|
|
|
|
# make the tmp dir
|
|
mkdir -p ${TMP}
|
|
|
|
# create a throwaway copy of the content
|
|
cp -R ${DIR} ${TMP}
|
|
|
|
# replace the {{< text >}} shortcodes with ```plain
|
|
find ${TMP} -type f -name \*.md -exec sed -E -i "s/\\{\\{< text .*>\}\}/\`\`\`plain/g" {} ";"
|
|
|
|
# replace the {{< /text >}} shortcodes with ```
|
|
find ${TMP} -type f -name \*.md -exec sed -E -i "s/\\{\\{< \/text .*>\}\}/\`\`\`/g" {} ";"
|
|
|
|
# elide url="*"
|
|
find ${TMP} -type f -name \*.md -exec sed -E -i "s/url=\".*\"/URL/g" {} ";"
|
|
|
|
# elide link="*"
|
|
find ${TMP} -type f -name \*.md -exec sed -E -i "s/link=\".*\"/LINK/g" {} ";"
|
|
|
|
mdspell ${LANG} --ignore-acronyms --ignore-numbers --no-suggestions --report ${TMP}/*.md ${TMP}/*/*.md ${TMP}/*/*/*.md ${TMP}/*/*/*/*.md ${TMP}/*/*/*/*/*.md ${TMP}/*/*/*/*/*/*.md ${TMP}/*/*/*/*/*/*/*.md >${OUT}
|
|
if [ "$?" != "0" ]
|
|
then
|
|
# remove the tmp dir prefix from error messages
|
|
sed s!${TMP}/!! ${OUT}
|
|
echo "To learn how to address spelling errors, please see https://github.com/istio/istio.github.io#linting"
|
|
FAILED=1
|
|
fi
|
|
|
|
mdl --ignore-front-matter --style mdl_style.rb ${TMP} >${OUT}
|
|
if [ "$?" != "0" ]
|
|
then
|
|
# remove the tmp dir prefix from error messages
|
|
sed s!${TMP}/!! ${OUT}
|
|
FAILED=1
|
|
fi
|
|
|
|
# cleanup
|
|
rm -fr ${TMP}
|
|
rm -fr ${OUT}
|
|
}
|
|
|
|
check_content content --en-us
|
|
#check_content content_zh --zh-cn
|
|
|
|
grep -nr -e "MARKDOWN ERROR:" ./public
|
|
if [ "$?" == "0" ]
|
|
then
|
|
echo "Errors found in the markdown content"
|
|
FAILED=1
|
|
fi
|
|
|
|
grep -nr -e "“" ./content
|
|
if [ "$?" == "0" ]
|
|
then
|
|
echo "Ensure markdown content only uses standard quotation marks and not “"
|
|
FAILED=1
|
|
fi
|
|
|
|
htmlproofer ./public --assume-extension --check-external-hash --check-opengraph --timeframe 2d --storage-dir .htmlproofer --url-ignore "/localhost/,/github.com/istio/istio.github.io/edit/master/,/github.com/istio/istio/issues/new/choose/,/groups.google.com/forum/"
|
|
if [ "$?" != "0" ]
|
|
then
|
|
FAILED=1
|
|
fi
|
|
|
|
if [ ${FAILED} -eq 1 ]
|
|
then
|
|
echo "LINTING FAILED"
|
|
exit 1
|
|
fi
|