bashrs 6.66.0

//! SC2070: Use -n/-z for string length tests
//!
//! # Examples
//!
//! Bad:
//! ```bash
//! if [ "$var" ]; then
//!   echo "var is set"
//! fi
//! ```
//!
//! Good (explicit):
//! ```bash
//! if [ -n "$var" ]; then
//!   echo "var is non-empty"
//! fi
//! ```
//!
//! # Rationale
//!
//! Using `[ "$var" ]` tests if the variable is non-empty, but it's clearer
//! and more explicit to use `-n` (non-zero length) or `-z` (zero length).
//! This makes the intent clear and prevents confusion.
//!
//! # Auto-fix
//!
//! Replace `[ "$var" ]` with `[ -n "$var" ]`

use crate::linter::{Diagnostic, Fix, LintResult, Severity, Span};
use regex::Regex;

/// Check for implicit string length tests that should use -n/-z
static PATTERN: std::sync::LazyLock<Regex> =
    std::sync::LazyLock::new(|| Regex::new(r#"\[\s+("\$[A-Za-z_][A-Za-z0-9_]*")\s+\]"#).unwrap());

pub fn check(source: &str) -> LintResult {
    let mut result = LintResult::new();

    // Pattern: [ "$var" ] (implicit non-empty test)
    // Match single bracket tests with just a quoted variable
    // Simpler pattern to avoid complexity
    let pattern = &*PATTERN;

    for (line_num, line) in source.lines().enumerate() {
        let line_num = line_num + 1; // 1-indexed

        // Skip comments
        if line.trim_start().starts_with('#') {
            continue;
        }

        // Skip lines with [[ (double bracket - different semantics)
        if line.contains("[[") {
            continue;
        }

        for cap in pattern.captures_iter(line) {
            let full_match = cap.get(0).unwrap();
            let var = cap.get(1).unwrap().as_str(); // Includes quotes

            let start_col = full_match.start() + 1; // 1-indexed
            let end_col = full_match.end() + 1;

            // Auto-fix: add -n flag (var already has quotes)
            let fix_text = format!(r"[ -n {} ]", var);

            let diagnostic = Diagnostic::new(
                "SC2070",
                Severity::Info,
                "Use -n for explicit non-empty test (or -z for empty test)",
                Span::new(line_num, start_col, line_num, end_col),
            )
            .with_fix(Fix::new(fix_text));

            result.add(diagnostic);
        }
    }

    result
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_sc2070_basic_detection() {
        let script = r#"if [ "$var" ]; then echo "set"; fi"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 1);
        assert_eq!(result.diagnostics[0].code, "SC2070");
    }

    #[test]
    fn test_sc2070_autofix() {
        let script = r#"if [ "$var" ]; then echo "set"; fi"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 1);
        assert!(result.diagnostics[0].fix.is_some());
        assert_eq!(
            result.diagnostics[0].fix.as_ref().unwrap().replacement,
            r#"[ -n "$var" ]"#
        );
    }

    #[test]
    fn test_sc2070_braced_variable() {
        let script = r#"[ "${myvar}" ]"#;
        let result = check(script);
        // Currently may not match due to regex - this is a known limitation
        // Focus on common case first
        assert!(result.diagnostics.len() <= 1);
    }

    #[test]
    fn test_sc2070_false_positive_with_n_flag() {
        // Should NOT flag [ -n "$var" ] (already explicit)
        let script = r#"if [ -n "$var" ]; then echo "set"; fi"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2070_false_positive_with_z_flag() {
        // Should NOT flag [ -z "$var" ] (already explicit)
        let script = r#"if [ -z "$var" ]; then echo "empty"; fi"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2070_false_positive_comparison() {
        // Should NOT flag comparisons like [ "$var" = "value" ]
        let script = r#"if [ "$var" = "value" ]; then echo "yes"; fi"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2070_false_positive_double_bracket() {
        // Should NOT flag [[ ... ]] (different semantics)
        let script = r#"if [[ "$var" ]]; then echo "set"; fi"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2070_multiple_occurrences() {
        let script = r#"
if [ "$var1" ]; then
    echo "var1 set"
fi
if [ "$var2" ]; then
    echo "var2 set"
fi
"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 2);
    }

    #[test]
    fn test_sc2070_with_spaces() {
        let script = r#"[  "$var"  ]"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2070_false_positive_numeric_test() {
        // Should NOT flag numeric tests like [ "$num" -gt 5 ]
        let script = r#"if [ "$num" -gt 5 ]; then echo "big"; fi"#;
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 0);
    }
}