fy-docs 0.1.6

Cargo subcommand for building and previewing Typst specification documents
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
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265

mod assets;
mod compiler;
mod project;
mod scaffold;
mod server;
mod state;
mod watcher;

use anyhow::Result;
use clap::{Parser, Subcommand};
use std::ffi::{OsStr, OsString};
use std::path::{Path, PathBuf};
use std::sync::Arc;

use crate::state::AppState;

#[derive(Parser)]
#[command(
    name = "cargo-fy-docs",
    bin_name = "cargo fy-docs",
    version,
    about = "Build, preview, and generate Typst specification documents (HTML & PDF 2.0) with i18n support"
)]
struct Cli {
    /// Typst compile root; auto-detected from imports when omitted
    #[arg(long, global = true)]
    root: Option<PathBuf>,

    /// Target specific language (e.g., "zh-CN", "en", "zh-TW")
    #[arg(long, global = true)]
    lang: Option<String>,

    /// Open in default web browser after build
    #[arg(long, global = true)]
    open: bool,

    /// Also compile a print-edition PDF into docs/release/ (for build/html subcommands)
    #[arg(long, global = true)]
    with_pdf: bool,

    /// Server port for dev mode (increments on collision)
    #[arg(long, global = true, default_value_t = 8181)]
    port: u16,

    /// Do not open the browser in dev mode
    #[arg(long, global = true)]
    no_open: bool,

    #[command(subcommand)]
    command: Option<Command>,
}

#[derive(Subcommand)]
enum Command {
    /// Scaffold a new docs/ directory with a starter template
    Init,
    /// Build everything (HTML pages and PDF 2.0 specifications) - default command
    Build,
    /// Build only the offline HTML documentation
    Html,
    /// Compile only the print-edition PDF 2.0 specification(s) into docs/release/
    Pdf,
    /// Start interactive development server with live reload and browser preview
    Dev,
    /// Deprecated alias for dev
    #[command(hide = true)]
    Serve,
}

#[tokio::main]
async fn main() -> Result<()> {
    let cli = Cli::parse_from(cargo_external_args(std::env::args_os()));
    let cwd = crate::project::clean_canonicalize(&std::env::current_dir()?)?;
    dispatch(cli, &cwd).await
}

async fn dispatch(cli: Cli, cwd: &Path) -> Result<()> {
    // Init does not require an existing docs/ directory.
    if matches!(cli.command, Some(Command::Init)) {
        return scaffold::init(cwd);
    }

    let project = project::detect(cwd, cli.root.as_deref())?;
    let state = Arc::new(AppState::new(project));

    match cli.command {
        Some(Command::Init) => unreachable!(),
        None | Some(Command::Build) => {
            // Default: Full build of both HTML and PDF
            compiler::generate_into(&state, true, cli.lang.as_deref());
            state.write_build();
            state::log(&format!(
                "[fy-docs] generated {}",
                state::display_path(&state.project.target_dir)
            ));
            if cli.open {
                let index_path = state.project.target_dir.join(compiler::INDEX_FILE);
                let _ = open::that_detached(index_path);
            }
        }
        Some(Command::Html) => {
            // HTML only (or with PDF if explicitly asked)
            compiler::generate_into(&state, cli.with_pdf, cli.lang.as_deref());
            state.write_build();
            state::log(&format!(
                "[fy-docs] HTML generated in {}",
                state::display_path(&state.project.target_dir)
            ));
            if cli.open {
                let index_path = state.project.target_dir.join(compiler::INDEX_FILE);
                let _ = open::that_detached(index_path);
            }
        }
        Some(Command::Pdf) => {
            // PDF 2.0 specifications only
            let paths = compiler::compile_pdf(&state.project, cli.lang.as_deref())?;
            for path in paths {
                state::log(&format!(
                    "[fy-docs] PDF written to {}",
                    state::display_path(&path)
                ));
            }
        }
        Some(Command::Dev) | Some(Command::Serve) => {
            // Dev mode: live server + watcher
            compiler::generate_into(&state, cli.with_pdf, cli.lang.as_deref());
            state.write_build();
            watcher::spawn(state.clone())?;

            let app = server::router(&state);
            let listener = bind(cli.port).await?;
            let url = format!("http://{}", listener.local_addr()?);
            state::log(&format!("[fy-docs] serving at {url}"));
            if !cli.no_open {
                if let Err(err) = open::that_detached(&url) {
                    state::log(&format!(
                        "[fy-docs] could not open a browser ({err}); open {url} manually"
                    ));
                }
            }
            axum::serve(listener, app)
                .with_graceful_shutdown(async {
                    let _ = tokio::signal::ctrl_c().await;
                    state::log("[fy-docs] shutting down");
                })
                .await?;
        }
    }
    Ok(())
}

