edtr 0.1.0

An editor router/transfer tool that dispatches files to the right editor based on rules.
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

//! Generic backend: spawn a CLI editor with template-expanded arguments.
//!
//! File placement semantics (v0.1):
//! - Arg templates are rendered ONCE using the FIRST file's context.
//! - All files are then appended as trailing positional arguments.
//!
//! This matches 99% of editors (VSCode `--reuse-window`, vim, emacs, etc.) and
//! keeps the mental model simple. Per-file arg placement is deferred to v0.2.

use std::collections::BTreeMap;
use std::path::{Path, PathBuf};
use std::process::{Command as StdCommand, Stdio};

use anyhow::{Context as _, Result, anyhow};
use tracing::{debug, info};

use crate::config::Mode;
use crate::platform;
use crate::template::{FileParts, build_context, render};

#[derive(Debug, Clone)]
pub struct GenericBackend {
    pub command: String,
    pub args_new: Vec<String>,
    pub args_remote: Vec<String>,
    pub env: BTreeMap<String, String>,
}

pub struct DispatchCtx<'a> {
    pub files: &'a [PathBuf],
    pub mode: Mode,
    pub sync: bool,
    pub group: &'a str,
    pub rule_name: &'a str,
    pub vars: &'a BTreeMap<String, toml::Value>,
    pub cwd: &'a str,
}

impl GenericBackend {
    pub fn dispatch(&self, dctx: DispatchCtx<'_>) -> Result<()> {
        if dctx.files.is_empty() {
            return Ok(());
        }

        let args_template = match dctx.mode {
            Mode::Remote => &self.args_remote,
            Mode::New => &self.args_new,
        };

        let rendered_args = self.render_args(args_template, &dctx)?;

        let mut cmd = StdCommand::new(&self.command);
        cmd.args(&rendered_args);
        for f in dctx.files {
            cmd.arg(f);
        }
        for (k, v) in &self.env {
            cmd.env(k, v);
        }

        debug!(
            command = %self.command,
            args = ?rendered_args,
            files = ?dctx.files,
            sync = dctx.sync,
            "generic dispatch"
        );

        if dctx.sync {
            self.run_sync(&mut cmd)
        } else {
            self.run_detached(&mut cmd, dctx.files.first().map(PathBuf::as_path))
        }
    }

    fn render_args(&self, templates: &[String], dctx: &DispatchCtx<'_>) -> Result<Vec<String>> {
        let first = FileParts::from_path(dctx.files.first().unwrap());
        let editor_parts = FileParts::from_path(Path::new(&self.command));
        let ctx = build_context(
            &first,
            Some(&editor_parts),
            dctx.cwd,
            dctx.group,
            dctx.rule_name,
            dctx.vars,
        );
        let mut tera = crate::template::new_engine();
        templates
            .iter()
            .map(|t| {
                render(&mut tera, t, &ctx).with_context(|| format!("rendering arg template: {t}"))
            })
            .collect()
    }

    fn run_detached(&self, cmd: &mut StdCommand, file_for_log: Option<&Path>) -> Result<()> {
        info!(command = %self.command, "spawning detached");
        platform::spawn_detached(cmd, file_for_log.unwrap_or(Path::new("")))
            .with_context(|| format!("failed to spawn {}", self.command))
    }

    fn run_sync(&self, cmd: &mut StdCommand) -> Result<()> {
        info!(command = %self.command, "spawning sync (inherit stdio)");
        cmd.stdin(Stdio::inherit())
            .stdout(Stdio::inherit())
            .stderr(Stdio::inherit());
        let status = cmd
            .status()
            .with_context(|| format!("failed to run {}", self.command))?;
        if status.success() {
            Ok(())
        } else {
            Err(anyhow!("{} exited with status {}", self.command, status))
        }
    }
}

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

    #[test]
    fn renders_template_args_with_file_context() {
        let backend = GenericBackend {
            command: "echo".into(),
            args_new: vec![
                "--file={{ file_stem }}".into(),
                "--ext={{ file_ext }}".into(),
            ],
            args_remote: vec![],
            env: BTreeMap::new(),
        };
        let files = vec![PathBuf::from("/tmp/hello.rs")];
        let vars = BTreeMap::new();
        let dctx = DispatchCtx {
            files: &files,
            mode: Mode::New,
            sync: false,
            group: "g",
            rule_name: "r",
            vars: &vars,
            cwd: "/tmp",
        };
        let args = backend.render_args(&backend.args_new, &dctx).unwrap();
        assert_eq!(args, vec!["--file=hello", "--ext=rs"]);
    }
}