istio.io/scripts/lint_site.sh

#!/bin/bash

FAILED=0

echo -ne "mdspell "
mdspell --version
echo -ne "mdl "
mdl --version
htmlproofer --version
echo -ne "sass-lint "
npx sass-lint --version
echo -ne "tslint "
npx tslint  --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
# 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)

    # make the tmp dir
    mkdir -p ${TMP}

    # create a throwaway copy of the content
    cp -R ${DIR} ${TMP}
    cp .spelling ${TMP}
    cp mdl_style.rb ${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" {} ";"

    # switch to the temp dir
    pushd ${TMP} >/dev/null

    mdspell ${LANG} --ignore-acronyms --ignore-numbers --no-suggestions --report *.md */*.md */*/*.md */*/*/*.md */*/*/*/*.md */*/*/*/*/*.md */*/*/*/*/*/*.md
    if [[ "$?" != "0" ]]
    then
        echo "To learn how to address spelling errors, please see https://github.com/istio/istio.io#linting"
        FAILED=1
    fi

    mdl --ignore-front-matter --style mdl_style.rb .
    if [[ "$?" != "0" ]]
    then
        FAILED=1
    fi

    grep -nr -e "(https://istio.io" .
    if [[ "$?" == "0" ]]
    then
        echo "Ensure markdown content uses relative references to istio.io"
        FAILED=1
    fi

    grep -nr -e "(https://preliminary.istio.io" .
    if [[ "$?" == "0" ]]
    then
        echo "Ensure markdown content doesn't contain references to preliminary.istio.io"
        FAILED=1
    fi

    grep -nr -e "https://github.com/istio/istio/blob/" .
    if [[ "$?" == "0" ]]
    then
        echo "Ensure markdown content uses {{< github_blob >}}"
        FAILED=1
    fi

    grep -nr -e "https://github.com/istio/istio/tree/" .
    if [[ "$?" == "0" ]]
    then
        echo "Ensure markdown content uses {{< github_tree >}}"
        FAILED=1
    fi

    grep -nr -e "https://raw.githubusercontent.com/istio/istio/" .
    if [[ "$?" == "0" ]]
    then
        echo "Ensure markdown content uses {{< github_file >}}"
        FAILED=1
    fi

    # go back whence we came
    popd  >/dev/null

    # cleanup
    rm -fr ${TMP}
}

check_content content --en-us
check_content content_zh --en-us

grep -nr -e "“" ./content
if [[ "$?" == "0" ]]
then
    echo "Ensure markdown content only uses standard quotation marks and not “"
    FAILED=1
fi

for f in `find ./public -type f -name '*.html'`
do
    grep -l -e "blockquote" $f
    if [[ "$?" == "0" ]]
    then
        echo "Ensure markdown content only uses {{< tip >}}, {{< warning >}}, {{< idea >}}, and {{< quote >}} instead of block quotes"
        FAILED=1
    fi

    grep -e "\"https://github.*#L[0-9]*\"" $f
    if [[ "$?" == "0" ]]
    then
        echo $f
        echo "Ensure markdown doesn't use links to specific lines in GitHub files as those are too brittle"
        FAILED=1
    fi
done

npx sass-lint -c sass-lint.yml --verbose 'src/sass/**/*.scss'
npx tslint src/ts/*.ts

htmlproofer ./public --assume-extension --check-html --check-external-hash --check-opengraph --timeframe 2d --storage-dir .htmlproofer --url-ignore "/localhost/,/github.com/istio/istio.io/edit/,/github.com/istio/istio/issues/new/choose/,/groups.google.com/forum/,/www.trulia.com/"
if [[ "$?" != "0" ]]
then
    FAILED=1
fi

if [[ ${FAILED} -eq 1 ]]
then
    echo "LINTING FAILED"
    exit 1
fi