From 3fef972a6b609fbd3b5d09446944a6820b0c2c0b Mon Sep 17 00:00:00 2001 From: Pierre Pronchery Date: Mon, 23 Oct 2017 03:27:26 +0200 Subject: [PATCH] Import a script for testing HTML compliance --- doc/scripts/htmllint.sh | 129 +++++++++++++++++++++++++++++++++++++++ doc/scripts/project.conf | 5 +- 2 files changed, 133 insertions(+), 1 deletion(-) create mode 100755 doc/scripts/htmllint.sh diff --git a/doc/scripts/htmllint.sh b/doc/scripts/htmllint.sh new file mode 100755 index 0000000..df4a4dd --- /dev/null +++ b/doc/scripts/htmllint.sh @@ -0,0 +1,129 @@ +#!/bin/sh +#$Id$ +#Copyright (c) 2014-2017 Pierre Pronchery +# +#Redistribution and use in source and binary forms, with or without +#modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this +# list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +#AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +#IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +#FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +#DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +#SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +#CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +#OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +#OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + +#variables +DEVNULL="/dev/null" +PROGNAME="htmllint.sh" +PROJECTCONF="../project.conf" +#executables +DATE="date" +DEBUG="_debug" +FIND="find" +HTMLLINT="xmllint --html" +SORT="sort -n" +TR="tr" + + +#functions +#htmllint +_htmllint() +{ + ret=0 + + $DATE + echo + while read line; do + case "$line" in + "["*) + break + ;; + "subdirs="*) + subdirs=${line#subdirs=} + subdirs=$(echo "$subdirs" | $TR ',' ' ') + ;; + esac + done < "$PROJECTCONF" + for subdir in $subdirs; do + [ -d "../$subdir" ] || continue + for filename in $($FIND "../$subdir" -iname '*.html' -o -iname '*.htm' | $SORT); do + $DEBUG $HTMLLINT "$filename" 2>&1 > "$DEVNULL" + if [ $? -eq 0 ]; then + echo "$filename:" + else + echo "$PROGNAME: $filename: FAIL" 1>&2 + ret=2 + fi + done + done + return $ret +} + + +#debug +_debug() +{ + echo "$@" 1>&3 + "$@" + res=$? + #ignore errors when the command is not available + [ $res -eq 127 ] && return 0 + return $res +} + + +#usage +_usage() +{ + echo "Usage: $PROGNAME [-c] target..." 1>&2 + return 1 +} + + +#main +clean=0 +while getopts "cO:P:" name; do + case "$name" in + c) + clean=1 + ;; + O) + export "${OPTARG%%=*}"="${OPTARG#*=}" + ;; + P) + #XXX ignored for compatibility + ;; + ?) + _usage + exit $? + ;; + esac +done +shift $((OPTIND - 1)) +if [ $# -lt 1 ]; then + _usage + exit $? +fi + +#clean +[ $clean -ne 0 ] && exit 0 + +exec 3>&1 +while [ $# -gt 0 ]; do + target="$1" + shift + + _htmllint > "$target" || exit 2 +done diff --git a/doc/scripts/project.conf b/doc/scripts/project.conf index cb7c0cf..6a84743 100644 --- a/doc/scripts/project.conf +++ b/doc/scripts/project.conf @@ -1,5 +1,5 @@ #$Id$ -dist=Makefile,appbroker.sh,clint.sh,docbook.sh,gettext.sh,gtkdoc.sh,manual.css.xml,phplint.sh,pkgconfig.sh,platform.sh,pylint.sh,shlint.sh,subst.sh,xmllint.sh +dist=Makefile,appbroker.sh,clint.sh,docbook.sh,gettext.sh,gtkdoc.sh,htmllint.sh,manual.css.xml,phplint.sh,pkgconfig.sh,platform.sh,pylint.sh,shlint.sh,subst.sh,xmllint.sh [appbroker.sh] install=$(PREFIX)/share/doc/configure/scripts @@ -16,6 +16,9 @@ install=$(PREFIX)/share/doc/configure/scripts [gtkdoc.sh] install=$(PREFIX)/share/doc/configure/scripts +[htmllint.sh] +install=$(PREFIX)/share/doc/configure/scripts + [manual.css.xml] install=$(PREFIX)/share/doc/configure/scripts