Improve command line interface

[jcfr]

Summary

These changes were implemented following the integration of Slicer/Slicer#7063 contributed by @jhlegarreta. These are intended to streamline the integration of project already using the checker provided by "codespell-project".

• By default, search files in current directory
• Initialize default list of suffixes
• Clarify --dict help string, and support --ignore-words and -I alternative
• Add support for excluding files specifying glob patterns
• Improve help string associated with the --exclude argument
• Add regular Python docstrings

Use in Slicer

mkvirtualenv codespell
python -m pip install git+https://github.com/jcfr/SimpleITKSpellChecking@improve-command-line-interface

Then apply this patch

diff --git a/Utilities/Scripts/runCodespell.sh b/Utilities/Scripts/runCodespell.sh
index 6cfe638836..283606868d 100755
--- a/Utilities/Scripts/runCodespell.sh
+++ b/Utilities/Scripts/runCodespell.sh
@@ -33,4 +33,5 @@ if [[ ! -e ${ignore_words_file} ]]; then
   exit 1
 fi
 
-codespell -w -q6 --skip="${skip}" -I ${ignore_words_file}
+codespell --skip="${skip}" -I ${ignore_words_file} \
+  --miss --verbose --prefix "vtkSlicer" --prefix "qSlicer" --prefix "vtkITK" --prefix "qMRML" --prefix "vtkMRML"

.. and run the script:

/path/to/Slicer/Utilities/Scripts/runCodespell.sh

cc: @lassoan @jamesobutler

[dave3d]

Looks good to me. Thanks for these improvements.

[jhlegarreta]

Sorry for being late. A few comments about docstrings. Thanks for doing this @jcfr.

[jcfr]

@jamesobutler @jhlegarreta

• Improve error checking #26