Add CI checks against todo comments without issues

Author: chitoyuu

.github/workflows/minimal-ci.yml

@@ -12,6 +12,8 @@ env:
   # Don't use more features like "gdnative_bindings_generator/debug" to keep CI truly minimal
   GDRUST_FEATURES: "gdnative/async,gdnative/serde"
 
+  RIPGREP_VERSION: "13.0.0"
+
 on:
   pull_request:
     branches:
@@ -52,6 +54,19 @@ jobs:
       - name: "Check clippy"
         run: cargo clippy --workspace --features ${GDRUST_FEATURES} -- -D clippy::style -D clippy::complexity -D clippy::perf -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented
 
+  check-todo:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: "Install ripgrep"
+        run: |
+          cd /tmp
+          wget --no-verbose https://github.com/BurntSushi/ripgrep/releases/download/${RIPGREP_VERSION}/ripgrep-${RIPGREP_VERSION}-x86_64-unknown-linux-musl.tar.gz -O ripgrep.tar.gz
+          tar -zxvf ripgrep.tar.gz
+          sudo mv ripgrep-${RIPGREP_VERSION}-x86_64-unknown-linux-musl/rg /usr/bin
+      - name: "Look for TODO comments without issue numbers attached to them"
+        run: bash tools/detect-todo.sh
+
   unit-test:
     runs-on: ubuntu-latest
     steps:

tools/detect-todo.sh

@@ -0,0 +1,75 @@
+#!/usr/bin/bash
+
+# Small utility to detect todo comments
+# Used by godot-rust developers
+
+REGEX='(?<!clippy::)(TODO|FIXME)(?!!\(\)|[a-zA-Z]|\((#|(\w+/)+)\d+\))'
+
+# Self test
+
+TEST_OUTPUT=$(rg -i --pcre2 "$REGEX" <<EOF
+# Should hit - Naive
+
+todo
+TODO
+fixme
+FiXmE
+reallytodo
+trulyfixme
+
+# Should hit - Malformed
+
+todo123
+fixme123
+TODO(123)
+TODO(/////)
+TODO(T123)
+
+# Should not hit - With issue numbers
+
+todo(#123)
+todo(foo/bar/123)
+fixme(#123)
+fixme(foo/bar/123)
+
+# Should not hit - Other uses of the words
+
+clippy::todo
+todo!()
+
+# Should not hit - Words merely containing the keywords
+
+mastodon
+ictodosaur
+EOF
+)
+
+diff -u --color <(printf '%s\n' "$TEST_OUTPUT") <(cat <<EOF
+todo
+TODO
+fixme
+FiXmE
+reallytodo
+trulyfixme
+todo123
+fixme123
+TODO(123)
+TODO(/////)
+TODO(T123)
+EOF
+)
+
+if [[ $? -ne 0 ]]
+then
+    echo 'Test run of detection regex failed.'
+    exit 1
+fi
+
+# Actual run
+
+rg -iTh -Tsh --pcre2 "$REGEX"
+if [[ $? -eq 0 ]]
+then
+    echo 'Found TODO comments without issue numbers.'
+    exit 1
+fi