From a3657188b63d20b33f6770552169a473f021228f Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Thu, 4 Jul 2024 20:28:46 +0200
Subject: [PATCH] Check for missing TODO comments

---
 src/dev/check.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/dev/check.rs b/src/dev/check.rs
index 5074c133..29b2b670 100644
--- a/src/dev/check.rs
+++ b/src/dev/check.rs
@@ -92,6 +92,10 @@ fn check_info_file_exercises(info_file: &InfoFile) -> Result<hashbrown::HashSet<
             bail!("The `main` function is missing in the file `{path}`.\nCreate at least an empty `main` function to avoid language server errors");
         }
 
+        if !file_buf.contains("// TODO") {
+            bail!("Didn't find any `// TODO` comment in the file `{path}`.\nYou need to have at least one such comment to guide the user.");
+        }
+
         if !exercise_info.test && file_buf.contains("#[test]") {
             bail!("The file `{path}` contains tests annotated with `#[test]` but the exercise `{name}` has `test = false` in the `info.toml` file");
         }