/// Cargo invokes external commands as `cargo-<name> <name> ...`; remove the
/// forwarded subcommand name so Clap receives the tool's own arguments.
fn cargo_external_args<I>(args: I) -> Vec<OsString>
where
    I: IntoIterator<Item = OsString>,
{
    let mut args = args.into_iter();
    let mut normalized = vec![
        args.next()
            .unwrap_or_else(|| OsString::from("cargo-fy-docs")),
    ];
    if let Some(first) = args.next()
        && first != OsStr::new("fy-docs")
    {
        normalized.push(first);
    }
    normalized.extend(args);
    normalized
}

async fn bind(port: u16) -> Result<tokio::net::TcpListener> {
    let last = port.saturating_add(19);
    for candidate in port..=last {
        match tokio::net::TcpListener::bind(("127.0.0.1", candidate)).await {
            Ok(listener) => return Ok(listener),
            Err(err) if err.kind() == std::io::ErrorKind::AddrInUse => continue,
            Err(err) => return Err(err.into()),
        }
    }
    anyhow::bail!("no free port in {port}..={last}")
}

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

    #[test]
    fn removes_cargo_forwarded_subcommand_name() {
        let args = ["cargo-fy-docs", "fy-docs", "dev"]
            .into_iter()
            .map(OsString::from);
        let normalized = cargo_external_args(args);
        assert_eq!(
            normalized,
            vec![OsString::from("cargo-fy-docs"), OsString::from("dev")]
        );
    }

    #[test]
    fn keeps_direct_executable_arguments() {
        let args = ["cargo-fy-docs", "html", "--root", "."]
            .into_iter()
            .map(OsString::from);
        let normalized = cargo_external_args(args);
        assert_eq!(
            normalized,
            vec![
                OsString::from("cargo-fy-docs"),
                OsString::from("html"),
                OsString::from("--root"),
                OsString::from(".")
            ]
        );
    }

    #[test]
    fn cli_parses_all_subcommands_and_flags() {
        let args = ["cargo-fy-docs", "build", "--lang", "zh-CN", "--open"]
            .into_iter()
            .map(OsString::from);
        let cli = Cli::parse_from(cargo_external_args(args));
        assert!(matches!(cli.command, Some(Command::Build)));
        assert_eq!(cli.lang.as_deref(), Some("zh-CN"));
        assert!(cli.open);
    }

    #[tokio::test]
    async fn bind_allocates_available_listener() {
        let listener = bind(8181).await.expect("bind should find a free port");
        assert!(listener.local_addr().is_ok());
    }

    #[tokio::test]
    async fn dispatch_executes_build_pdf_html_init_commands() {
        let temp = std::env::temp_dir().join(format!("fy-docs-main-run-{}", std::process::id()));
        let _ = std::fs::remove_dir_all(&temp);
        std::fs::create_dir_all(&temp).unwrap();
        let clean_temp = crate::project::clean_canonicalize(&temp).unwrap();

        // 1. init
        let init_cli = Cli::parse_from(["cargo-fy-docs", "init"]);
        dispatch(init_cli, &clean_temp).await.unwrap();
        assert!(clean_temp.join("docs/main.typ").is_file());
        assert!(clean_temp.join("docs/fy-spec/lib.typ").is_file());

        // 2. build (HTML + PDF)
        let build_cli = Cli::parse_from(["cargo-fy-docs", "build"]);
        dispatch(build_cli, &clean_temp).await.unwrap();
        assert!(clean_temp.join("docs/target/index.html").is_file());
        assert!(clean_temp.join("docs/target/fy-docs.css").is_file());
        assert!(clean_temp.join("docs/release").is_dir());

        // 3. html only
        let html_cli = Cli::parse_from(["cargo-fy-docs", "html"]);
        dispatch(html_cli, &clean_temp).await.unwrap();
        assert!(clean_temp.join("docs/target/index.html").is_file());

        // 4. pdf only
        let pdf_cli = Cli::parse_from(["cargo-fy-docs", "pdf"]);
        dispatch(pdf_cli, &clean_temp).await.unwrap();

        let _ = std::fs::remove_dir_all(&temp);
    }
}