rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-01-01 22:19:21 +02:00
Code Issues Releases Activity

mdbook-course: Make printing summary optional (#1562)

Browse Source 
There is now a new “verbose” setting which can be used to print the
summary when desired.
This commit is contained in:
Martin Geisler 2023-12-06 18:57:18 +01:00 committed by GitHub
parent 91cb5b2048
commit 97b18e8538
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
book.toml
View File

@ -20,6 +20,8 @@ after = ["gettext"]
class = "bob"
[preprocessor.course]
verbose = false # Report timing information.
# Enable this preprocessor to overlay a large red rectangle on the
# pages. This will show you an estimate of what the course
# participants can see during the presentation.

88
mdbook-course/src/main.rs
View File

@ -18,7 +18,7 @@ mod markdown;
mod replacements;
mod timing_info;
use crate::course::Courses;
use crate::course::{Course, Courses};
use crate::markdown::duration;
use clap::{Arg, Command};
use mdbook::book::BookItem;
@ -44,10 +44,54 @@ fn main() {
}
}
fn preprocess() -> anyhow::Result<()> {
let (_, book) = CmdPreprocessor::parse_input(stdin())?;
fn timediff(actual: u64, target: u64) -> String {
if actual > target {
format!(
"{}: {} OVER TARGET {}",
duration(actual),
duration(actual - target),
duration(target)
)
} else if actual < target {
format!(
"{}: {} shorter than target {}",
duration(actual),
duration(target - actual),
duration(target)
)
} else {
format!("{}: right on time", duration(actual))
}
}
fn print_summary(fundamentals: &Course) {
eprintln!(
"Fundamentals: {}",
timediff(fundamentals.minutes(), 8 * 3 * 60)
);
eprintln!("Sessions:");
for session in fundamentals {
eprintln!(
" {}: {}",
session.name,
timediff(session.minutes(), 3 * 60)
);
for segment in session {
eprintln!(" {}: {}", segment.name, duration(segment.minutes()));
}
}
}
fn preprocess() -> anyhow::Result<()> {
let (ctx, book) = CmdPreprocessor::parse_input(stdin())?;
let (courses, mut book) = Courses::extract_structure(book)?;
let verbose = ctx
.config
.get_preprocessor("course")
.and_then(|t| t.get("verbose"))
.and_then(|v| v.as_bool())
.unwrap_or_default();
book.for_each_mut(|chapter| {
if let BookItem::Chapter(chapter) = chapter {
@ -67,44 +111,12 @@ fn preprocess() -> anyhow::Result<()> {
}
});
let timediff = |actual, target| {
if actual > target {
format!(
"{}: {} OVER TARGET {}",
duration(actual),
duration(actual - target),
duration(target)
)
} else if actual < target {
format!(
"{}: {} shorter than target {}",
duration(actual),
duration(target - actual),
duration(target)
)
} else {
format!("{}: right on time", duration(actual))
}
};
// Print a summary of times for the "Fundamentals" course.
// Translations with a POT-Creation-Date before 2023-11-29 (when
// we merged #1073) will have no frontmatter.
if let Some(fundamentals) = courses.find_course("Fundamentals") {
eprintln!(
"Fundamentals: {}",
timediff(fundamentals.minutes(), 8 * 3 * 60)
);
eprintln!("Sessions:");
for session in fundamentals {
eprintln!(
" {}: {}",
session.name,
timediff(session.minutes(), 3 * 60)
);
for segment in session {
eprintln!(" {}: {}", segment.name, duration(segment.minutes()));
}
if verbose {
if let Some(fundamentals) = courses.find_course("Fundamentals") {
print_summary(fundamentals);
}
}