web_modules 0.4.0

Pure-Rust, buildless toolchain for ES modules and Web Components
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

//! Build-time toolchain for a consumer crate's `build.rs`.
//!
//! [`build()`] runs the full pipeline: vendor npm packages, compile TypeScript and
//! SCSS, and render an `index.html` and import map into an embeddable output
//! directory; [`Output::optimized`] adds minification and gzip for release builds.
//!
//! Companion helpers, each re-exported at the crate root: `bundle` folds a CommonJS
//! app and its `node_modules/` into one browser ES module, `compress` writes gzip
//! `.gz` sidecars, and `templates` renders Tera templates.

#[cfg(feature = "bundle")]
pub mod bundle;
#[cfg(feature = "compress")]
pub mod compress;
#[cfg(feature = "tera")]
pub mod templates;

// The pipeline itself needs the TypeScript toolchain; its public items (`build()`,
// `Output`, …) are re-exported as `web_modules::build::*` (kept in `pipeline.rs` so the
// `build` facade module isn't named after a child of the same name).
// The pipeline depends only on the always-on core (vendor / import map / static-file copy); each
// source processor (TypeScript, SCSS, Tera, gzip) applies only behind its own feature, so the
// pipeline itself is always compiled.
mod pipeline;
pub use pipeline::*;

// The fluent builder over `build()` / `BuildOptions`, re-exported at the crate root as
// `web_modules::Build` (and `web_modules::build::Build`). Behind the `builder` feature so the bare
// struct API can be used without it.
#[cfg(feature = "builder")]
mod builder;
#[cfg(feature = "builder")]
pub use builder::Build;