bundla 0.8.0

Bundle HTML, CSS, and JS/TS: prod build with minification and hashed filenames by default, dev build with sourcemaps, composable watch and serve
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
use std::net::IpAddr;
use std::path::{Path, PathBuf};
use std::process::exit;

use clap::Parser;
use tokio::sync::broadcast::{self, Sender, error::RecvError};

use bundla::{
    BuildCause, BuildOptions, Minify, ReloadType, Server, ServerConfig, WatchLog, build, serve,
    watch, watch_serve,
};

#[derive(Parser)]
#[command(
    about = "bundle src into dist; -d dev build, -w watch, -s serve — all combinable",
    version
)]
struct Args {
    /// Source directory
    #[arg(long, default_value = "src", value_name = "DIR")]
    src: PathBuf,

    /// Output directory (default: dist/, or dev/ with --dev)
    #[arg(long, value_name = "DIR")]
    dist: Option<PathBuf>,

    /// URL prefix where the output is served (e.g. `/app`; must start with `/`)
    /// Root-relative references starting with this base
    /// are bundled and rewritten with the prefix
    #[arg(long, value_parser = base_parse, value_name = "PREFIX")]
    base: Option<String>,

    /// Dev build: unminified with sourcemaps (default output: dev/)
    #[arg(short, long)]
    dev: bool,

    /// Comma-separated output targets to minify: css, js, html, all, or none
    /// (prod default: all; --dev default: none)
    #[arg(long, value_name = "TARGETS")]
    minify: Option<Minify>,

    /// Watch `src` and build on every change
    #[arg(short, long)]
    watch: bool,

    /// File name suffixes to watch, comma-separated, e.g. `html` or `one-file.html`
    /// (default: all files; requires --watch)
    #[arg(long, value_name = "SUFFIXES", requires = "watch")]
    filter: Vec<String>,

    /// Serve the output directory, built once first (live reload with --watch)
    #[arg(short, long)]
    serve: bool,

    /// Server port (default: random free port)
    #[arg(
        short,
        long,
        default_value = "0",
        hide_default_value = true,
        requires = "serve"
    )]
    port: u16,

    /// Server IP address
    #[arg(short, long, default_value = "127.0.0.1", requires = "serve")]
    ip: IpAddr,

    /// Open the page in the browser on start
    #[arg(short, long, requires = "serve")]
    open: bool,

    /// File served by default
    #[arg(long, default_value = "index.html", requires = "serve")]
    index: String,

    /// Additional HTTP header on every response (repeatable)
    #[arg(long = "header", value_name = "NAME: VALUE", requires = "serve")]
    headers: Vec<String>,
}

#[tokio::main]
async fn main() {
    let args = Args::parse();

    if let Err(err) = run(&args).await {
        eprintln!("{err}");
        exit(1);
    }
}

// `--dev` selects the build profile
// `--watch` and `--serve` select the continuations after the build
async fn run(args: &Args) -> Result<(), String> {
    let dist = output_dir(args);
    let options = options_build(args);

    // clap only collects; `webadev::watch` trims, lowercases, splits, and validates
    let filter: Vec<&str> = args.filter.iter().map(String::as_str).collect();

    match (args.watch, args.serve) {
        // Build once, then exit
        (false, false) => build_once(&args.src, &dist, &options).await,
        // Build on every change, without serving
        (true, false) => {
            let tx_log = watch_log_channel();
            let watcher = watch(&args.src, &dist, &options, tx_log, &filter).await?;
            println!(
                "watching {}, rebuilding into {}",
                args.src.display(),
                dist.display()
            );

            watcher.run().await
        }
        // Build once, then serve the output
        (false, true) => {
            build_once(&args.src, &dist, &options).await?;
            let server = serve(&server_config_build(args, dist)).await?;

            start(server, args.open).await
        }
        // Build on every change, served with live reload
        (true, true) => {
            let tx_log = watch_log_channel();
            let server = watch_serve(
                &args.src,
                &server_config_build(args, dist.clone()),
                &options,
                tx_log,
                &filter,
            )
            .await?;

            start(server, args.open).await
        }
    }
}

// `--minify` overrides the profile's target set; the other profile fields
// (sourcemaps, hashed filenames, output dir) stay tied to `--dev`
fn options_build(args: &Args) -> BuildOptions {
    let profile = if args.dev {
        BuildOptions::DEV
    } else {
        BuildOptions::PROD
    };

    BuildOptions {
        base: args.base.clone(),
        minify: args.minify.unwrap_or(profile.minify),
        ..profile
    }
}

