Merge pull request #55 from dave3d/ImproveMessaging

Improved misspelled word message; warn about bad dictionary words

Author: dave3d

comment_spell_check.py

@@ -377,6 +377,11 @@ def add_dict(enchant_dict, filename, verbose=False):
 
     # You better not have more than 1 word in a line
     for wrd in lines:
+        if not wrd.replace("'", "").isidentifier():
+            print(
+                "Warning: adding word with non-alphanumeric characters to dictionary:",
+                wrd,
+            )
         if not enchant_dict.check(wrd):
             enchant_dict.add(wrd)
 
@@ -482,22 +487,26 @@ def main():
     # Done spell checking.  Print out all the words not found in our dictionary.
     #
     if not args.miss:
-        print("\nBad words\n")
+        print("\nBad words")
 
     previous_word = ""
+    print("")
 
     for misspelled_word, found_file, line_num in bad_words:
-        if misspelled_word != previous_word:
+        if misspelled_word != previous_word and args.first:
             print(f"\n{misspelled_word}:")
 
         if (misspelled_word == previous_word) and args.first:
             sys.stderr.write(".")
             continue
 
         if args.vim:
-            print(f"    vim +{line_num} {found_file}", file=sys.stderr)
+            print(f"vim +{line_num} {found_file}", file=sys.stderr)
         else:
-            print(f"    {found_file}, {line_num}", file=sys.stderr)
+            print(
+                f"file: {found_file:30}  line: {line_num:3d}  word: {misspelled_word}",
+                file=sys.stderr,
+            )
 
         previous_word = misspelled_word