Merge pull request #32 from RafaelJohn9/update/template-first-line-convention

RafaelJohn9 · web-flow · commit f93feb97c119 · 2025-06-30T11:56:28.000+03:00
feat: added test and workflow that verifies templates
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -1,4 +1,3 @@
-
 # Bug Report Template
 name: 🐛 Bug Report
 description: Report unexpected behavior, failures, or issues in the project.
diff --git a/.github/workflows/verify-templates.yml b/.github/workflows/verify-templates.yml
@@ -0,0 +1,17 @@
+name: Verify Templates
+
+on:
+  pull_request:
+
+jobs:
+  verify-templates:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+      - name: Run verify-templates test
+        run: cargo test --test verify_templates
diff --git a/templates/CODE_OF_CONDUCT.md b/templates/CODE_OF_CONDUCT.md
@@ -1,3 +1,4 @@
+<!-- outlines the expected standards of behavior for individuals within an organization or group. -->
 # Code of Conduct
 
 ## Our Commitment
diff --git a/templates/issue-templates/bug.yml b/templates/issue-templates/bug.yml
@@ -1,4 +1,3 @@
-
 # Bug Report Template
 name: 🐛 Bug Report
 description: Report unexpected behavior, failures, or issues in the project.
diff --git a/templates/pr-templates/bug.md b/templates/pr-templates/bug.md
@@ -1,4 +1,6 @@
+<!-- Submit a fix for a known bug -->
 ---
+
 name: 🐞 Bug Fix
 about: Submit a fix for a known bug
 title: "[BUGFIX] <short summary>"
diff --git a/templates/pr-templates/community.md b/templates/pr-templates/community.md
@@ -1,4 +1,7 @@
+<!-- Propose or enhance collaboration with the community -->
+
 ---
+
 name: 🤝 Community Collaboration
 about: Propose or enhance collaboration with the community
 title: "[COMMUNITY] <short summary>"
diff --git a/templates/pr-templates/default.md b/templates/pr-templates/default.md
@@ -1,4 +1,6 @@
+<!-- Submit a new feature, bug fix, or improvement -->
 ---
+
 name: 🚀 Pull Request
 about: Submit a new feature, bug fix, or improvement
 title: "[PR] <short summary>"
diff --git a/templates/pr-templates/docs.md b/templates/pr-templates/docs.md
@@ -1,3 +1,4 @@
+<!-- Propose improvements or additions to project documentation -->
 ---
 name: 📚 Documentation Update
 about: Propose improvements or additions to project documentation
diff --git a/templates/pr-templates/dx.md b/templates/pr-templates/dx.md
@@ -1,3 +1,4 @@
+<!-- Share feedback or suggestions to improve the developer experience -->
 ---
 name: 🛠️ Developer Experience Feedback
 about: Share feedback or suggestions to improve the developer experience
diff --git a/templates/pr-templates/feature.md b/templates/pr-templates/feature.md
@@ -1,3 +1,4 @@
+<!-- Propose and implement a new feature -->
 ---
 name: ✨ Feature Request
 about: Propose and implement a new feature
diff --git a/templates/pr-templates/test.md b/templates/pr-templates/test.md
@@ -1,3 +1,4 @@
+<!-- Propose changes to tests or add new tests -->
 ---
 name: 🧪 Test Improvement
 about: Propose changes to tests or add new tests
diff --git a/tests/verify_templates.rs b/tests/verify_templates.rs
@@ -0,0 +1,90 @@
+use std::collections::HashMap;
+use std::fs;
+use std::io::{BufRead, BufReader};
+use std::path::Path;
+
+// Checks that all template files in the `templates` directory start with a comment
+// appropriate for their file type. This is useful for ensuring that templates are well-documented
+// and provide clear instructions or context for users who create new repositories from these templates.
+#[test]
+fn all_templates_start_with_comment() {
+    let template_dir = Path::new("./templates");
+
+    // Map extensions to comment symbols
+    let comment_map = HashMap::from([
+        ("rs", "//"),
+        ("py", "#"),
+        ("sh", "#"),
+        ("js", "//"),
+        ("ts", "//"),
+        ("html", "<!--"),
+        ("css", "/*"),
+        ("yaml", "#"),
+        ("yml", "#"),
+        ("toml", "#"),
+        ("md", "<!--"),
+    ]);
+
+    assert!(
+        template_dir.exists(),
+        "Template directory does not exist: {:?}",
+        template_dir
+    );
+
+    fn check_templates_in_dir(
+        dir: &Path,
+        comment_map: &HashMap<&str, &str>,
+        failed_files: &mut Vec<(String, String, String)>,
+    ) {
+        for entry in fs::read_dir(dir).expect("Failed to read templates directory") {
+            let entry = entry.expect("Failed to read file entry");
+            let path = entry.path();
+
+            if path.is_dir() {
+                check_templates_in_dir(&path, comment_map, failed_files);
+            } else if path.is_file() {
+                let extension = path.extension().and_then(|s| s.to_str()).unwrap_or("");
+                let comment_prefix = comment_map.get(extension).unwrap_or(&"#");
+
+                let file = fs::File::open(&path).expect("Failed to open template file");
+                let mut reader = BufReader::new(file);
+                let mut first_line = String::new();
+
+                reader
+                    .read_line(&mut first_line)
+                    .expect("Failed to read first line");
+
+                let trimmed = first_line.trim_start();
+
+                let starts_with_comment = trimmed.starts_with(comment_prefix);
+                if !starts_with_comment {
+                    failed_files.push((
+                        path.display().to_string(),
+                        comment_prefix.to_string(),
+                        first_line.clone(),
+                    ));
+                }
+            }
+        }
+    }
+
+    let mut failed_files = Vec::new();
+    check_templates_in_dir(template_dir, &comment_map, &mut failed_files);
+
+    if !failed_files.is_empty() {
+        println!("\n❌ The following files do not start with the expected comment:");
+        for (file, expected, first_line) in &failed_files {
+            println!(
+                "🔺 File: {}\n  Expected prefix: {:?}\n  First line: {}\n",
+                file,
+                expected,
+                first_line.trim_end()
+            );
+        }
+    }
+
+    assert!(
+        failed_files.is_empty(),
+        "Some template files do not start with the expected comment. See output above."
+    );
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`# Bug Report Template`
`3`	`2`	`name: 🐛 Bug Report`
`4`	`3`	`description: Report unexpected behavior, failures, or issues in the project.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<!-- outlines the expected standards of behavior for individuals within an organization or group. -->`
`1`	`2`	`# Code of Conduct`
`2`	`3`
`3`	`4`	`## Our Commitment`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<!-- Propose improvements or additions to project documentation -->`
`1`	`2`	`---`
`2`	`3`	`name: 📚 Documentation Update`
`3`	`4`	`about: Propose improvements or additions to project documentation`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<!-- Share feedback or suggestions to improve the developer experience -->`
`1`	`2`	`---`
`2`	`3`	`name: 🛠️ Developer Experience Feedback`
`3`	`4`	`about: Share feedback or suggestions to improve the developer experience`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<!-- Propose and implement a new feature -->`
`1`	`2`	`---`
`2`	`3`	`name: ✨ Feature Request`
`3`	`4`	`about: Propose and implement a new feature`