feat: Modified format_checkers to add checker name to dictionary allow (#1571)

* fixes #1567

* feat: Modified format_checkers to add checker name to dictionary allow if needed

* fix: insertion method

* fix: removed network request for online dictionary

* docs: updated contributing.md for format_cherckers

* refactor: added type hints

Author: yashugarg

CONTRIBUTING.md

@@ -237,7 +237,7 @@ We use [pyupgrade](https://github.com/asottile/pyupgrade) to make sure our synta
 
 We also have a spell checker set up to help us avoid typos in documentation.  The [spelling actions readme file](https://github.com/intel/cve-bin-tool/tree/main/.github/actions/spelling) gives more information including how to add new words to the dictionary if needed.
 
-We also have a tool to help make sure that new checkers are added to the tables in our documentation, this is automatically done with github actions.  [The format_checkers code is here](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/format_checkers.py), if you're curious.
+We also have a tool to help make sure that new checkers are added to the tables in our documentation and relevant words associated with checker names are put in allow dictionary for spelling checks, this is done automatically with GitHub actions. [The format_checkers code is here](https://github.com/intel/cve-bin-tool/blob/main/cve_bin_tool/format_checkers.py), if you're curious.
 
 You can view all the config files for GitHub Actions (what we use for Continuous Integration (CI)) in [the .github/workflows directory](https://github.com/intel/cve-bin-tool/tree/main/.github/workflows).
 

cve_bin_tool/format_checkers.py

@@ -4,6 +4,7 @@
 """To reformat checkers table when cve_bin_tool/checkers/__init__.py is updated."""
 
 import os
+import re
 
 from cve_bin_tool import checkers
 
@@ -76,9 +77,33 @@ def update_checker_table(file_path, markdown):
         f.writelines(lines)
 
 
+def update_allowed_words(checkers_array: list[str]) -> None:
+    """Updates the allow.txt file with the new checkers"""
+    file_path = os.path.join(
+        os.path.abspath("."), ".github", "actions", "spelling", "allow.txt"
+    )
+
+    checkers_words = re.findall(r"[^0-9_]+", "_".join(checkers_array))
+    fileObj = open(file_path)
+    words = fileObj.read().splitlines()
+    fileObj.close()
+
+    for checker in checkers_words:
+        if checker not in words:
+            words.append(checker)
+
+    words = sorted(words, key=str.casefold)
+
+    fileObj = open(file_path, "w+")
+    fileObj.writelines("\n".join(words))
+    fileObj.close()
+
+
 if __name__ == "__main__":
     checkers_array = list(set(checkers.__all__) - {"Checker", "VendorProductPair"})
-    checkers_array = reshape_list(sorted(checkers_array))
+    checkers_array.sort()
+    update_allowed_words(checkers_array)
+    checkers_array = reshape_list(checkers_array)
     shape_list = max_checker_length(checkers_array)
     checkers_markdown = reformat_checkers(checkers_array, shape_list)
     update_checker_table(