// Build once and report the result
async fn build_once(src: &Path, dist: &Path, options: &BuildOptions) -> Result<(), String> {
    let warnings = build(src, dist, options).await?;
    warnings_print(&warnings);
    println!("bundled {}", dist.display());
    Ok(())
}

// Log channel with a printer task attached
fn watch_log_channel() -> Sender<WatchLog> {
    let (tx_log, mut rx_log) = broadcast::channel::<WatchLog>(100);

    tokio::spawn(async move {
        loop {
            match rx_log.recv().await {
                Ok(log) => watch_log_print(&log),
                // A blocked stdout can make this task lag. That is not fatal:
                // warn, emit a conservative page reload, and keep printing.
                Err(RecvError::Lagged(_)) => {
                    eprintln!("warning: watch log lagged; some messages dropped");
                    // A dropped line may have been a reload instruction.
                    println!("built {}", ReloadType::Page.as_str());
                }
                Err(RecvError::Closed) => break,
            }
        }
    });

    tx_log
}

fn server_config_build(args: &Args, dist: PathBuf) -> ServerConfig {
    ServerConfig {
        dir: dist,
        ip: args.ip,
        port: args.port,
        headers: args.headers.clone(),
        index: args.index.clone(),
        base: args.base.clone().unwrap_or_default(),
    }
}

// The output dir follows the build profile:
// - prod build (default): `dist/`,
// - dev build (--dev): `dev/`.
// `--dist` option overrides both.
fn output_dir(args: &Args) -> PathBuf {
    if let Some(dist) = &args.dist {
        return dist.clone();
    }

    if args.dev {
        PathBuf::from("dev")
    } else {
        PathBuf::from("dist")
    }
}

// `--base` must be a non-empty, root-relative path.
// webadev normalizes it: trailing `/` is stripped, `/` becomes the root,
// and invalid segments/characters are rejected.
fn base_parse(value: &str) -> Result<String, String> {
    let value = value.trim();
    if value.is_empty() {
        return Err("must not be empty".into());
    }

    webadev::base_normalize(value)
}

async fn start(server: Server, open: bool) -> Result<(), String> {
    println!("serving {}", server.url);

    if open && let Err(err) = open::that(&server.url) {
        eprintln!("failed to open browser: {err}");
    }

    server.run().await
}

fn warnings_print(warnings: &[String]) {
    for warning in warnings {
        eprintln!("warning: {warning}");
    }
}

fn watch_log_print(log: &WatchLog) {
    match log {
        WatchLog::Built {
            cause,
            reload_type,
            paths,
        } => {
            let cwd = std::env::current_dir().unwrap_or_default();
            let files = paths
                .iter()
                .map(|path| {
                    path.strip_prefix(&cwd)
                        .unwrap_or(path)
                        .display()
                        .to_string()
                })
                .collect::<Vec<_>>()
                .join(", ");

            match cause {
                BuildCause::Startup => println!("built {}: startup", reload_type.as_str()),
                BuildCause::Lagged => println!("built {}", reload_type.as_str()),
                BuildCause::Change if files.is_empty() => {
                    println!("built {}", reload_type.as_str())
                }
                BuildCause::Change => println!("built {}: {files}", reload_type.as_str()),
            }
        }
        WatchLog::Warn(warning) => eprintln!("warning: {warning}"),
        WatchLog::Error(err) => eprintln!("error: {err}"),
    }
}

#[cfg(test)]
mod tests {
    use std::net::{IpAddr, Ipv4Addr};

    use super::*;

    fn args(
        dev: bool,
        watch: bool,
        serve: bool,
        dist: Option<PathBuf>,
        headers: Vec<String>,
    ) -> Args {
        Args {
            src: PathBuf::from("src"),
            dist,
            base: None,
            dev,
            minify: None,
            watch,
            filter: Vec::new(),
            serve,
            port: 8080,
            ip: IpAddr::V4(Ipv4Addr::LOCALHOST),
            open: false,
            index: "index.html".to_string(),
            headers,
        }
    }

    #[test]
    fn bare_parses_as_prod_build() {
        let parsed = Args::try_parse_from(["bundla"]).unwrap();
        assert!(!parsed.dev && !parsed.watch && !parsed.serve);
    }

