2019-05-25 18:50:41 +00:00
|
|
|
use crate::nop_lib::Nop;
|
2022-07-04 15:16:31 +00:00
|
|
|
use clap::{Arg, ArgMatches, Command};
|
2018-09-16 15:44:52 +00:00
|
|
|
use mdbook::book::Book;
|
2018-09-25 11:41:38 +00:00
|
|
|
use mdbook::errors::Error;
|
|
|
|
use mdbook::preprocess::{CmdPreprocessor, Preprocessor, PreprocessorContext};
|
2021-04-26 15:08:24 +00:00
|
|
|
use semver::{Version, VersionReq};
|
2018-09-16 15:23:03 +00:00
|
|
|
use std::io;
|
2018-09-25 11:41:38 +00:00
|
|
|
use std::process;
|
|
|
|
|
2022-07-04 15:16:31 +00:00
|
|
|
pub fn make_app() -> Command {
|
|
|
|
Command::new("nop-preprocessor")
|
2018-09-25 11:41:38 +00:00
|
|
|
.about("A mdbook preprocessor which does precisely nothing")
|
|
|
|
.subcommand(
|
2022-07-04 15:16:31 +00:00
|
|
|
Command::new("supports")
|
2022-01-18 22:17:36 +00:00
|
|
|
.arg(Arg::new("renderer").required(true))
|
2018-12-03 23:11:41 +00:00
|
|
|
.about("Check whether a renderer is supported by this preprocessor"),
|
|
|
|
)
|
2018-09-25 11:41:38 +00:00
|
|
|
}
|
2018-09-16 14:49:52 +00:00
|
|
|
|
|
|
|
fn main() {
|
2018-09-25 11:41:38 +00:00
|
|
|
let matches = make_app().get_matches();
|
|
|
|
|
|
|
|
// Users will want to construct their own preprocessor here
|
|
|
|
let preprocessor = Nop::new();
|
2018-09-16 14:49:52 +00:00
|
|
|
|
|
|
|
if let Some(sub_args) = matches.subcommand_matches("supports") {
|
2018-09-25 11:41:38 +00:00
|
|
|
handle_supports(&preprocessor, sub_args);
|
2019-05-06 18:20:58 +00:00
|
|
|
} else if let Err(e) = handle_preprocessing(&preprocessor) {
|
|
|
|
eprintln!("{}", e);
|
|
|
|
process::exit(1);
|
2018-09-16 14:49:52 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-09-25 11:41:38 +00:00
|
|
|
fn handle_preprocessing(pre: &dyn Preprocessor) -> Result<(), Error> {
|
|
|
|
let (ctx, book) = CmdPreprocessor::parse_input(io::stdin())?;
|
2018-09-16 15:23:03 +00:00
|
|
|
|
2021-04-26 15:08:24 +00:00
|
|
|
let book_version = Version::parse(&ctx.mdbook_version)?;
|
|
|
|
let version_req = VersionReq::parse(mdbook::MDBOOK_VERSION)?;
|
|
|
|
|
2021-08-24 13:04:32 +00:00
|
|
|
if !version_req.matches(&book_version) {
|
2018-09-25 11:41:38 +00:00
|
|
|
eprintln!(
|
|
|
|
"Warning: The {} plugin was built against version {} of mdbook, \
|
|
|
|
but we're being called from version {}",
|
|
|
|
pre.name(),
|
|
|
|
mdbook::MDBOOK_VERSION,
|
|
|
|
ctx.mdbook_version
|
|
|
|
);
|
2018-09-16 15:44:52 +00:00
|
|
|
}
|
2018-09-16 15:28:01 +00:00
|
|
|
|
2018-09-25 11:41:38 +00:00
|
|
|
let processed_book = pre.run(&ctx, book)?;
|
|
|
|
serde_json::to_writer(io::stdout(), &processed_book)?;
|
2018-09-16 15:44:52 +00:00
|
|
|
|
2018-09-25 11:41:38 +00:00
|
|
|
Ok(())
|
2018-09-16 14:49:52 +00:00
|
|
|
}
|
|
|
|
|
2018-09-25 11:41:38 +00:00
|
|
|
fn handle_supports(pre: &dyn Preprocessor, sub_args: &ArgMatches) -> ! {
|
2022-07-04 15:16:31 +00:00
|
|
|
let renderer = sub_args
|
|
|
|
.get_one::<String>("renderer")
|
|
|
|
.expect("Required argument");
|
2021-08-24 13:04:32 +00:00
|
|
|
let supported = pre.supports_renderer(renderer);
|
2018-09-16 15:00:19 +00:00
|
|
|
|
2018-09-16 15:44:52 +00:00
|
|
|
// Signal whether the renderer is supported by exiting with 1 or 0.
|
2018-09-16 15:00:19 +00:00
|
|
|
if supported {
|
|
|
|
process::exit(0);
|
|
|
|
} else {
|
|
|
|
process::exit(1);
|
|
|
|
}
|
2018-09-16 14:49:52 +00:00
|
|
|
}
|
|
|
|
|
2018-09-25 11:41:38 +00:00
|
|
|
/// The actual implementation of the `Nop` preprocessor. This would usually go
|
|
|
|
/// in your main `lib.rs` file.
|
|
|
|
mod nop_lib {
|
|
|
|
use super::*;
|
|
|
|
|
|
|
|
/// A no-op preprocessor.
|
|
|
|
pub struct Nop;
|
|
|
|
|
|
|
|
impl Nop {
|
|
|
|
pub fn new() -> Nop {
|
|
|
|
Nop
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Preprocessor for Nop {
|
|
|
|
fn name(&self) -> &str {
|
|
|
|
"nop-preprocessor"
|
|
|
|
}
|
2018-09-16 14:49:52 +00:00
|
|
|
|
2018-12-03 23:11:41 +00:00
|
|
|
fn run(&self, ctx: &PreprocessorContext, book: Book) -> Result<Book, Error> {
|
2018-09-25 11:41:38 +00:00
|
|
|
// In testing we want to tell the preprocessor to blow up by setting a
|
|
|
|
// particular config value
|
|
|
|
if let Some(nop_cfg) = ctx.config.get_preprocessor(self.name()) {
|
|
|
|
if nop_cfg.contains_key("blow-up") {
|
2020-05-20 21:32:00 +00:00
|
|
|
anyhow::bail!("Boom!!1!");
|
2018-09-25 11:41:38 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// we *are* a no-op preprocessor after all
|
|
|
|
Ok(book)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn supports_renderer(&self, renderer: &str) -> bool {
|
|
|
|
renderer != "not-supported"
|
|
|
|
}
|
|
|
|
}
|
2022-09-24 21:32:41 +00:00
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod test {
|
|
|
|
use super::*;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn nop_preprocessor_run() {
|
|
|
|
let input_json = r##"[
|
|
|
|
{
|
|
|
|
"root": "/path/to/book",
|
|
|
|
"config": {
|
|
|
|
"book": {
|
|
|
|
"authors": ["AUTHOR"],
|
|
|
|
"language": "en",
|
|
|
|
"multilingual": false,
|
|
|
|
"src": "src",
|
|
|
|
"title": "TITLE"
|
|
|
|
},
|
|
|
|
"preprocessor": {
|
|
|
|
"nop": {}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"renderer": "html",
|
|
|
|
"mdbook_version": "0.4.21"
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"sections": [
|
|
|
|
{
|
|
|
|
"Chapter": {
|
|
|
|
"name": "Chapter 1",
|
|
|
|
"content": "# Chapter 1\n",
|
|
|
|
"number": [1],
|
|
|
|
"sub_items": [],
|
|
|
|
"path": "chapter_1.md",
|
|
|
|
"source_path": "chapter_1.md",
|
|
|
|
"parent_names": []
|
|
|
|
}
|
|
|
|
}
|
|
|
|
],
|
|
|
|
"__non_exhaustive": null
|
|
|
|
}
|
|
|
|
]"##;
|
|
|
|
let input_json = input_json.as_bytes();
|
|
|
|
|
|
|
|
let (ctx, book) = mdbook::preprocess::CmdPreprocessor::parse_input(input_json).unwrap();
|
|
|
|
let expected_book = book.clone();
|
|
|
|
let result = Nop::new().run(&ctx, book);
|
|
|
|
assert!(result.is_ok());
|
|
|
|
|
|
|
|
// The nop-preprocessor should not have made any changes to the book content.
|
|
|
|
let actual_book = result.unwrap();
|
|
|
|
assert_eq!(actual_book, expected_book);
|
|
|
|
}
|
|
|
|
}
|
2018-09-16 14:49:52 +00:00
|
|
|
}
|