calepin 0.0.3

A Rust CLI for preprocessing Typst documents with executable code chunks
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

// External tool availability checks and error messages.
//
// Centralizes all knowledge about which CLI tools calepin depends on,
// how to detect them, and what to tell the user when they're missing.

/// An external tool that calepin may invoke.
pub struct Tool {
    /// Command name (looked up on PATH).
    pub cmd: &'static str,
    /// Install instructions shown when the tool is missing.
    pub install_hint: &'static str,
}

// ---------------------------------------------------------------------------
// Tool registry
// ---------------------------------------------------------------------------

pub const RSCRIPT: Tool = Tool {
    cmd: "Rscript",
    install_hint: "install from https://cran.r-project.org/",
};

pub const PYTHON: Tool = Tool {
    cmd: "python3",
    install_hint: "install from https://www.python.org/downloads/",
};

pub const JULIA: Tool = Tool {
    cmd: "julia",
    install_hint: "install from https://julialang.org/downloads/",
};

pub const SH: Tool = Tool {
    cmd: "/bin/sh",
    install_hint: "/bin/sh should be available on any Unix system",
};

pub const MMDC: Tool = Tool {
    cmd: "mmdc",
    install_hint: "install with `npm install -g @mermaid-js/mermaid-cli`",
};

pub const DOT: Tool = Tool {
    cmd: "dot",
    install_hint: "install Graphviz from https://graphviz.org/download/",
};

pub const TECTONIC: Tool = Tool {
    cmd: "tectonic",
    install_hint: "install from https://tectonic-typesetting.github.io/",
};

pub const DVISVGM: Tool = Tool {
    cmd: "dvisvgm",
    install_hint: "install TeX Live or MacTeX from https://tug.org/texlive/",
};

pub const PDF2SVG: Tool = Tool {
    cmd: "pdf2svg",
    install_hint: "install with `brew install pdf2svg` or from your system package manager",
};

pub const D2: Tool = Tool {
    cmd: "d2",
    install_hint: "install from https://d2lang.com/tour/install/",
};

// ---------------------------------------------------------------------------
// Checks
// ---------------------------------------------------------------------------

/// Format a "not found" error message for a tool.
pub fn not_found_message(tool: &Tool) -> String {
    format!("{} not found on PATH. {}", tool.cmd, tool.install_hint)
}

/// Format a "not found" error for a configured tool path.
pub fn configured_not_found_message(tool: &Tool, program: &std::path::Path) -> String {
    format!("{} not found. {}", program.display(), tool.install_hint)
}