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
use std::path::{Path, PathBuf};
use mdbook::renderer::RenderContext;
use toml::Value;
use crate::Result;
/// Configuration for mdbook-angular
#[allow(clippy::struct_excessive_bools)] // this is config, not a state machine
pub struct Config {
/// Whether to enable the experimental background builder
///
/// Enabling this option runs the angular build in a background process,
/// triggering a watch instead of an entire new build whenever mdbook notices
/// a change.
/// This is considerably faster.
///
/// This option requires the [`Config.experimental_builder`] option to be enabled.
/// It only works on builds with the "background" feature enabled, and it only
/// works on platforms rustc considers "unix".
/// This option is no-op for commands that don't watch the book source for
/// changes.
///
/// Default value: `false`
pub background: bool,
/// Whether to use an experimental builder (requires angular ≥ 16.2.0)
///
/// If enabled, all chapters in the book will be built in a single go. If
/// disabled, every chapter is built separately as angular application.
///
/// Default value: `false`
pub experimental_builder: bool,
/// Whether playgrounds are enabled by default
///
/// This can be overridden via `playground` or `no-playground` tag on every
/// individual code block or `{{#angular}}` tag.
///
/// Default value: `true`
pub playgrounds: bool,
/// Path to a tsconfig to use for building, relative to the `book.toml` file
pub tsconfig: Option<PathBuf>,
/// The inline style language the angular compiler should use
///
/// Default value: `"css"`
pub inline_style_language: String,
/// Whether to optimize the angular applications
///
/// This option is ignored if background is active
///
/// Default value: `false`
pub optimize: bool,
pub(crate) book_source_folder: PathBuf,
pub(crate) angular_root_folder: PathBuf,
pub(crate) target_folder: PathBuf,
}
impl Config {
/// Read mdbook-angular [`Config`] from the `book.toml` file inside the given folder.
///
/// # Errors
///
/// This function will return an error if reading the `book.toml` fails.
pub fn read<P: AsRef<Path>>(root: P) -> Result<Self> {
let root = root.as_ref();
let mut cfg = mdbook::Config::from_disk(root.join("book.toml"))?;
cfg.update_from_env();
Ok(Self::from_config(
&cfg,
root,
// Incorrect if there are multiple backends, but... good enough?
root.join(&cfg.build.build_dir),
))
}
/// Create mdbook-angular configuration [`Config`] from the given render context.
pub fn new(ctx: &RenderContext) -> Self {
Self::from_config(&ctx.config, &ctx.root, ctx.destination.clone())
}
fn from_config(config: &mdbook::Config, root: &Path, destination: PathBuf) -> Self {
let experimental_builder = config
.get("output.angular.experimental-builder")
.and_then(Value::as_bool)
.unwrap_or(true);
let background = config
.get("output.angular.background")
.and_then(Value::as_bool)
.unwrap_or(false);
let playgrounds = config
.get("output.angular.playgrounds")
.and_then(Value::as_bool)
.unwrap_or(true);
let tsconfig = config
.get("output.angular.tsconfig")
.and_then(Value::as_str)
.map(|tsconfig| root.join(tsconfig));
let inline_style_language = config
.get("output.angular.inline-style-language")
.and_then(Value::as_str)
.unwrap_or("css")
.to_owned();
let optimize = config
.get("output.angular.optimize")
.and_then(Value::as_bool)
.unwrap_or(false);
let book_source_folder = root.join(&config.book.src);
let angular_root_folder = root.join(
config
.get("output.angular.workdir")
.and_then(Value::as_str)
.unwrap_or("mdbook_angular"),
);
let target_folder = destination;
Config {
background,
experimental_builder,
playgrounds,
tsconfig,
inline_style_language,
optimize,
book_source_folder,
angular_root_folder,
target_folder,
}
}
}