fse-cli 0.6.0

The fse binary: generates and applies sqlx migrations from #[derive(Table)] structs and refreshes the offline query cache — no sqlx-cli needed.
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

//! `fse.toml` — all optional, all defaulted to the starter layout, so a
//! fresh app needs no config file at all. Nothing app-specific lives in the
//! CLI itself: even the framework's required-columns contract arrives here.

use std::collections::BTreeMap;
use std::path::Path;

use color_eyre::eyre::{Result, WrapErr, eyre};
use serde::Deserialize;

#[derive(Debug, Deserialize)]
#[serde(default)]
pub struct OrmConfig {
    /// Folder holding one `#[derive(Table)]` struct per file.
    pub tables_dir: String,
    /// Plain sqlx migrations folder; generated and hand-written migrations
    /// interleave by timestamp.
    pub migrations_dir: String,
    /// Committed snapshot of the schema the generated migrations produce.
    pub snapshot_path: String,
    /// Env var holding the database URL.
    pub database_url_env: String,
    /// Columns that must exist, per table — e.g. the framework's auth
    /// contract on `users`. Shipped in the starter template, not hardcoded.
    pub required_columns: BTreeMap<String, Vec<String>>,
    /// Module crate names (cargo package names) whose tables and frontend
    /// sources this app consumes. Their shipped `.fse/schema.json` snapshots
    /// merge into `fse migrate`; `fse sync` extracts their `frontend/`
    /// sources into `.fse/modules/` for the Astro build.
    pub modules: Vec<String>,
}

impl Default for OrmConfig {
    fn default() -> Self {
        Self {
            tables_dir: "src/tables".into(),
            migrations_dir: "migrations".into(),
            snapshot_path: ".fse/schema.json".into(),
            database_url_env: "DATABASE_URL".into(),
            required_columns: BTreeMap::new(),
            modules: Vec::new(),
        }
    }
}

#[derive(Debug, Default, Deserialize)]
struct FseToml {
    #[serde(default)]
    orm: OrmConfig,
}

pub fn load(root: &Path) -> Result<OrmConfig> {
    let path = root.join("fse.toml");
    if !path.exists() {
        return Ok(OrmConfig::default());
    }
    let raw = std::fs::read_to_string(&path)
        .wrap_err_with(|| format!("cannot read {}", path.display()))?;
    let parsed: FseToml = toml::from_str(&raw).wrap_err("fse.toml is not valid TOML")?;
    Ok(parsed.orm)
}

/// Reads `cfg.database_url_env` from `.env`/the environment, in that order.
/// `override_url` (from `--database-url`/test hooks) wins over both.
pub fn resolve_database_url(
    root: &Path,
    cfg: &OrmConfig,
    override_url: Option<&str>,
) -> Result<String> {
    if let Some(url) = override_url {
        return Ok(url.to_string());
    }
    dotenvy::from_path(root.join(".env")).ok();
    std::env::var(&cfg.database_url_env)
        .map_err(|_| eyre!("{} is not set (env or .env)", cfg.database_url_env))
}