git: 5c2757dff4 - main - [tools] Add spell checking scripts

The branch main has been updated by fernape:

URL: https://cgit.FreeBSD.org/doc/commit/?id=5c2757dff4fdc315f56a31bd6ba642a17d030a36

commit 5c2757dff4fdc315f56a31bd6ba642a17d030a36
Author:     Fernando Apesteguía <fernape@FreeBSD.org>
AuthorDate: 2021-10-12 16:00:52 +0000
Commit:     Fernando Apesteguía <fernape@FreeBSD.org>
CommitDate: 2021-10-13 13:37:03 +0000

    [tools] Add spell checking scripts
    
    Summary:
    Add two small scripts to do spell checking in .po files.
    
    When working with Weblate, the web browser provides some spell checking with
    visual hints for every translation entry.
    
    These scripts provide spell checking for the whole file showing the faulting
    words in context.
    
    Relies on `msgexec(1)` and `aspell(1)` from `devel/gettext-tools` and
    `textproc/aspell`.
    
    It can be tested with:
    
    `./po_spellcheck.sh ../documentation/content/es/articles/bsdl-gpl/_index.po es`
    
    Reviewed by:    carlavilla@, dbaio@
    Differential Revision: https://reviews.freebsd.org/D32465
---
 tools/po_check_entry.sh | 59 +++++++++++++++++++++++++++++++++++++++++++++++++
 tools/po_spellcheck.sh  | 51 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 110 insertions(+)

diff --git a/tools/po_check_entry.sh b/tools/po_check_entry.sh
new file mode 100755
index 0000000000..00d9eb7b5a
--- /dev/null
+++ b/tools/po_check_entry.sh
@@ -0,0 +1,59 @@
+#!/bin/sh
+#
+# Copyright (c) 2021 Fernando Apesteguia <fernape@FreeBSD.org>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. 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.
+
+# Check for aspell. Everything else is in base.
+COMMAND=aspell
+if ! command -v ${COMMAND} >/dev/null; then
+	echo "${COMMAND} not found, please run 'pkg install aspell $your_lang-aspell'"
+	exit 1
+fi
+
+LANG="${1}"
+
+if [ -z "${LANG}" ]; then
+	echo "No language specified"
+	exit 1
+fi
+
+translation=$(cat /dev/stdin)
+
+# Build a grep(1) filter with all the words aspell(1) could not find in this
+# translated text.
+
+filter=
+for word in $(echo "${translation}" | aspell list --lang="${LANG}");do
+	tmp=$(printf "%s" "${word}|")
+	filter="${filter}${tmp}"
+done
+
+filter=$(echo "${filter}" | sed -e 's/|$//g')
+
+# Hilight the translation in the text providing the user with some context about
+# where the reported words are used.
+if [ -n "${filter}" ]; then
+	echo "----------- translation -----------" 
+	echo "${translation}" | grep -Ew --color "${filter}" 
+	echo
+fi
diff --git a/tools/po_spellcheck.sh b/tools/po_spellcheck.sh
new file mode 100755
index 0000000000..c8802e40de
--- /dev/null
+++ b/tools/po_spellcheck.sh
@@ -0,0 +1,51 @@
+#!/bin/sh
+#
+# Copyright (c) 2021 Fernando Apesteguia <fernape@FreeBSD.org>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. 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.
+
+# Check for aspell. Everything else is in base.
+COMMAND=msgexec
+if ! command -v ${COMMAND} >/dev/null; then
+	echo "${COMMAND} not found, please run 'pkg install docproj'"
+	exit 1
+fi
+
+usage()
+{
+	echo "${0} <path_to_po_file> <language>"
+	echo "Example: ${0} documentation/content/es/articles/bsdl-gpl/_index.po es"
+}
+
+if [ ${#} -ne 2 ]; then
+	usage
+	exit 1
+fi
+
+PO_FILE="${1}"
+LANG="${2}"
+
+# msgexec acts as a driver, invoking a command for every
+# translated text
+
+CURDIR=$(dirname "${0}")
+msgexec -i "${PO_FILE}" "${CURDIR}"/po_check_entry.sh "${LANG}"