Add script, add script to ci.yml

Author: Cheezer1656

.github/workflows/ci.yml

@@ -226,3 +226,15 @@ jobs:
 
       - name: Check for unused dependencies
         run: cargo udeps --all --all-features
+  check-todos:
+    name: Check TODOs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+      
+      - name: Run todo checker script
+        run: python scripts/check_todos.py

scripts/check_todos.py

@@ -0,0 +1,31 @@
+import pathlib
+import re
+
+
+def check(lines: list[str]) -> list[tuple[int, str]]:
+    results = []
+    for (i, line) in enumerate(lines):
+        result = re.search(r"((//|/\*|///).*TODO|todo!)(?!.*\(#\d+\))", line)
+        if result:
+            results.append((i, line))
+    return results
+
+if __name__ == "__main__":
+    paths = list(pathlib.Path(".").rglob("*"))
+
+    clean = True
+    for path in paths:
+        if path.is_file():
+            with open(path, "r") as f:
+                try:
+                    lines = f.readlines()
+                    for (i, line) in check(lines):
+                        if clean:
+                            clean = False
+                        print(f"[{path}:{i}] {line}", end="")
+                except UnicodeDecodeError:
+                    continue
+    
+    if not clean:
+        print("\nYour code has TODOs that don't reference any issues! Create issues for your todos and reference them like this: `(#<issue number>)`. Example: // TODO: Foo (#123)")
+        exit(1)