clash 0.5.5

Command Line Agent Safety Harness — permission policies for coding agents
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

use std::path::PathBuf;
use std::process::Command;

use anyhow::{Context, Result};
use tracing::{Level, debug, instrument};

use crate::settings::ClashSettings;
use crate::style;
use crate::ui;

/// Handle `clash fmt`.
#[instrument(level = Level::TRACE)]
pub fn run(check: bool, files: Vec<PathBuf>) -> Result<()> {
    let targets = if files.is_empty() {
        discover_policy_files()?
    } else {
        validate_paths(&files)?
    };

    if targets.is_empty() {
        let diag = crate::settings::ClashSettings::diagnose_missing_policies();
        let details: Vec<String> = diag
            .iter()
            .map(|(level, path, reason)| format!("  {level} ({path}): {reason}"))
            .collect();
        anyhow::bail!(
            "no policy files found\n\nChecked:\n{}\n\nhint: run `clash init` to create a policy",
            details.join("\n")
        );
    }

    let ruff = find_ruff()?;
    debug!(?ruff, ?targets, check, "running ruff format");

    let mut cmd = Command::new(&ruff);
    cmd.arg("format");
    if check {
        cmd.arg("--check");
    }
    // Treat .star files as Python — Starlark is a syntactic subset
    cmd.arg("--extension").arg("star:python");
    for target in &targets {
        cmd.arg(target);
    }

    let status = cmd
        .status()
        .with_context(|| format!("failed to run: {}", ruff.display()))?;

    if !status.success() {
        if check {
            let paths: Vec<_> = targets.iter().map(|p| p.display().to_string()).collect();
            eprintln!(
                "\n{}: {} not formatted",
                style::err_red_bold("error"),
                paths.join(", "),
            );
            eprintln!(
                "  {}: run {} to fix",
                style::err_cyan_bold("hint"),
                style::bold("clash fmt"),
            );
        }
        std::process::exit(status.code().unwrap_or(1));
    }

    if !check {
        for target in &targets {
            ui::success(&target.display().to_string());
        }
    }
    Ok(())
}

/// Discover all active policy `.star` files across levels.
fn discover_policy_files() -> Result<Vec<PathBuf>> {
    let levels = ClashSettings::available_policy_levels();
    let paths: Vec<PathBuf> = levels
        .into_iter()
        .filter(|(_, path)| path.extension().is_some_and(|ext| ext == "star"))
        .map(|(_, path)| path)
        .collect();
    Ok(paths)
}

/// Validate that all provided paths exist and are `.star` files.
fn validate_paths(files: &[PathBuf]) -> Result<Vec<PathBuf>> {
    for path in files {
        if !path.exists() {
            anyhow::bail!("file not found: {}", path.display());
        }
        if path.extension().and_then(|e| e.to_str()) != Some("star") {
            anyhow::bail!("expected a .star file, got: {}", path.display(),);
        }
    }
    Ok(files.to_vec())
}

/// Locate the `ruff` binary, or return a helpful error.
fn find_ruff() -> Result<PathBuf> {
    which::which("ruff").map_err(|_| {
        anyhow::anyhow!(
            "ruff is not installed\n\n  \
             Install it with one of:\n    \
             pip install ruff\n    \
             brew install ruff\n    \
             cargo install ruff\n\n  \
             See https://docs.astral.sh/ruff/installation/"
        )
    })
}

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

    #[test]
    fn validate_paths_rejects_non_star() {
        let dir = tempfile::tempdir().unwrap();
        let json_file = dir.path().join("policy.json");
        std::fs::File::create(&json_file)
            .unwrap()
            .write_all(b"{}")
            .unwrap();

        let err = validate_paths(&[json_file]).unwrap_err();
        assert!(err.to_string().contains(".star"), "got: {err}");
    }

    #[test]
    fn validate_paths_rejects_missing_file() {
        let err = validate_paths(&[PathBuf::from("/nonexistent/policy.star")]).unwrap_err();
        assert!(err.to_string().contains("not found"), "got: {err}");
    }

    #[test]
    fn validate_paths_accepts_star_file() {
        let dir = tempfile::tempdir().unwrap();
        let star_file = dir.path().join("policy.star");
        std::fs::File::create(&star_file)
            .unwrap()
            .write_all(b"x = 1")
            .unwrap();

        let result = validate_paths(std::slice::from_ref(&star_file));
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), vec![star_file]);
    }
}