actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Revert "Add support for Rust edition 2018 in playpens (#1086)" (#1093) 

This reverts commit a7b3aa0444.
This commit is contained in:
Dylan DPC 2019-11-11 13:24:13 +01:00 committed by GitHub
parent a7b3aa0444
commit 1f505c2b2e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 22 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
book-example/book.toml
View File

@ -10,7 +10,6 @@ mathjax-support = true
[output.html.playpen]
editable = true
line-numbers = true
edition = "2018"
[output.html.search]
limit-results = 20

1
book-example/src/format/config.md
View File

@ -193,7 +193,6 @@ Available configuration options for the `[output.html.playpen]` table:
- **copy-js:** Copy JavaScript files for the editor to the output directory.
Defaults to `true`.
- **line-numbers** Display line numbers on editable sections of code. Requires both `editable` and `copy-js` to be `true`. Defaults to `false`.
- **edition**: Rust edition to use by default for the code snippets. Defaults to `2015`.
[Ace]: https://ace.c9.io/

18
src/book/mod.rs
View File

@ -27,7 +27,7 @@ use crate::preprocess::{
use crate::renderer::{CmdRenderer, HtmlHandlebars, MarkdownRenderer, RenderContext, Renderer};
use crate::utils;
use crate::config::{Config, RustEdition};
use crate::config::Config;
/// The object used to manage and build a book.
pub struct MDBook {
@ -262,17 +262,11 @@ impl MDBook {
let mut tmpf = utils::fs::create_file(&path)?;
tmpf.write_all(ch.content.as_bytes())?;
let mut cmd = Command::new("rustdoc");
cmd.arg(&path).arg("--test").args(&library_args);
if let Some(html_cfg) = self.config.html_config() {
if html_cfg.playpen.edition == RustEdition::E2018 {
cmd.args(&["--edition", "2018"]);
}
}
let output = cmd.output()?;
let output = Command::new("rustdoc")
.arg(&path)
.arg("--test")
.args(&library_args)
.output()?;
if !output.status.success() {
bail!(ErrorKind::Subprocess(

60
src/config.rs
View File

@ -513,8 +513,6 @@ pub struct Playpen {
pub copy_js: bool,
/// Display line numbers on playpen snippets. Default: `false`.
pub line_numbers: bool,
/// Rust edition to use for the code. Default: `2015`.
pub edition: RustEdition,
}
impl Default for Playpen {
@ -524,66 +522,10 @@ impl Default for Playpen {
copyable: true,
copy_js: true,
line_numbers: false,
edition: RustEdition::E2015,
}
}
}
#[derive(Debug, Clone, PartialEq)]
/// The edition of Rust used in a playpen code snippet
pub enum RustEdition {
/// The 2018 edition of Rust
E2018,
/// The 2015 edition of Rust
E2015,
}
impl Default for RustEdition {
fn default() -> Self {
RustEdition::E2015
}
}
impl Serialize for RustEdition {
fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
where
S: Serializer,
{
match self {
RustEdition::E2015 => serializer.serialize_str("2015"),
RustEdition::E2018 => serializer.serialize_str("2018"),
}
}
}
impl<'de> Deserialize<'de> for RustEdition {
fn deserialize<D>(de: D) -> std::result::Result<Self, D::Error>
where
D: Deserializer<'de>,
{
use serde::de::Error;
let raw = Value::deserialize(de)?;
let edition = match raw {
Value::String(s) => s,
_ => {
return Err(D::Error::custom("Rust edition should be a string"));
}
};
let edition = match edition.as_str() {
"2018" => RustEdition::E2018,
"2015" => RustEdition::E2015,
_ => {
return Err(D::Error::custom("Unknown Rust edition"));
}
};
Ok(edition)
}
}
/// Configuration of the search functionality of the HTML renderer.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(default, rename_all = "kebab-case")]
@ -688,7 +630,6 @@ mod tests {
[output.html.playpen]
editable = true
editor = "ace"
edition = "2018"
[preprocessor.first]
@ -717,7 +658,6 @@ mod tests {
copyable: true,
copy_js: true,
line_numbers: false,
edition: RustEdition::E2018,
};
let html_should_be = HtmlConfig {
curly_quotes: true,

31
src/renderer/html_handlebars/hbs_renderer.rs
View File

@ -1,5 +1,5 @@
use crate::book::{Book, BookItem};
use crate::config::{Config, HtmlConfig, Playpen, RustEdition};
use crate::config::{Config, HtmlConfig, Playpen};
use crate::errors::*;
use crate::renderer::html_handlebars::helpers;
use crate::renderer::{RenderContext, Renderer};
@ -608,27 +608,14 @@ fn add_playpen_pre(html: &str, playpen_config: &Playpen) -> String {
let classes = &caps[2];
let code = &caps[3];
if (classes.contains("language-rust")
&& !classes.contains("ignore")
&& !classes.contains("noplaypen"))
|| classes.contains("mdbook-runnable")
{
let mut classes = classes.to_string();
match playpen_config.edition {
RustEdition::E2018 => classes += " edition2018",
_ => (),
}
// wrap the contents in an external pre block
format!(
"<pre class=\"playpen\"><code class=\"{}\">{}</code></pre>",
classes,
{
let content: Cow<'_, str> = if playpen_config.editable
&& classes.contains("editable")
|| text.contains("fn main")
|| text.contains("quick_main!")
if classes.contains("language-rust") {
if (!classes.contains("ignore") && !classes.contains("noplaypen"))
|| classes.contains("mdbook-runnable")
{
// wrap the contents in an external pre block
format!(
"<pre class=\"playpen\"><code class=\"{}\">{}</code></pre>",
classes,
{
let content: Cow<'_, str> = if playpen_config.editable
&& classes.contains("editable")

15
tests/rendered_output.rs
View File

@ -490,15 +490,12 @@ fn markdown_options() {
"<td>bim</td>",
],
);
assert_contains_strings(
&path,
&[
r##"<sup class="footnote-reference"><a href="#1">1</a></sup>"##,
r##"<sup class="footnote-reference"><a href="#word">2</a></sup>"##,
r##"<div class="footnote-definition" id="1"><sup class="footnote-definition-label">1</sup>"##,
r##"<div class="footnote-definition" id="word"><sup class="footnote-definition-label">2</sup>"##,
],
);
assert_contains_strings(&path, &[
r##"<sup class="footnote-reference"><a href="#1">1</a></sup>"##,
r##"<sup class="footnote-reference"><a href="#word">2</a></sup>"##,
r##"<div class="footnote-definition" id="1"><sup class="footnote-definition-label">1</sup>"##,
r##"<div class="footnote-definition" id="word"><sup class="footnote-definition-label">2</sup>"##,
]);
assert_contains_strings(&path, &["<del>strikethrough example</del>"]);
assert_contains_strings(
&path,