Merge pull request #36 from jcfr/improve-display-output

Improve display output

Author: dave3d

codespell.py

@@ -90,8 +90,7 @@ def spell_check_comment(
     """Check comment and return list of identified issues if any."""
 
     if output_lvl > 1:
-        print(f"Comment: {c}")
-        print(type(c))
+        print(f"Line {c.line_number()}: {c}")
 
     mistakes = []
     spell_checker.set_text(c.text())
@@ -106,6 +105,8 @@ def spell_check_comment(
             if error.word.startswith(pre):
                 # check if the word is only the prefix
                 if len(pre) == len(error.word):
+                    if output_lvl > 1:
+                        print(f"Prefix '{pre}' matches word")
                     break
 
                 # remove the prefix
@@ -330,9 +331,12 @@ def parse_args():
     return args
 
 
-def add_dict(enchant_dict, filename):
+def add_dict(enchant_dict, filename, verbose=False):
     """Update ``enchant_dict`` spell checking dictionary with the words listed
     in ``filename`` (one word per line)."""
+    if verbose:
+        print(f"Additional dictionary: {filename}")
+
     with open(filename) as f:
         lines = f.read().splitlines()
 
@@ -347,30 +351,30 @@ def main():
 
     sitk_dict = Dict("en_US")
 
+    # Set the amount of debugging messages to print.
+    output_lvl = 1
+    if args.brief:
+        output_lvl = 0
+    else:
+        if args.verbose:
+            output_lvl = 2
+    if args.miss:
+        output_lvl = -1
+
     # Load the dictionary files
     #
     initial_dct = Path(__file__).parent / "additional_dictionary.txt"
     if not initial_dct.exists():
         initial_dct = None
     else:
-        add_dict(sitk_dict, str(initial_dct))
+        add_dict(sitk_dict, str(initial_dct), any([args.brief, output_lvl >= 0]))
 
     if args.dict is not None:
         for d in args.dict:
-            add_dict(sitk_dict, d)
+            add_dict(sitk_dict, d, any([args.brief, output_lvl >= 0]))
 
     spell_checker = SpellChecker(sitk_dict, filters=[EmailFilter, URLFilter])
 
-    # Set the amount of debugging messages to print.
-    output_lvl = 1
-    if args.brief:
-        output_lvl = 0
-    else:
-        if args.verbose:
-            output_lvl = 2
-    if args.miss:
-        output_lvl = -1
-
     file_list = []
     if len(args.filenames):
         file_list = args.filenames
@@ -386,7 +390,7 @@ def main():
     else:
         suffixes = args.suffix
 
-    if output_lvl > 1:
+    if any([args.brief, output_lvl >= 0]):
         print(f"Prefixes: {prefixes}")
         print(f"Suffixes: {suffixes}")