Skip to content
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.

Sign up for GitHub

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

ruff server: Formatting a document with syntax problems no longer spams a visible error popup #11745

Merged
merged 3 commits into from
Jun 5, 2024
Merged

ruff server: Formatting a document with syntax problems no longer spams a visible error popup #11745

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c486098
Log format parsing errors instead of propagating them
snowsignal Jun 4, 2024
3cddd40
Reword comment
snowsignal Jun 4, 2024
9293364
Address suggestions
snowsignal Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions crates/ruff_server/src/format.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use ruff_formatter::PrintedRange;
use ruff_python_ast::PySourceType;
use ruff_python_formatter::format_module_source;
use ruff_python_formatter::{format_module_source, FormatModuleError};
use ruff_text_size::TextRange;
use ruff_workspace::FormatterSettings;

Expand All @@ -12,8 +12,16 @@ pub(crate) fn format(
formatter_settings: &FormatterSettings,
) -> crate::Result<String> {
let format_options = formatter_settings.to_format_options(source_type, document.contents());
let formatted = format_module_source(document.contents(), format_options)?;
Ok(formatted.into_code())
match format_module_source(document.contents(), format_options) {
Ok(formatted) => Ok(formatted.into_code()),
// Special case - syntax/parse errors are be handled here instead of
// being propagated as visible server errors.
Err(FormatModuleError::ParseError(error)) => {
tracing::warn!("Unable to format document: {error}");
Ok(document.contents().to_string())
}
Err(err) => Err(err.into()),
}
}

pub(crate) fn format_range(
Expand All @@ -24,9 +32,14 @@ pub(crate) fn format_range(
) -> crate::Result<PrintedRange> {
let format_options = formatter_settings.to_format_options(source_type, document.contents());

Ok(ruff_python_formatter::format_range(
document.contents(),
range,
format_options,
)?)
match ruff_python_formatter::format_range(document.contents(), range, format_options) {
Ok(formatted) => Ok(formatted),
// Special case - syntax/parse errors should be handled here instead of
snowsignal marked this conversation as resolved.
Show resolved Hide resolved
// being propagated to become visible server errors.
Err(FormatModuleError::ParseError(error)) => {
tracing::warn!("Unable to format document range: {error}");
Ok(PrintedRange::new(document.contents().to_string(), range))
snowsignal marked this conversation as resolved.
Show resolved Hide resolved
}
Err(err) => Err(err.into()),
}
}
Loading