zola/src/console.rs

131 lines
4.1 KiB
Rust
Raw Normal View History

use std::env;
2019-01-11 19:29:46 +00:00
use std::error::Error as StdError;
use std::io::Write;
use std::time::Instant;
use atty;
use chrono::Duration;
use termcolor::{Color, ColorChoice, ColorSpec, StandardStream, WriteColor};
2017-03-25 06:52:51 +00:00
2019-01-30 19:42:53 +00:00
use errors::Error;
use site::Site;
lazy_static! {
/// Termcolor color choice.
/// We do not rely on ColorChoice::Auto behavior
/// as the check is already performed by has_color.
2018-10-02 14:42:34 +00:00
static ref COLOR_CHOICE: ColorChoice =
if has_color() {
ColorChoice::Always
} else {
ColorChoice::Never
};
}
2017-03-25 06:52:51 +00:00
pub fn info(message: &str) {
colorize(message, ColorSpec::new().set_bold(true));
2017-03-25 06:52:51 +00:00
}
2017-05-08 10:29:37 +00:00
pub fn warn(message: &str) {
colorize(message, ColorSpec::new().set_bold(true).set_fg(Some(Color::Yellow)));
2017-05-08 10:29:37 +00:00
}
2017-03-25 06:52:51 +00:00
pub fn success(message: &str) {
colorize(message, ColorSpec::new().set_bold(true).set_fg(Some(Color::Green)));
2017-03-25 06:52:51 +00:00
}
pub fn error(message: &str) {
colorize(message, ColorSpec::new().set_bold(true).set_fg(Some(Color::Red)));
}
/// Print a colorized message to stdout
fn colorize(message: &str, color: &ColorSpec) {
let mut stdout = StandardStream::stdout(*COLOR_CHOICE);
stdout.set_color(color).unwrap();
write!(&mut stdout, "{}", message).unwrap();
2018-11-02 00:59:02 +00:00
stdout.set_color(&ColorSpec::new()).unwrap();
writeln!(&mut stdout).unwrap();
2017-03-25 06:52:51 +00:00
}
2019-07-12 21:09:05 +00:00
/// Display in the console the number of pages/sections in the site, and number of images to process
pub fn notify_site_size(site: &Site) {
2019-01-27 17:57:07 +00:00
let library = site.library.read().unwrap();
println!(
2018-02-02 20:35:04 +00:00
"-> Creating {} pages ({} orphan), {} sections, and processing {} images",
2019-01-27 17:57:07 +00:00
library.pages().len(),
site.get_number_orphan_pages(),
library.sections().len() - 1, // -1 since we do not count the index as a section there
2018-02-02 20:35:04 +00:00
site.num_img_ops(),
);
}
2019-07-12 21:09:05 +00:00
/// Display in the console only the number of pages/sections in the site
2019-07-12 21:43:07 +00:00
pub fn check_site_summary(site: &Site) {
2019-07-12 21:09:05 +00:00
let library = site.library.read().unwrap();
2019-07-12 21:43:07 +00:00
let orphans = library.get_all_orphan_pages();
2019-07-12 21:09:05 +00:00
println!(
2019-07-12 21:43:07 +00:00
"-> Site content: {} pages ({} orphan), {} sections",
2019-07-12 21:09:05 +00:00
library.pages().len(),
2019-07-12 21:43:07 +00:00
orphans.len(),
2019-07-12 21:09:05 +00:00
library.sections().len() - 1, // -1 since we do not count the index as a section there
);
2019-07-12 21:43:07 +00:00
for orphan in orphans {
warn(&format!("Orphan page found: {}", orphan.path));
}
2019-07-12 21:09:05 +00:00
}
/// Display a warning in the console if there are ignored pages in the site
pub fn warn_about_ignored_pages(site: &Site) {
2019-01-27 17:57:07 +00:00
let library = site.library.read().unwrap();
let ignored_pages: Vec<_> = library
2018-10-02 14:42:34 +00:00
.sections_values()
.iter()
.flat_map(|s| s.ignored_pages.iter().map(|k| library.get_page_by_key(*k).file.path.clone()))
2017-05-16 04:37:00 +00:00
.collect();
if !ignored_pages.is_empty() {
warn(&format!(
2018-07-31 13:39:10 +00:00
"{} page(s) ignored (missing date or weight in a sorted section):",
ignored_pages.len()
));
2017-05-16 04:37:00 +00:00
for path in ignored_pages {
warn(&format!("- {}", path.display()));
}
}
}
/// Print the time elapsed rounded to 1 decimal
pub fn report_elapsed_time(instant: Instant) {
let duration_ms = Duration::from_std(instant.elapsed()).unwrap().num_milliseconds() as f64;
if duration_ms < 1000.0 {
success(&format!("Done in {}ms.\n", duration_ms));
} else {
let duration_sec = duration_ms / 1000.0;
success(&format!("Done in {:.1}s.\n", ((duration_sec * 10.0).round() / 10.0)));
}
}
/// Display an error message and the actual error(s)
2019-01-30 19:42:53 +00:00
pub fn unravel_errors(message: &str, error: &Error) {
2017-05-22 11:58:28 +00:00
if !message.is_empty() {
self::error(message);
2017-05-20 15:00:41 +00:00
}
self::error(&format!("Error: {}", error));
2019-01-11 19:29:46 +00:00
let mut cause = error.source();
while let Some(e) = cause {
2017-05-20 15:00:41 +00:00
self::error(&format!("Reason: {}", e));
2019-01-11 19:29:46 +00:00
cause = e.source();
2017-05-20 15:00:41 +00:00
}
}
/// Check whether to output colors
fn has_color() -> bool {
2018-10-31 07:18:57 +00:00
let use_colors = env::var("CLICOLOR").unwrap_or_else(|_| "1".to_string()) != "0"
&& env::var("NO_COLOR").is_err();
let force_colors = env::var("CLICOLOR_FORCE").unwrap_or_else(|_| "0".to_string()) != "0";
force_colors || use_colors && atty::is(atty::Stream::Stdout)
}