use anyhow::{anyhow, Context, Result};
use serde::Deserialize;
use std::path::{Path, PathBuf};
use crate::utils::path::{expand_home, is_path_like};
use crate::utils::tools;
pub const PYTHON_EXECUTABLE_ENV_VAR: &str = "CALEPIN_PYTHON";
#[cfg(windows)]
pub const PROJECT_VENV_PYTHON_RELATIVE_PATH: &str = ".venv/Scripts/python.exe";
#[cfg(not(windows))]
pub const PROJECT_VENV_PYTHON_RELATIVE_PATH: &str = ".venv/bin/python";
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CalepinConfig {
pub executables: ExecutablePaths,
}
impl CalepinConfig {
pub fn load(root: &Path, config_path: Option<&Path>) -> Result<Self> {
let Some(path) = config_path else {
return Ok(Self::default_for_root(root));
};
let path = resolve_config_path(path)?;
if !path.exists() {
return Err(anyhow!("config file not found: {}", path.display()));
}
let contents = std::fs::read_to_string(&path)
.with_context(|| format!("failed to read {}", path.display()))?;
let raw: RawCalepinConfig = toml::from_str(&contents)
.with_context(|| format!("failed to parse {}", path.display()))?;
let config_dir = path.parent().unwrap_or(root);
Ok(Self {
executables: ExecutablePaths::from_raw(root, config_dir, raw.executables),
})
}
fn default_for_root(root: &Path) -> Self {
Self {
executables: ExecutablePaths::from_raw(root, root, RawExecutablePaths::default()),
}
}
}
fn resolve_config_path(path: &Path) -> Result<PathBuf> {
if path.is_absolute() {
Ok(path.to_path_buf())
} else {
Ok(std::env::current_dir()?.join(path))
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ExecutablePaths {
pub typst: PathBuf,
pub rscript: PathBuf,
pub python: PathBuf,
pub mmdc: PathBuf,
pub dot: PathBuf,
pub tectonic: PathBuf,
pub dvisvgm: PathBuf,
pub pdf2svg: PathBuf,
pub d2: PathBuf,
pub chrome: Option<PathBuf>,
}
impl ExecutablePaths {
pub fn defaults() -> Self {
Self {
typst: PathBuf::from("typst"),
rscript: PathBuf::from(tools::RSCRIPT.cmd),
python: PathBuf::from(tools::PYTHON.cmd),
mmdc: PathBuf::from(tools::MMDC.cmd),
dot: PathBuf::from(tools::DOT.cmd),
tectonic: PathBuf::from(tools::TECTONIC.cmd),
dvisvgm: PathBuf::from(tools::DVISVGM.cmd),
pdf2svg: PathBuf::from(tools::PDF2SVG.cmd),
d2: PathBuf::from(tools::D2.cmd),
chrome: None,
}
}
fn from_raw(project_root: &Path, config_dir: &Path, raw: RawExecutablePaths) -> Self {
let defaults = Self::defaults();
let env_python = std::env::var_os(PYTHON_EXECUTABLE_ENV_VAR)
.filter(|value| !value.is_empty())
.map(PathBuf::from);
let python = match raw.python {
Some(path) => resolve_tool_path(config_dir, path),
None => env_python
.or_else(|| project_venv_python(project_root))
.map(|path| resolve_tool_path(project_root, path))
.unwrap_or(defaults.python),
};
Self {
typst: tool_path(config_dir, raw.typst, defaults.typst),
rscript: tool_path(config_dir, raw.rscript, defaults.rscript),
python,
mmdc: tool_path(config_dir, raw.mmdc, defaults.mmdc),
dot: tool_path(config_dir, raw.dot, defaults.dot),
tectonic: tool_path(config_dir, raw.tectonic, defaults.tectonic),
dvisvgm: tool_path(config_dir, raw.dvisvgm, defaults.dvisvgm),
pdf2svg: tool_path(config_dir, raw.pdf2svg, defaults.pdf2svg),
d2: tool_path(config_dir, raw.d2, defaults.d2),
chrome: raw.chrome.map(|path| resolve_tool_path(config_dir, path)),
}
}
}
#[derive(Debug, Default, Deserialize)]
#[serde(default)]
struct RawCalepinConfig {
executables: RawExecutablePaths,
}
#[derive(Debug, Default, Deserialize)]
#[serde(default)]
struct RawExecutablePaths {
typst: Option<PathBuf>,
rscript: Option<PathBuf>,
python: Option<PathBuf>,
mmdc: Option<PathBuf>,
dot: Option<PathBuf>,
tectonic: Option<PathBuf>,
dvisvgm: Option<PathBuf>,
pdf2svg: Option<PathBuf>,
d2: Option<PathBuf>,
chrome: Option<PathBuf>,
}
fn tool_path(root: &Path, value: Option<PathBuf>, default: PathBuf) -> PathBuf {
value
.map(|path| resolve_tool_path(root, path))
.unwrap_or(default)
}
fn project_venv_python(root: &Path) -> Option<PathBuf> {
let path = root.join(PROJECT_VENV_PYTHON_RELATIVE_PATH);
path.is_file()
.then(|| PathBuf::from(PROJECT_VENV_PYTHON_RELATIVE_PATH))
}
fn resolve_tool_path(root: &Path, path: PathBuf) -> PathBuf {
let path = expand_home(path);
if path.is_absolute() || !is_path_like(&path) {
return path;
}
root.join(path)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::utils::testutil::{env_lock, EnvVarGuard};
#[test]
fn missing_config_uses_current_defaults() {
let _env_lock = env_lock();
let _env = EnvVarGuard::unset(PYTHON_EXECUTABLE_ENV_VAR);
let dir = tempfile::tempdir().unwrap();
let config = CalepinConfig::load(dir.path(), None).unwrap();
assert_eq!(config.executables.typst, PathBuf::from("typst"));
assert_eq!(config.executables.python, PathBuf::from("python3"));
assert_eq!(config.executables.rscript, PathBuf::from("Rscript"));
}
#[test]
fn missing_config_uses_python_env_default() {
let _env_lock = env_lock();
let _env = EnvVarGuard::set(PYTHON_EXECUTABLE_ENV_VAR, "env-python");
let dir = tempfile::tempdir().unwrap();
let config = CalepinConfig::load(dir.path(), None).unwrap();
assert_eq!(config.executables.python, PathBuf::from("env-python"));
}
#[test]
fn missing_config_uses_project_venv_python() {
let _env_lock = env_lock();
let _env = EnvVarGuard::unset(PYTHON_EXECUTABLE_ENV_VAR);
let dir = tempfile::tempdir().unwrap();
let python = dir.path().join(PROJECT_VENV_PYTHON_RELATIVE_PATH);
std::fs::create_dir_all(python.parent().unwrap()).unwrap();
std::fs::write(&python, "").unwrap();
let config = CalepinConfig::load(dir.path(), None).unwrap();
assert_eq!(config.executables.python, python);
}
#[test]
fn config_overrides_executable_paths() {
let _env_lock = env_lock();
let _env = EnvVarGuard::set(PYTHON_EXECUTABLE_ENV_VAR, "env-python");
let dir = tempfile::tempdir().unwrap();
let calepin_dir = dir.path().join(".calepin");
std::fs::create_dir(&calepin_dir).unwrap();
std::fs::write(
calepin_dir.join("config.toml"),
r#"[executables]
typst = "typst-dev"
python = ".venv/bin/python"
chrome = "tools/chrome"
"#,
)
.unwrap();
let config =
CalepinConfig::load(dir.path(), Some(&calepin_dir.join("config.toml"))).unwrap();
assert_eq!(config.executables.typst, PathBuf::from("typst-dev"));
assert_eq!(
config.executables.python,
calepin_dir.join(".venv/bin/python")
);
assert_eq!(
config.executables.chrome,
Some(calepin_dir.join("tools/chrome"))
);
}
#[test]
fn config_expands_home_in_executable_paths() {
let _env_lock = env_lock();
let dir = tempfile::tempdir().unwrap();
let home = dir.path().join("home");
std::fs::create_dir(&home).unwrap();
let _home = EnvVarGuard::set("HOME", home.to_str().unwrap());
let calepin_dir = dir.path().join(".calepin");
std::fs::create_dir(&calepin_dir).unwrap();
std::fs::write(
calepin_dir.join("config.toml"),
r#"[executables]
typst = "~/Downloads/typst"
"#,
)
.unwrap();
let config =
CalepinConfig::load(dir.path(), Some(&calepin_dir.join("config.toml"))).unwrap();
assert_eq!(config.executables.typst, home.join("Downloads/typst"));
}
#[test]
fn explicit_relative_config_path_resolves_from_current_directory() {
let _env_lock = env_lock();
let dir = tempfile::tempdir().unwrap();
let project = dir.path().join("project");
let docs = project.join("docs");
std::fs::create_dir_all(&docs).unwrap();
std::fs::write(
project.join("project.toml"),
r#"[executables]
typst = "typst-dev"
"#,
)
.unwrap();
let previous = std::env::current_dir().unwrap();
std::env::set_current_dir(&project).unwrap();
let config = CalepinConfig::load(&docs, Some(Path::new("project.toml")));
std::env::set_current_dir(previous).unwrap();
let config = config.unwrap();
assert_eq!(config.executables.typst, PathBuf::from("typst-dev"));
}
}