3e673ce424
This switches to using the tracing crate instead of log. Tracing provides a lot of nice features which we can take advantage of moving forward. This also adjusts the output fairly significantly. This includes: - Switched the environment variable from RUST_LOG to MDBOOK_LOG. - Dropped the timestamp. I experimented with various different time displays, but ultimately decided to omit it for now. I don't think I've ever found it to be useful, and it takes up a very significant amount of space. It could potentially be useful for basic profiling, but I think there are other, better mechanisms for that. We could consider leveraging tracing itself for doing some basic profiling (like using something like tracing-chrome). - Dropped the target unless MDBOOK_LOG is set. The target tends to be pretty noisy, and doesn't really convey much information unless you are debugging or otherwise trying to adjust the log output. - Added color. - Slightly reworked the way the error cause trace is displayed. - Slightly changed the way html5ever filtering is done, as well as add handlebars to the list since they both are very noisy. You can override this now by explicitly listing them as targets. I still expect that mdbook will eventually change how it displays things to the console, possibly switching away from tracing and printing things itself. However, that is a larger project for the future.
113 lines
3.9 KiB
Rust
113 lines
3.9 KiB
Rust
//! Tests for include preprocessor.
|
|
|
|
use crate::prelude::*;
|
|
|
|
// Basic test for #include.
|
|
#[test]
|
|
fn include() {
|
|
BookTest::from_dir("includes/all_includes")
|
|
.check_main_file(
|
|
"book/includes.html",
|
|
str![[r##"
|
|
<h1 id="basic-includes"><a class="header" href="#basic-includes">Basic Includes</a></h1>
|
|
<h2 id="sample"><a class="header" href="#sample">Sample</a></h2>
|
|
<p>This is a sample include.</p>
|
|
"##]],
|
|
)
|
|
.check_main_file(
|
|
"book/relative/includes.html",
|
|
str![[r##"
|
|
<h1 id="relative-includes"><a class="header" href="#relative-includes">Relative Includes</a></h1>
|
|
<h2 id="sample"><a class="header" href="#sample">Sample</a></h2>
|
|
<p>This is a sample include.</p>
|
|
"##]],
|
|
);
|
|
}
|
|
|
|
// Checks for anchored includes.
|
|
#[test]
|
|
fn anchored_include() {
|
|
BookTest::from_dir("includes/all_includes").check_main_file(
|
|
"book/anchors.html",
|
|
str![[r##"
|
|
<h1 id="include-anchors"><a class="header" href="#include-anchors">Include Anchors</a></h1>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>let x = 1;
|
|
<span class="boring">}</span></code></pre></pre>
|
|
"##]],
|
|
);
|
|
}
|
|
|
|
// Checks behavior of recursive include.
|
|
#[test]
|
|
fn recursive_include() {
|
|
BookTest::from_dir("includes/all_includes")
|
|
.run("build", |cmd| {
|
|
cmd.expect_stderr(str![[r#"
|
|
INFO Book building has started
|
|
ERROR Stack depth exceeded in recursive.md. Check for cyclic includes
|
|
INFO Running the html backend
|
|
INFO HTML book written to `[ROOT]/book`
|
|
|
|
"#]]);
|
|
})
|
|
.check_main_file(
|
|
"book/recursive.html",
|
|
str![[r#"
|
|
<p>Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world
|
|
Around the world, around the world</p>
|
|
"#]],
|
|
);
|
|
}
|
|
|
|
// Checks the behavior of `{{#playground}}` include.
|
|
#[test]
|
|
fn playground_include() {
|
|
BookTest::from_dir("includes/all_includes")
|
|
.check_main_file("book/playground.html",
|
|
str![[r##"
|
|
<h1 id="playground-includes"><a class="header" href="#playground-includes">Playground Includes</a></h1>
|
|
<pre><pre class="playground"><code class="language-rust">fn main() {
|
|
println!("Hello World!");
|
|
<span class="boring">
|
|
</span><span class="boring"> // You can even hide lines! :D
|
|
</span><span class="boring"> println!("I am hidden! Expand the code snippet to see me");
|
|
</span>}</code></pre></pre>
|
|
"##]]);
|
|
}
|
|
|
|
// Checks the behavior of `{{#rustdoc_include}}`.
|
|
#[test]
|
|
fn rustdoc_include() {
|
|
BookTest::from_dir("includes/all_includes")
|
|
.check_main_file("book/rustdoc.html",
|
|
str![[r##"
|
|
<h1 id="rustdoc-includes"><a class="header" href="#rustdoc-includes">Rustdoc Includes</a></h1>
|
|
<h2 id="rustdoc-include-adds-the-rest-of-the-file-as-hidden"><a class="header" href="#rustdoc-include-adds-the-rest-of-the-file-as-hidden">Rustdoc include adds the rest of the file as hidden</a></h2>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">fn some_function() {
|
|
</span><span class="boring"> println!("some function");
|
|
</span><span class="boring">}
|
|
</span><span class="boring">
|
|
</span>fn main() {
|
|
some_function();
|
|
}</code></pre></pre>
|
|
<h2 id="rustdoc-include-works-with-anchors-too"><a class="header" href="#rustdoc-include-works-with-anchors-too">Rustdoc include works with anchors too</a></h2>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">fn some_other_function() {
|
|
</span><span class="boring"> println!("unused anchor");
|
|
</span><span class="boring">}
|
|
</span><span class="boring">
|
|
</span>fn main() {
|
|
some_other_function();
|
|
}</code></pre></pre>
|
|
"##]]);
|
|
}
|