Use Hunspell spell checker instead of Aspell

Following upcoming recommendation of Fedora to depreciate Aspell and
migrate to Hunspell [1]. Update documentation and scripts to use
Hunspell.

[1] https://fedoraproject.org/wiki/Changes/AspellDeprecation

Author: xdelaruelle

.gitattributes

@@ -16,6 +16,6 @@ script/nglfar2ccov export-ignore
 script/commit-msg export-ignore
 script/pre-commit export-ignore
 .codespellrc export-ignore
-.aspell.en.pws export-ignore
+.hunspell.en.dic export-ignore
 # no export of website-specific content
 doc/talk export-ignore

.gitignore

@@ -11,7 +11,6 @@
 /lint.sum
 /icdiff
 /.noicdiff
-/.aspell.en.prepl
 /miniconda3
 /nagelfar*
 /OpenFOAM-dev

.aspell.en.pws .hunspell.en.dic.aspell.en.pws renamed to .hunspell.en.dic

@@ -1,4 +1,3 @@
-personal_ws-1.1 en 907
 ABBRVLIST
 ActiveTcl
 Adrien

CONTRIBUTING.rst

@@ -223,21 +223,21 @@ Commit hooks
 A :command:`pre-commit` hook script is provided in the :file:`script`
 directory of the project to help you check that the contribution made is free
 of misspellings and trailing spaces. It requires the `codespell`_ utility that
-checks for typos in any kind of files and the `Aspell`_ utility that spell
+checks for typos in any kind of files and the `Hunspell`_ utility that spell
 checks documentation files. The :command:`pre-commit` could be enabled in your
 local repository with following command::
 
    ln -s ../../script/pre-commit .git/hooks/pre-commit
 
 A :command:`commit-msg` hook script is also provided in the :file:`script`
 directory of the project to help you check that your commit messages are free
-of misspellings. It requires the `Aspell`_ utility and could be enabled in
+of misspellings. It requires the `Hunspell`_ utility and could be enabled in
 your local repository with following command::
 
    ln -s ../../script/commit-msg .git/hooks/commit-msg
 
 .. _codespell: https://github.com/codespell-project/codespell
-.. _Aspell: http://aspell.net/
+.. _Hunspell: https://hunspell.github.io/
 
 Emacs settings for coding conventions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

NEWS.rst

@@ -21,6 +21,10 @@ Modules 5.3.1 (not yet released)
   (fix issue #494)
 * Fix extra specifier requirement search when module searched is also defining
   a requirement and is the sole module to define it. (fix issue #495)
+* Script: update :command:`pre-commit` and :command:`commit-msg` git hook
+  scripts to use `Hunspell`_ as spell checker instead of Aspell.
+
+.. _Hunspell: https://hunspell.github.io/
 
 
 Modules 5.3.0 (2023-05-14)

script/commit-msg

@@ -1,7 +1,7 @@
 #!/bin/bash
 #
 # COMMIT-MSG, hook script to verify commit message
-# Copyright (C) 2022 Xavier Delaruelle
+# Copyright (C) 2022-2023 Xavier Delaruelle
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -45,11 +45,11 @@ echo_hint() {
 }
 
 # check misspellings in commit message
-command -v aspell >/dev/null
+command -v hunspell >/dev/null
 if [ $? -eq 0 ]; then
-   ASPELL_OPTS=(-l en -x --home-dir=. --personal=.aspell.en.pws)
+   HUNSPELL_OPTS=(-d en_US -p .hunspell.en.dic)
    # use sed to extract commit message from full commit details
-   words=$(sed '/^# /Q' "$1" | aspell "${ASPELL_OPTS[@]}" list)
+   words=$(sed '/^# /Q' "$1" | hunspell "${HUNSPELL_OPTS[@]}" -l)
    # abort if misspelled words found
    if [ -n "$words" ]; then
       befmsg='# commit message was ---------------- >8 -------------'
@@ -60,7 +60,7 @@ if [ $? -eq 0 ]; then
       exit 1
    fi
 else
-   echo_warning "aspell command not found"
+   echo_warning "hunspell command not found"
 fi
 
 exit 0

script/pre-commit

@@ -1,7 +1,7 @@
 #!/bin/bash
 #
 # PRE-COMMIT, hook script to verify what is about to be committed
-# Copyright (C) 2022 Xavier Delaruelle
+# Copyright (C) 2022-2023 Xavier Delaruelle
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -52,17 +52,17 @@ else
 fi
 
 # interactively check misspellings in doc files
-command -v aspell >/dev/null
+command -v hunspell >/dev/null
 if [ $? -eq 0 ]; then
    misspell=0
-   ASPELL_OPTS=(-l en -x --home-dir=. --personal=.aspell.en.pws)
+   HUNSPELL_OPTS=(-d en_US -p .hunspell.en.dic)
    for docfile in $(git diff --cached --name-only --diff-filter=d | grep -E\
       '(.rst|.md)$'); do
-      words=$(git diff --cached "$docfile" | grep '^[+][^+]' | aspell\
-         "${ASPELL_OPTS[@]}" list)
+      words=$(git diff --cached "$docfile" | grep '^[+][^+]' | hunspell\
+         "${HUNSPELL_OPTS[@]}" -l)
       if [ -n "$words" ]; then
          # interactively edit file to fix misspellings
-         aspell "${ASPELL_OPTS[@]}" check "$docfile" </dev/tty >/dev/tty;
+         hunspell "${HUNSPELL_OPTS[@]}" "$docfile" </dev/tty >/dev/tty;
          misspell=1
       fi
    done
@@ -72,7 +72,7 @@ if [ $? -eq 0 ]; then
       exit 1
    fi
 else
-   echo_warning "aspell command not found"
+   echo_warning "hunspell command not found"
 fi
 
 # fail if there are whitespace errors