actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2025-02-13 08:40:29 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(cli): Make the correction stand out more

Browse source 
This does deviate from rustc for `long` format but it seems worth it.

I did move backticks to be out of the coloring so the `error:` was more
distinct from the typo in `long` format.
This commit is contained in:
Ed Page 2023-10-27 09:28:11 -05:00
parent 1ca321659d
commit 0a5b4abbd5
1 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
crates/typos-cli/src/bin/typos-cli/report.rs
View file

@ -10,7 +10,7 @@ use typos_cli::report::{Context, Message, Report, Typo};
const ERROR: anstyle::Style = anstyle::AnsiColor::BrightRed.on_default(); const ERROR: anstyle::Style = anstyle::AnsiColor::BrightRed.on_default();
const INFO: anstyle::Style = anstyle::AnsiColor::BrightBlue.on_default(); const INFO: anstyle::Style = anstyle::AnsiColor::BrightBlue.on_default();
const STRONG: anstyle::Style = anstyle::Style::new().effects(anstyle::Effects::BOLD); const GOOD: anstyle::Style = anstyle::AnsiColor::BrightGreen.on_default();
pub struct MessageStatus<'r> { pub struct MessageStatus<'r> {
typos_found: atomic::AtomicBool, typos_found: atomic::AtomicBool,
@ -126,8 +126,9 @@ impl Report for PrintLong {
} }
fn print_brief_correction(msg: &Typo) -> 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 info = INFO.render();
let strong = STRONG.render();
let reset = anstyle::Reset.render(); let reset = anstyle::Reset.render();
let start = String::from_utf8_lossy(&msg.buffer[0..msg.byte_offset]); let start = String::from_utf8_lossy(&msg.buffer[0..msg.byte_offset]);
@ -139,7 +140,7 @@ fn print_brief_correction(msg: &Typo) -> Result<(), std::io::Error> {
let divider = ":"; let divider = ":";
writeln!( writeln!(
stdout().lock(), stdout().lock(),
"{info}{}{divider}{column_number}{reset}: {strong}`{}` is disallowed{reset}", "{info}{}{divider}{column_number}{reset}: `{error}{}{reset}` is disallowed",
context_display(&msg.context), context_display(&msg.context),
msg.typo, msg.typo,
)?; )?;
@ -148,10 +149,13 @@ fn print_brief_correction(msg: &Typo) -> Result<(), std::io::Error> {
let divider = ":"; let divider = ":";
writeln!( writeln!(
stdout().lock(), stdout().lock(),
"{info}{}{divider}{column_number}{reset}: {strong}`{}` -> {}{reset}", "{info}{}{divider}{column_number}{reset}: `{error}{}{reset}` -> {}",
context_display(&msg.context), context_display(&msg.context),
msg.typo, msg.typo,
itertools::join(corrections.iter().map(|s| format!("`{}`", s)), ", ") itertools::join(
corrections.iter().map(|s| format!("`{good}{}{reset}`", s)),
", "
)
)?; )?;
} }
} }
@ -161,8 +165,8 @@ fn print_brief_correction(msg: &Typo) -> Result<(), std::io::Error> {
fn print_long_correction(msg: &Typo) -> Result<(), std::io::Error> { fn print_long_correction(msg: &Typo) -> Result<(), std::io::Error> {
let error = ERROR.render(); let error = ERROR.render();
let good = GOOD.render();
let info = INFO.render(); let info = INFO.render();
let strong = STRONG.render();
let reset = anstyle::Reset.render(); let reset = anstyle::Reset.render();
let stdout = stdout(); let stdout = stdout();
@ -178,16 +182,19 @@ fn print_long_correction(msg: &Typo) -> Result<(), std::io::Error> {
typos::Status::Invalid => { typos::Status::Invalid => {
writeln!( writeln!(
handle, handle,
"{error}error{reset}: {strong}`{}` is disallowed{reset}", "{error}error{reset}: `{error}{}{reset}` is disallowed",
msg.typo, msg.typo,
)?; )?;
} }
typos::Status::Corrections(corrections) => { typos::Status::Corrections(corrections) => {
writeln!( writeln!(
handle, handle,
"{error}error{reset}: {strong}`{}` should be {}{reset}", "{error}error{reset}: `{error}{}{reset}` should be {}",
msg.typo, msg.typo,
itertools::join(corrections.iter().map(|s| format!("`{}`", s)), ", ") itertools::join(
corrections.iter().map(|s| format!("`{good}{}{reset}`", s)),
", "
)
)?; )?;
} }
} }