Merge pull request #44 from cgwalters/xtask-lint-dbg

ci: Move lints into xtask

Author: cgwalters

.github/workflows/ci.yml

@@ -21,8 +21,6 @@ jobs:
     container: quay.io/coreos-assembler/fcos-buildroot:testing-devel
     steps:
       - uses: actions/checkout@v3
-      - name: Code lints
-        run: ./ci/lints.sh
       - name: Install deps
         run: ./ci/installdeps.sh
       # xref containers/containers-image-proxy-rs
@@ -34,6 +32,8 @@ jobs:
         run: cargo test --no-run
       - name: Individual checks
         run: (cd cli && cargo check) && (cd lib && cargo check)
+      - name: Lints
+        run: cargo xtask custom-lints
       - name: Run tests
         run: cargo test -- --nocapture --quiet
       - name: Manpage generation

ci/lints.sh

@@ -1,5 +1,5 @@
 use std::fs::File;
-use std::io::{BufRead, BufReader, BufWriter, Write};
+use std::io::{BufRead, BufReader, BufWriter, Cursor, Write};
 use std::process::{Command, Stdio};
 
 use anyhow::{Context, Result};
@@ -12,21 +12,27 @@ const VENDORPATH: &str = "target/vendor.tar.zstd";
 
 fn main() {
     if let Err(e) = try_main() {
-        eprintln!("{e:?}");
+        eprintln!("error: {e:?}");
         std::process::exit(1);
     }
 }
 
+#[allow(clippy::type_complexity)]
+const TASKS: &[(&str, fn(&Shell) -> Result<()>)] = &[
+    ("vendor", vendor),
+    ("package", package),
+    ("package-srpm", package_srpm),
+    ("custom-lints", custom_lints),
+];
+
 fn try_main() -> Result<()> {
     let task = std::env::args().nth(1);
     let sh = xshell::Shell::new()?;
     if let Some(cmd) = task.as_deref() {
-        let f = match cmd {
-            "vendor" => vendor,
-            "package" => package,
-            "package-srpm" => package_srpm,
-            _ => print_help,
-        };
+        let f = TASKS
+            .iter()
+            .find_map(|(k, f)| (*k == cmd).then_some(*f))
+            .unwrap_or(print_help);
         f(&sh)?;
     } else {
         print_help(&sh)?;
@@ -166,11 +172,22 @@ fn package_srpm(sh: &Shell) -> Result<()> {
     Ok(())
 }
 
+fn custom_lints(sh: &Shell) -> Result<()> {
+    // Verify there are no invocations of the dbg macro.
+    let o = cmd!(sh, "git grep dbg\x21 *.rs").ignore_status().read()?;
+    if !o.is_empty() {
+        let mut stderr = std::io::stderr().lock();
+        std::io::copy(&mut Cursor::new(o.as_bytes()), &mut stderr)?;
+        eprintln!();
+        anyhow::bail!("Found dbg\x21 macro");
+    }
+    Ok(())
+}
+
 fn print_help(_sh: &Shell) -> Result<()> {
-    eprintln!(
-        "Tasks:
-  - vendor
-"
-    );
+    println!("Tasks:");
+    for (name, _) in TASKS {
+        println!("  - {name}");
+    }
     Ok(())
 }