book: stringtable lints (#958)

* book: stringtable lints

* format, typo

Author: BrettMayson

Cargo.lock

@@ -8,6 +8,7 @@ hemtt = { path = "../bin" }
 hemtt-common = { path = "../libs/common" }
 hemtt-config = { path = "../libs/config" }
 hemtt-sqf = { path = "../libs/sqf" }
+hemtt-stringtable = { path = "../libs/stringtable" }
 hemtt-workspace = { path = "../libs/workspace" }
 
 arma3-wiki = { workspace = true }

book-gen/Cargo.toml

@@ -8,6 +8,7 @@ use hemtt_sqf::analyze::{
         LintS02EventIncorrectCommand, LintS02EventInsufficientVersion, LintS02EventUnknown,
     },
 };
+use hemtt_stringtable::analyze::STRINGTABLE_LINTS;
 use hemtt_workspace::lint::{Lint, Lints};
 use mdbook::book::Chapter;
 
@@ -20,6 +21,9 @@ pub fn run(chapter: &mut Chapter) {
             if chapter.name == "SQF" {
                 sqf(chapter);
             }
+            if chapter.name == "Stringtables" {
+                stringtables(chapter);
+            }
         }
     }
 }
@@ -63,6 +67,19 @@ fn sqf(chapter: &mut Chapter) {
     chapter.content = output;
 }
 
+fn stringtables(chapter: &mut Chapter) {
+    let mut output = String::from("# Lints - Stringtables\n\n");
+    let mut lint_text: Vec<(u32, String)> = Vec::new();
+    for lint in STRINGTABLE_LINTS.iter().filter(|l| l.display()) {
+        lint_text.push((lint.sort(), get_text(&**lint, "L-L")));
+    }
+    lint_text.sort_by(|a, b| a.0.cmp(&b.0));
+    for (_, text) in lint_text {
+        output.push_str(&text);
+    }
+    chapter.content = output;
+}
+
 fn get_text<D>(lint: &Arc<Box<dyn Lint<D>>>, prefix: &str) -> String {
     let mut text = String::new();
     text.push_str(&format!("\n***\n## {}\n", lint.ident()));

book-gen/src/lints.rs

@@ -55,10 +55,11 @@
 
 # Reference
 
-- [Analysis](analysis/index.md)
+- [Lints](analysis/index.md)
   - [Preprocessor](analysis/preprocessor.md)
   - [Config](analysis/config.md)
   - [SQF](analysis/sqf.md)
+  - [Stringtables](analysis/stringtables.md)
 
 <!--
 # Modding Guide

book/SUMMARY.md

@@ -1,7 +1,8 @@
-# Analysis
+# Lints
 
-HEMTT will analyze your project for some common issues.
+HEMTT will analyze your project for some common issues and best practices.
 
 [Preprocessor](./preprocessor.md)  
 [Config](./config.md)  
 [SQF](./sqf.md)
+[Stringtables](./stringtables.md)

book/analysis/index.md

@@ -0,0 +1 @@
+# This file will be generated, do not edit it manually

book/analysis/stringtables.md

@@ -38,7 +38,7 @@ impl Lint<LintData> for LintL02Usage {
         
 Configuration
 
-- **ignore**: Array of stringtable entries to ignore
+- **ignore**: Array of stringtable entries to ignore, supports regex or wildcards (`*`)
 - **ignore_missing**: Bool to ignore missing stringtables (still written to .hemttout when disabled)
 - **ignore_unused**: Bool to ignore missing stringtables (still written to .hemttout when disabled)
 - **ignore_duplicate**: Bool to ignore missing stringtables (still written to .hemttout when disabled)
@@ -137,8 +137,16 @@ impl LintRunner<LintData> for Runner {
         if let Some(toml::Value::Array(ignore)) = config.option("ignore") {
             for i in ignore {
                 let i_lower = i.as_str().map_or(String::new(), str::to_lowercase);
-                unused.retain(|s| *s != i_lower);
-                missing.retain(|sp| *sp.0 != i_lower);
+                if i_lower.contains('*') {
+                    let regex_pattern = &i_lower.replace('*', ".*");
+                    if let Ok(re) = Regex::new(&format!("^{regex_pattern}$")) {
+                        unused.retain(|s| !re.is_match(s));
+                        missing.retain(|sp| !re.is_match(&sp.0));
+                    }
+                } else {
+                    unused.retain(|s| *s != i_lower);
+                    missing.retain(|sp| *sp.0 != i_lower);
+                }
             }
         }
         let ignore_missing = config