    #[test]
    fn flags_parse_shorts() {
        let parsed = Args::try_parse_from(["bundla", "-dws"]).unwrap();
        assert!(parsed.dev && parsed.watch && parsed.serve);

        let parsed = Args::try_parse_from(["bundla", "-dw"]).unwrap();
        assert!(parsed.dev && parsed.watch && !parsed.serve);

        let parsed = Args::try_parse_from(["bundla", "-w"]).unwrap();
        assert!(!parsed.dev && parsed.watch && !parsed.serve);

        let parsed = Args::try_parse_from(["bundla", "-s"]).unwrap();
        assert!(!parsed.dev && !parsed.watch && parsed.serve);
    }

    #[test]
    fn flags_parse_longs() {
        let parsed = Args::try_parse_from(["bundla", "--dev", "--watch", "--serve"]).unwrap();
        assert!(parsed.dev && parsed.watch && parsed.serve);
    }

    #[test]
    fn minify_parses_targets() {
        let parsed = Args::try_parse_from(["bundla", "--minify", "css,js"]).unwrap();
        assert_eq!(parsed.minify, Some(Minify::CSS | Minify::JS));

        let parsed = Args::try_parse_from(["bundla", "--minify=all"]).unwrap();
        assert_eq!(parsed.minify, Some(Minify::ALL));

        let parsed = Args::try_parse_from(["bundla", "--minify", "none"]).unwrap();
        assert_eq!(parsed.minify, Some(Minify::NONE));

        let parsed = Args::try_parse_from(["bundla", "--minify", " JS , css "]).unwrap();
        assert_eq!(parsed.minify, Some(Minify::CSS | Minify::JS));
    }

    #[test]
    fn minify_rejects_invalid_targets() {
        for value in ["", "htlm", "none,js", "all,css", "css,,js"] {
            let err = Args::try_parse_from(["bundla", "--minify", value])
                .err()
                .expect("expected an invalid minify target to be rejected");
            assert_eq!(
                err.kind(),
                clap::error::ErrorKind::ValueValidation,
                "value: {value:?}"
            );
        }
    }

    #[test]
    fn filter_is_collected_raw() {
        // clap only collects; `webadev::watch` trims, lowercases, splits, and validates
        let parsed = Args::try_parse_from(["bundla", "-w", "--filter", "html,css"]).unwrap();
        assert_eq!(parsed.filter, ["html,css"]);

        let parsed = Args::try_parse_from(["bundla", "-w", "--filter", " .HTML , js "]).unwrap();
        assert_eq!(parsed.filter, [" .HTML , js "]);

        // an empty value is kept here and dropped by `watch` => watch all
        let parsed = Args::try_parse_from(["bundla", "-w", "--filter", ""]).unwrap();
        assert_eq!(parsed.filter, [""]);
    }

    #[test]
    fn filter_requires_watch() {
        let err = Args::try_parse_from(["bundla", "--filter", "html"])
            .err()
            .expect("expected --filter without --watch to be rejected");
        assert_eq!(err.kind(), clap::error::ErrorKind::MissingRequiredArgument);
    }

    #[test]
    fn base_parses_root_relative() {
        let parsed = Args::try_parse_from(["bundla", "--base", "/app"]).unwrap();
        assert_eq!(parsed.base.as_deref(), Some("/app"));

        // the site root is a valid base, normalized to the empty prefix
        let parsed = Args::try_parse_from(["bundla", "--base", "/"]).unwrap();
        assert_eq!(parsed.base.as_deref(), Some(""));
    }

    #[test]
    fn base_normalizes_values() {
        for (value, expected) in [("/app/", "/app"), (" /app/ ", "/app"), ("/a/b", "/a/b")] {
            let parsed = Args::try_parse_from(["bundla", "--base", value]).unwrap();
            assert_eq!(parsed.base.as_deref(), Some(expected), "value: {value:?}");
        }
    }

    #[test]
    fn base_without_serve_parses() {
        let parsed = Args::try_parse_from(["bundla", "--base", "/app"]).unwrap();
        assert!(!parsed.serve);
    }

    #[test]
    fn base_rejects_relative_or_empty_values() {
        for value in ["app", "app/", "./app", "", " "] {
            let err = Args::try_parse_from(["bundla", "--base", value])
                .err()
                .expect("expected a relative or empty base to be rejected");
            assert_eq!(err.kind(), clap::error::ErrorKind::ValueValidation);
        }
    }

    #[test]
    fn base_rejects_invalid_values() {
        for value in [
            "//app",
            "/app//x",
            "/app/../x",
            "/app/./x",
            "/app/*",
            "/a b",
            "/a%20b",
        ] {
            let err = Args::try_parse_from(["bundla", "--base", value])
                .err()
                .expect("expected an invalid base to be rejected");
            assert_eq!(err.kind(), clap::error::ErrorKind::ValueValidation);
        }
    }

