Skip to main content

jan_cli/
runner.rs

1use std::ffi::OsString;
2use std::path::PathBuf;
3
4use anyhow::{anyhow, Context, Result};
5use clap::{ArgAction, Parser};
6
7use crate::{
8    builtins, default_db_path, format_help, load_spec, match_commands, resolve_git_branch,
9    resolve_preferred_spec, run_matched, RootSpec, RunContext,
10};
11
12#[derive(Parser, Debug)]
13#[command(name = "jan")]
14#[command(
15    about = "YAML-driven command tree loaded from the preferred directory (`jan use`)",
16    version,
17    disable_help_flag = true
18)]
19pub struct JanCli {
20    /// Print help for the loaded command tree (or framework help if none is configured)
21    #[arg(long, short = 'h', action = ArgAction::SetTrue, global = true)]
22    pub help: bool,
23
24    /// SQLite database path for invocation audit log
25    #[arg(long, value_name = "FILE", env = "JAN_DB", global = true)]
26    pub db: Option<PathBuf>,
27
28    /// Override git branch recorded in the audit log (default: `git rev-parse` or JAN_BRANCH)
29    #[arg(long, global = true)]
30    pub branch: Option<String>,
31
32    /// Do not write to the SQLite audit log
33    #[arg(long, global = true)]
34    pub no_log: bool,
35
36    /// Working directory for subprocesses and git branch detection
37    #[arg(long, global = true, default_value = ".")]
38    pub cwd: PathBuf,
39
40    /// Print how the preferred spec was resolved (stderr)
41    #[arg(short, long, global = true)]
42    pub verbose: bool,
43
44    /// Spec-defined subcommands, then optional passthrough args for `exec.passthrough`
45    #[arg(trailing_var_arg = true, allow_hyphen_values = true)]
46    pub command: Vec<OsString>,
47}
48
49fn framework_builtins_help() -> String {
50    "\
51Built-in commands:
52  use — set, show, or clear the preferred jan directory
53  bundle — pack the preferred YAML tree into a ZIP
54  alias — emit shell aliases for executable leaves
55  list — list script leaves in the preferred tree
56  search — find scripts by name/about/category
57  show — print details for a script leaf
58  validate — structural checks for the preferred tree
59  audit — query the SQLite invocation log
60  cron — run scripts whose `cron:` schedule matches now
61  packages — inspect / prune cached package environments (uv, pnpm, gradle)
62  test — run Given/When/Then shell tests for a command path (and nested)
63
64Global options:
65  -h, --help       Show this help (lists live subcommands when a preferred dir is set)
66  -V, --version    Print version
67  -v, --verbose    Explain how the preferred directory was resolved
68      --cwd <DIR>  Working directory for subprocesses (default: .)
69      --db <FILE>  SQLite audit log path
70      --branch <B> Override git branch recorded in the audit log
71      --no-log     Do not write to the audit log
72
73Configure a command tree with `jan use <DIR>`, then re-run `jan --help` to list live subcommands.
74"
75    .to_string()
76}
77
78fn print_root_help(spec: Option<&RootSpec>) {
79    match spec {
80        Some(spec) => {
81            print!("{}", format_help(spec, &[], None));
82        }
83        None => {
84            println!("jan — YAML-driven command tree\n");
85            println!("No preferred jan directory is configured yet.\n");
86            println!("  jan use <DIR>     Save a directory containing scripts.spec.yaml");
87            println!("  jan use --show    Show the saved preference\n");
88        }
89    }
90    print!("{}", framework_builtins_help());
91}
92
93pub fn run_jan() -> Result<i32> {
94    let cli = JanCli::parse();
95    let cwd = cli.cwd.canonicalize().unwrap_or_else(|_| cli.cwd.clone());
96
97    // Bootstrap builtins that must work without a loaded YAML tree.
98    if let Some(first) = cli.command.first() {
99        let key = first.to_string_lossy();
100        if builtins::is_pre_spec_builtin(key.as_ref()) {
101            let tail: Vec<_> = cli.command[1..].to_vec();
102            return match key.as_ref() {
103                "use" => builtins::run_use(&tail),
104                _ => Ok(0),
105            };
106        }
107    }
108
109    let loaded = match resolve_preferred_spec() {
110        Ok(pair) => Some(pair),
111        Err(e) => {
112            if cli.help || cli.command.is_empty() {
113                print_root_help(None);
114                if cli.verbose {
115                    eprintln!("jan: no preferred spec ({e:#})");
116                }
117                return Ok(0);
118            }
119            return Err(e);
120        }
121    };
122
123    let (spec_path, spec_identity) = loaded.expect("Ok branch always sets Some");
124    let spec = load_spec(&spec_path).with_context(|| format!("load {}", spec_path.display()))?;
125
126    if cli.verbose {
127        eprintln!("jan: cwd={}", cwd.display());
128        eprintln!(
129            "jan: preferred directory: {} / {}",
130            spec_identity.spec_dir, spec_identity.root_yaml
131        );
132    }
133
134    let branch = resolve_git_branch(&cwd, cli.branch.as_deref());
135    let is_test = cli
136        .command
137        .first()
138        .is_some_and(|s| s.to_string_lossy() == "test");
139    let no_log = cli.no_log || is_test || std::env::var_os("JAN_NO_LOG").is_some();
140    let audit_db = cli.db.as_ref().cloned().unwrap_or_else(default_db_path);
141    let db_path = if no_log { None } else { Some(audit_db.clone()) };
142
143    let ctx = RunContext {
144        cwd: &cwd,
145        db_path: db_path.as_deref(),
146        branch,
147        no_log,
148        spec_root: &spec_identity,
149    };
150
151    if cli.command.is_empty() {
152        print_root_help(Some(&spec));
153        return Ok(0);
154    }
155
156    if let Some(first) = cli.command.first() {
157        let key = first.to_string_lossy();
158        if builtins::is_builtin_reserved(key.as_ref()) {
159            let tail: Vec<_> = cli.command[1..].to_vec();
160            return match key.as_ref() {
161                "bundle" => builtins::bundle_spec_zip(&spec_identity, &tail, cli.verbose),
162                "alias" => builtins::emit_shell_aliases(&spec, &tail),
163                "use" => builtins::run_use(&tail),
164                "list" | "search" | "show" | "validate" => {
165                    let root = PathBuf::from(&spec_identity.spec_dir);
166                    crate::inspect::dispatch_inspect(key.as_ref(), &tail, &spec, None, Some(&root))
167                }
168                "audit" => crate::inspect::dispatch_inspect(
169                    key.as_ref(),
170                    &tail,
171                    &spec,
172                    Some(&audit_db),
173                    None,
174                ),
175                "cron" => crate::inspect::run_cron(&spec, &tail, &ctx),
176                "packages" => {
177                    let root = PathBuf::from(&spec_identity.spec_dir);
178                    crate::packages::dispatch_packages(&tail, &spec, &root)
179                }
180                "test" => crate::cmdtest::dispatch_test(&tail, &spec, &ctx),
181                _ => Ok(0),
182            };
183        }
184    }
185
186    let m = match_commands(&spec, &cli.command);
187
188    if cli.help || m.wants_help {
189        let help = format_help(&spec, &m.chain, m.node);
190        print!("{help}");
191        return Ok(0);
192    }
193
194    if m.trailing.iter().any(|a| a == "--help" || a == "-h") {
195        return Err(anyhow!(
196            "place --help immediately after the subcommand prefix you want help for"
197        ));
198    }
199
200    let node = match m.node {
201        Some(n) => n,
202        None => {
203            let key = cli.command[0].to_string_lossy();
204            return Err(anyhow!("unknown top-level command `{key}`"));
205        }
206    };
207
208    if !m.trailing.is_empty() && !node.is_leaf_exec() {
209        let t = m.trailing[0].to_string_lossy();
210        return Err(anyhow!("unknown subcommand `{t}`"));
211    }
212
213    if node.is_leaf_exec() {
214        return run_matched(&spec, &m.chain, node, &m.trailing, &ctx);
215    }
216
217    let help = format_help(&spec, &m.chain, Some(node));
218    print!("{help}");
219    Ok(0)
220}