-
-
Notifications
You must be signed in to change notification settings - Fork 862
feat(oxlint): add stylish formatter #8607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ec35945
feat(oxlint): add stylish formatter
shellscape 1a877ed
Merge branch 'main' into main
shellscape d348c3e
chore: cleanup comments
shellscape d9d1601
chore: Update apps/oxlint/src/output_formatter/stylish.rs
shellscape 33b6d08
Merge branch 'main' into main
shellscape File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| use std::io::Write; | ||
|
|
||
| use oxc_diagnostics::{ | ||
| reporter::{DiagnosticReporter, Info}, | ||
| Error, Severity, | ||
| }; | ||
| use rustc_hash::FxHashMap; | ||
|
|
||
| use crate::output_formatter::InternalFormatter; | ||
|
|
||
| #[derive(Debug, Default)] | ||
| pub struct StylishOutputFormatter; | ||
|
|
||
| impl InternalFormatter for StylishOutputFormatter { | ||
| fn all_rules(&mut self, writer: &mut dyn Write) { | ||
| writeln!(writer, "flag --rules with flag --format=stylish is not allowed").unwrap(); | ||
| } | ||
|
|
||
| fn get_diagnostic_reporter(&self) -> Box<dyn DiagnosticReporter> { | ||
| Box::new(StylishReporter::default()) | ||
| } | ||
| } | ||
|
|
||
| #[derive(Default)] | ||
| struct StylishReporter { | ||
| diagnostics: Vec<Error>, | ||
| } | ||
|
|
||
| impl DiagnosticReporter for StylishReporter { | ||
| fn finish(&mut self) -> Option<String> { | ||
| Some(format_stylish(&self.diagnostics)) | ||
| } | ||
|
|
||
| fn render_error(&mut self, error: Error) -> Option<String> { | ||
| self.diagnostics.push(error); | ||
| None | ||
| } | ||
| } | ||
|
|
||
| fn format_stylish(diagnostics: &[Error]) -> String { | ||
| if diagnostics.is_empty() { | ||
| return String::new(); | ||
| } | ||
|
|
||
| let mut output = String::new(); | ||
| let mut total_errors = 0; | ||
| let mut total_warnings = 0; | ||
|
|
||
| let mut grouped: FxHashMap<String, Vec<&Error>> = FxHashMap::default(); | ||
| let mut sorted = diagnostics.iter().collect::<Vec<_>>(); | ||
|
|
||
| sorted.sort_by_key(|diagnostic| Info::new(diagnostic).line); | ||
|
|
||
| for diagnostic in sorted { | ||
| let info = Info::new(diagnostic); | ||
| grouped.entry(info.filename).or_default().push(diagnostic); | ||
| } | ||
|
|
||
| for diagnostics in grouped.values() { | ||
| let diagnostic = diagnostics[0]; | ||
| let info = Info::new(diagnostic); | ||
| let filename = info.filename; | ||
| let filename = if let Some(path) = | ||
| std::env::current_dir().ok().and_then(|d| d.join(&filename).canonicalize().ok()) | ||
| { | ||
| path.display().to_string() | ||
| } else { | ||
| filename | ||
| }; | ||
| let max_len_width = diagnostics | ||
| .iter() | ||
| .filter_map(|diagnostic| diagnostic.labels()) | ||
| .flat_map(std::iter::Iterator::collect::<Vec<_>>) | ||
| .map(|label| format!("{}:{}", label.offset(), label.len()).len()) | ||
| .max() | ||
| .unwrap_or(0); | ||
|
|
||
| output.push_str(&format!("\n\u{1b}[4m{filename}\u{1b}[0m\n")); | ||
|
|
||
| for diagnostic in diagnostics { | ||
| match diagnostic.severity() { | ||
| Some(Severity::Error) => total_errors += 1, | ||
| _ => total_warnings += 1, | ||
| } | ||
|
|
||
| let severity_str = if diagnostic.severity() == Some(Severity::Error) { | ||
| "\u{1b}[31merror\u{1b}[0m" | ||
| } else { | ||
| "\u{1b}[33mwarning\u{1b}[0m" | ||
| }; | ||
|
|
||
| if let Some(label) = diagnostic.labels().expect("should have labels").next() { | ||
| let rule = diagnostic.code().map_or_else(String::new, |code| code.to_string()); | ||
| let position = format!("{}:{}", label.offset(), label.len()); | ||
| output.push_str( | ||
| &format!(" \u{1b}[2m{position:max_len_width$}\u{1b}[0m {severity_str} {diagnostic} \u{1b}[2m{rule}\u{1b}[0m\n"), | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| let total = total_errors + total_warnings; | ||
| if total > 0 { | ||
| let summary_color = if total_errors > 0 { "\u{1b}[31m" } else { "\u{1b}[33m" }; | ||
| output.push_str(&format!( | ||
| "\n{summary_color}✖ {total} problem{} ({total_errors} error{}, {total_warnings} warning{})\u{1b}[0m\n", | ||
| if total == 1 { "" } else { "s" }, | ||
| if total_errors == 1 { "" } else { "s" }, | ||
| if total_warnings == 1 { "" } else { "s" } | ||
| )); | ||
| } | ||
|
|
||
| output | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test { | ||
| use super::*; | ||
| use oxc_diagnostics::{NamedSource, OxcDiagnostic}; | ||
| use oxc_span::Span; | ||
|
|
||
| #[test] | ||
| fn test_stylish_reporter() { | ||
| let mut reporter = StylishReporter::default(); | ||
|
|
||
| let error = OxcDiagnostic::error("error message") | ||
| .with_label(Span::new(0, 8)) | ||
| .with_source_code(NamedSource::new("file.js", "code")); | ||
|
|
||
| let warning = OxcDiagnostic::warn("warning message") | ||
| .with_label(Span::new(0, 8)) | ||
| .with_source_code(NamedSource::new("file.js", "code")); | ||
|
|
||
| reporter.render_error(error); | ||
| reporter.render_error(warning); | ||
|
|
||
| let output = reporter.finish().unwrap(); | ||
|
|
||
| assert!(output.contains("error message"), "Output should contain 'error message'"); | ||
| assert!(output.contains("warning message"), "Output should contain 'warning message'"); | ||
| assert!(output.contains("\u{2716}"), "Output should contain the ✖ character"); | ||
| assert!(output.contains("2 problems"), "Output should mention total problems"); | ||
| assert!(output.contains("1 error"), "Output should mention error count"); | ||
| assert!(output.contains("1 warning"), "Output should mention warning count"); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.