ci: Let's break everything by adding typo annotations

Author: JDBetteridge

.github/workflows/lint.yml

@@ -60,7 +60,7 @@ jobs:
 
     - name: Lint codebase with flake8
       run: |
-        typos --format sarif
+        typos --format json | python scripts/typos_json_to_gha.py
 
   actionlint:
     name: "Lint Github actions YAML files"

scripts/typos_json_to_gha.py

@@ -0,0 +1,28 @@
+import json
+import sys
+from string import Template
+
+
+def main():
+    # Standard Github message template for CI annotations
+    message_template = Template(
+        '::error file=$path,line=$line_num,col=$byte_offset,endcol=$end_col,'
+        'title=$type::`$typo` should be $suggestions'
+    )
+
+    for line in sys.stdin:
+        # Grab the JSON data coming from typos from stdin
+        data = json.loads(line.rstrip())
+
+        # Calculate the end column and format the correction
+        end_col = data['byte_offset'] + len(data['typo'])
+        suggestions = ', '.join(data['corrections'])
+
+        # Print the templated message to stdout
+        print(message_template.safe_substitute(
+            data, end_col=end_col, suggestions=suggestions
+        ))
+
+
+if __name__ == '__main__':
+    exit(main())