Add TODO checker (#1632)

Author: reddevilmidzy

.github/workflows/main.yml

@@ -19,6 +19,16 @@ env:
   RUSTFLAGS: "-Dwarnings"
 
 jobs:
+  todo_check:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Check todo
+      run: ./y.sh check-todo
+
   rustfmt:
     runs-on: ubuntu-latest
     timeout-minutes: 10
@@ -232,7 +242,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     if: ${{ github.ref == 'refs/heads/main' }}
-    needs: [rustfmt, test, bench, dist]
+    needs: [todo_check, rustfmt, test, bench, dist]
 
     permissions:
       contents: write # for creating the dev tag and release

build_system/main.rs

@@ -17,6 +17,7 @@ mod prepare;
 mod rustc_info;
 mod shared_utils;
 mod tests;
+mod todo;
 mod utils;
 
 fn usage() {
@@ -38,6 +39,7 @@ enum Command {
     Test,
     AbiCafe,
     Bench,
+    CheckTodo,
 }
 
 #[derive(Copy, Clone, Debug)]
@@ -66,6 +68,7 @@ fn main() {
         Some("test") => Command::Test,
         Some("abi-cafe") => Command::AbiCafe,
         Some("bench") => Command::Bench,
+        Some("check-todo") => Command::CheckTodo,
         Some(flag) if flag.starts_with('-') => arg_error!("Expected command found flag {}", flag),
         Some(command) => arg_error!("Unknown command {}", command),
         None => {
@@ -139,6 +142,10 @@ fn main() {
         process::exit(0);
     }
 
+    if command == Command::CheckTodo {
+        todo::run();
+    }
+
     let rustup_toolchain_name = match (env::var("CARGO"), env::var("RUSTC"), env::var("RUSTDOC")) {
         (Ok(_), Ok(_), Ok(_)) => None,
         (_, Err(_), Err(_)) => Some(rustc_info::get_toolchain_name()),
@@ -202,7 +209,7 @@ fn main() {
         ))
     };
     match command {
-        Command::Prepare => {
+        Command::Prepare | Command::CheckTodo => {
             // Handled above
         }
         Command::Test => {

build_system/todo.rs

@@ -0,0 +1,70 @@
+use std::ffi::OsStr;
+use std::path::{Path, PathBuf};
+use std::process::Command;
+use std::{fs, process};
+
+const EXTENSIONS: &[&str] =
+    &["rs", "py", "js", "sh", "c", "cpp", "h", "md", "css", "ftl", "toml", "yml", "yaml"];
+
+fn has_supported_extension(path: &Path) -> bool {
+    path.extension().is_some_and(|ext| EXTENSIONS.iter().any(|e| ext == OsStr::new(e)))
+}
+
+fn list_tracked_files() -> Result<Vec<PathBuf>, String> {
+    let output = Command::new("git")
+        .args(["ls-files", "-z"])
+        .output()
+        .map_err(|e| format!("Failed to run `git ls-files`: {e}"))?;
+
+    if !output.status.success() {
+        let stderr = String::from_utf8_lossy(&output.stderr);
+        return Err(format!("`git ls-files` failed: {stderr}"));
+    }
+
+    let mut files = Vec::new();
+    for entry in output.stdout.split(|b| *b == 0) {
+        if entry.is_empty() {
+            continue;
+        }
+        let path = std::str::from_utf8(entry).unwrap();
+        files.push(PathBuf::from(path));
+    }
+
+    Ok(files)
+}
+
+pub(crate) fn run() -> ! {
+    let files = list_tracked_files().unwrap();
+    let mut error_count = 0;
+    // Avoid embedding the task marker in source so greps only find real occurrences.
+    let todo_marker = "todo".to_ascii_uppercase();
+
+    for file in files {
+        if !has_supported_extension(&file) {
+            continue;
+        }
+
+        let bytes = fs::read(&file).unwrap();
+        let contents = std::str::from_utf8(&bytes).unwrap();
+
+        for (i, line) in contents.split('\n').enumerate() {
+            let trimmed = line.trim();
+            if trimmed.contains(&todo_marker) {
+                eprintln!(
+                    "{}:{}: {} is used for tasks that should be done before merging a PR; if you want to leave a message in the codebase use FIXME",
+                    file.display(),
+                    i + 1,
+                    todo_marker
+                );
+                error_count += 1;
+            }
+        }
+    }
+
+    if error_count == 0 {
+        process::exit(0);
+    }
+
+    eprintln!("found {} {}(s)", error_count, todo_marker);
+    process::exit(1);
+}

build_system/usage.txt

@@ -6,6 +6,7 @@ USAGE:
     ./y.sh test [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen] [--skip-test TESTNAME]
     ./y.sh abi-cafe [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen]
     ./y.sh bench [--sysroot none|clif|llvm] [--out-dir DIR] [--download-dir DIR] [--no-unstable-features] [--frozen]
+    ./y.sh check-todo
 
 OPTIONS:
     --sysroot none|clif|llvm