    // The old --watch × --serve conflict is gone: the combo is the
    // watch-and-serve mode
    #[test]
    fn watch_and_serve_combine() {
        let parsed = Args::try_parse_from(["bundla", "--watch", "--serve"]).unwrap();
        assert!(parsed.watch && parsed.serve);
    }

    // `requires` only fires on explicit presence: the --port/--ip/--index
    // defaults must not force --serve on everyone
    #[test]
    fn port_defaults_to_random() {
        let parsed = Args::try_parse_from(["bundla"]).unwrap();
        assert_eq!(parsed.port, 0);
        assert_eq!(parsed.index, "index.html");
    }

    #[test]
    fn port_accepts_explicit_value() {
        let parsed = Args::try_parse_from(["bundla", "-s", "--port", "9000"]).unwrap();
        assert_eq!(parsed.port, 9000);
    }

    #[test]
    fn server_flags_require_serve() {
        for flag in [
            vec!["--open"],
            vec!["--header", "X: Y"],
            vec!["--port", "9000"],
            vec!["--ip", "0.0.0.0"],
            vec!["--index", "home.html"],
        ] {
            let mut argv = vec!["bundla"];
            argv.extend(&flag);

            let err = Args::try_parse_from(argv)
                .err()
                .expect("expected a server flag without --serve to be rejected");
            assert_eq!(
                err.kind(),
                clap::error::ErrorKind::MissingRequiredArgument,
                "flag: {flag:?}"
            );
        }
    }

    #[test]
    fn output_dir_explicit_overrides() {
        let prod = args(false, false, false, Some(PathBuf::from("custom")), vec![]);
        assert_eq!(output_dir(&prod), PathBuf::from("custom"));

        let dev = args(true, true, true, Some(PathBuf::from("custom")), vec![]);
        assert_eq!(output_dir(&dev), PathBuf::from("custom"));
    }

    #[test]
    fn output_dir_follows_profile() {
        let prod = args(false, false, false, None, vec![]);
        assert_eq!(output_dir(&prod), PathBuf::from("dist"));

        let dev = args(true, false, false, None, vec![]);
        assert_eq!(output_dir(&dev), PathBuf::from("dev"));
    }

    #[test]
    fn build_options_default_minify_follows_profile() {
        let prod = options_build(&args(false, false, false, None, vec![]));
        assert_eq!(prod.minify, Minify::ALL);

        let dev = options_build(&args(true, false, false, None, vec![]));
        assert_eq!(dev.minify, Minify::NONE);
    }

    #[test]
    fn build_options_minify_overrides_profile() {
        let mut parsed = args(false, false, false, None, vec![]);
        parsed.minify = Some(Minify::CSS | Minify::JS);
        assert_eq!(options_build(&parsed).minify, Minify::CSS | Minify::JS);

        // `--minify` is independent of `--dev`: only the target set changes
        let mut parsed = args(true, false, false, None, vec![]);
        parsed.minify = Some(Minify::HTML);
        let options = options_build(&parsed);
        assert_eq!(options.minify, Minify::HTML);
        assert!(options.sourcemap);
        assert!(!options.hash);
    }

    #[test]
    fn output_dir_ignores_watch_and_serve() {
        let watch = args(false, true, false, None, vec![]);
        assert_eq!(output_dir(&watch), PathBuf::from("dist"));

        let watch_serve = args(false, true, true, None, vec![]);
        assert_eq!(output_dir(&watch_serve), PathBuf::from("dist"));

        let dev_watch_serve = args(true, true, true, None, vec![]);
        assert_eq!(output_dir(&dev_watch_serve), PathBuf::from("dev"));
    }

    #[test]
    fn server_config_build_maps_fields() {
        let parsed = args(
            false,
            false,
            true,
            Some(PathBuf::from("out")),
            vec!["X: Y".into()],
        );
        let config = server_config_build(&parsed, PathBuf::from("final"));

        assert_eq!(config.dir, PathBuf::from("final"));
        assert_eq!(config.ip, parsed.ip);
        assert_eq!(config.port, 8080);
        assert_eq!(config.headers, vec!["X: Y"]);
        assert_eq!(config.index, "index.html");
        assert_eq!(config.base, "");
    }

    #[test]
    fn server_config_build_maps_base() {
        let mut parsed = args(false, false, true, None, vec![]);
        parsed.base = Some("/app".into());

        let config = server_config_build(&parsed, PathBuf::from("dist"));

        assert_eq!(config.base, "/app");
    }
}