Skip to content

Commit

Permalink
Merge pull request #864 from epage/color
Browse files Browse the repository at this point in the history 
fix(cli): Improve color formatting
  • Loading branch information
@epage
epage authored Oct 27, 2023
2 parents 00220c3 + 0a5b4ab commit 6a7b7d0
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 120 deletions.
16 changes: 3 additions & 13 deletions crates/typos-cli/src/bin/typos-cli/args.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,11 @@ pub enum Format {
}

impl Format {
pub(crate) fn reporter(
self,
stdout_palette: crate::report::Palette,
stderr_palette: crate::report::Palette,
) -> Box<dyn typos_cli::report::Report> {
pub(crate) fn reporter(self) -> Box<dyn typos_cli::report::Report> {
match self {
Format::Silent => Box::new(crate::report::PrintSilent),
Format::Brief => Box::new(crate::report::PrintBrief {
stdout_palette,
stderr_palette,
}),
Format::Long => Box::new(crate::report::PrintLong {
stdout_palette,
stderr_palette,
}),
Format::Brief => Box::new(crate::report::PrintBrief),
Format::Long => Box::new(crate::report::PrintLong),
Format::Json => Box::new(crate::report::PrintJson),
}
}
Expand Down
4 changes: 1 addition & 3 deletions crates/typos-cli/src/bin/typos-cli/main.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -255,9 +255,7 @@ fn run_checks(args: &args::Args) -> proc_exit::ExitResult {
let output_reporter = if args.diff {
Box::new(crate::report::PrintSilent)
} else {
let stdout_palette = report::Palette::colored();
let stderr_palette = report::Palette::colored();
args.format.reporter(stdout_palette, stderr_palette)
args.format.reporter()
};
let status_reporter = report::MessageStatus::new(output_reporter.as_ref());
let reporter: &dyn typos_cli::report::Report = &status_reporter;
Expand Down
153 changes: 50 additions & 103 deletions crates/typos-cli/src/bin/typos-cli/report.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,60 +8,9 @@ use unicode_width::UnicodeWidthStr;

use typos_cli::report::{Context, Message, Report, Typo};

#[derive(Copy, Clone, Debug, Default)]
pub struct Palette {
error: anstyle::Style,
info: anstyle::Style,
strong: anstyle::Style,
}

impl Palette {
pub fn colored() -> Self {
Self {
error: anstyle::AnsiColor::Red.on_default(),
info: anstyle::AnsiColor::Blue.on_default(),
strong: anstyle::Effects::BOLD.into(),
}
}

pub(crate) fn error<D: std::fmt::Display>(self, display: D) -> Styled<D> {
Styled::new(display, self.error)
}

pub(crate) fn info<D: std::fmt::Display>(self, display: D) -> Styled<D> {
Styled::new(display, self.info)
}

pub(crate) fn strong<D: std::fmt::Display>(self, display: D) -> Styled<D> {
Styled::new(display, self.strong)
}
}

#[derive(Debug)]
pub(crate) struct Styled<D> {
display: D,
style: anstyle::Style,
}

impl<D: std::fmt::Display> Styled<D> {
pub(crate) fn new(display: D, style: anstyle::Style) -> Self {
Self { display, style }
}
}

impl<D: std::fmt::Display> std::fmt::Display for Styled<D> {
#[inline]
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
if f.alternate() {
write!(f, "{}", self.style.render())?;
self.display.fmt(f)?;
write!(f, "{}", self.style.render_reset())?;
Ok(())
} else {
self.display.fmt(f)
}
}
}
const ERROR: anstyle::Style = anstyle::AnsiColor::BrightRed.on_default();
const INFO: anstyle::Style = anstyle::AnsiColor::BrightBlue.on_default();
const GOOD: anstyle::Style = anstyle::AnsiColor::BrightGreen.on_default();

pub struct MessageStatus<'r> {
typos_found: atomic::AtomicBool,
Expand Down Expand Up @@ -108,22 +57,21 @@ impl Report for PrintSilent {
}
}

pub struct PrintBrief {
pub stdout_palette: Palette,
pub stderr_palette: Palette,
}
pub struct PrintBrief;

impl Report for PrintBrief {
fn report(&self, msg: Message) -> Result<(), std::io::Error> {
match &msg {
Message::BinaryFile(msg) => {
log::info!("{}", msg);
}
Message::Typo(msg) => print_brief_correction(msg, self.stdout_palette)?,
Message::Typo(msg) => print_brief_correction(msg)?,
Message::FileType(msg) => {
let info = INFO.render();
let reset = anstyle::Reset.render();
writeln!(
stdout().lock(),
"{}:{}",
"{info}{}{reset}: {}",
msg.path.display(),
msg.file_type.unwrap_or("-")
)?;
Expand All @@ -143,22 +91,21 @@ impl Report for PrintBrief {
}
}

pub struct PrintLong {
pub stdout_palette: Palette,
pub stderr_palette: Palette,
}
pub struct PrintLong;

impl Report for PrintLong {
fn report(&self, msg: Message) -> Result<(), std::io::Error> {
match &msg {
Message::BinaryFile(msg) => {
log::info!("{}", msg);
}
Message::Typo(msg) => print_long_correction(msg, self.stdout_palette)?,
Message::Typo(msg) => print_long_correction(msg)?,
Message::FileType(msg) => {
let info = INFO.render();
let reset = anstyle::Reset.render();
writeln!(
stdout().lock(),
"{}:{}",
"{info}{}{reset}: {}",
msg.path.display(),
msg.file_type.unwrap_or("-")
)?;
Expand All @@ -178,7 +125,12 @@ impl Report for PrintLong {
}
}

fn print_brief_correction(msg: &Typo, palette: Palette) -> Result<(), std::io::Error> {
fn print_brief_correction(msg: &Typo) -> Result<(), std::io::Error> {
let error = ERROR.render();
let good = GOOD.render();
let info = INFO.render();
let reset = anstyle::Reset.render();

let start = String::from_utf8_lossy(&msg.buffer[0..msg.byte_offset]);
let column_number =
unicode_segmentation::UnicodeSegmentation::graphemes(start.as_ref(), true).count() + 1;
Expand All @@ -188,34 +140,35 @@ fn print_brief_correction(msg: &Typo, palette: Palette) -> Result<(), std::io::E
let divider = ":";
writeln!(
stdout().lock(),
"{:#}{:#}{:#}: {:#}",
palette.info(context_display(&msg.context)),
palette.info(divider),
palette.info(column_number),
palette.strong(format_args!("`{}` is disallowed:", msg.typo)),
"{info}{}{divider}{column_number}{reset}: `{error}{}{reset}` is disallowed",
context_display(&msg.context),
msg.typo,
)?;
}
typos::Status::Corrections(corrections) => {
let divider = ":";
writeln!(
stdout().lock(),
"{:#}{:#}{:#}: {:#}",
palette.info(context_display(&msg.context)),
palette.info(divider),
palette.info(column_number),
palette.strong(format_args!(
"`{}` -> {}",
msg.typo,
itertools::join(corrections.iter().map(|s| format!("`{}`", s)), ", ")
)),
"{info}{}{divider}{column_number}{reset}: `{error}{}{reset}` -> {}",
context_display(&msg.context),
msg.typo,
itertools::join(
corrections.iter().map(|s| format!("`{good}{}{reset}`", s)),
", "
)
)?;
}
}

Ok(())
}

fn print_long_correction(msg: &Typo, palette: Palette) -> Result<(), std::io::Error> {
fn print_long_correction(msg: &Typo) -> Result<(), std::io::Error> {
let error = ERROR.render();
let good = GOOD.render();
let info = INFO.render();
let reset = anstyle::Reset.render();

let stdout = stdout();
let mut handle = stdout.lock();

Expand All @@ -229,53 +182,47 @@ fn print_long_correction(msg: &Typo, palette: Palette) -> Result<(), std::io::Er
typos::Status::Invalid => {
writeln!(
handle,
"{:#}: {:#}",
palette.error("error"),
palette.strong(format_args!("`{}` is disallowed", msg.typo))
"{error}error{reset}: `{error}{}{reset}` is disallowed",
msg.typo,
)?;
}
typos::Status::Corrections(corrections) => {
writeln!(
handle,
"{:#}: {:#}",
palette.error("error"),
palette.strong(format_args!(
"`{}` should be {}",
msg.typo,
itertools::join(corrections.iter().map(|s| format!("`{}`", s)), ", ")
))
"{error}error{reset}: `{error}{}{reset}` should be {}",
msg.typo,
itertools::join(
corrections.iter().map(|s| format!("`{good}{}{reset}`", s)),
", "
)
)?;
}
}
let divider = ":";
writeln!(
handle,
" --> {:#}{:#}{:#}",
palette.info(context_display(&msg.context)),
palette.info(divider),
palette.info(column_number)
"{info} --> {reset}{}{divider}{column_number}",
context_display(&msg.context),
)?;

if let Some(Context::File(context)) = &msg.context {
let line_num = context.line_num.to_string();
let line_indent: String = itertools::repeat_n(" ", line_num.len()).collect();
let line = line.trim_end();

let visible_column = calculate_visible_column_width(start.as_ref());
let visible_len = calculate_visible_column_width(msg.typo);

let hl_indent: String = itertools::repeat_n(" ", visible_column).collect();
let hl: String = itertools::repeat_n("^", visible_len).collect();

writeln!(handle, "{} |", line_indent)?;
writeln!(handle, "{:#} | {}", palette.info(line_num), line.trim_end())?;
writeln!(handle, "{info}{line_indent} |{reset}")?;
writeln!(handle, "{info}{line_num} |{reset} {line}")?;
writeln!(
handle,
"{} | {}{:#}",
line_indent,
hl_indent,
palette.error(hl)
"{info}{line_indent} |{reset} {hl_indent}{error}{hl}{reset}",
)?;
writeln!(handle, "{} |", line_indent)?;
writeln!(handle, "{info}{line_indent} |{reset}")?;
}

Ok(())
Expand Down
2 changes: 1 addition & 1 deletion crates/typos-cli/tests/cmd/override-default-type.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ stdin = '''
Destory
'''
stdout = """
./key.asc:asc
./key.asc: asc
"""
stderr = ""

0 comments on commit 6a7b7d0

Please sign in to comment.