mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-19 18:10:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

ruff server refreshes diagnostics for open files when file configuration is changed (#10988)

Browse source 
## Summary

The server now requests a [workspace diagnostic
refresh](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnostic_refresh)
when a configuration file gets changed. This means that diagnostics for
all open files will be automatically re-requested by the client on a
config change.

## Test Plan

You can test this by opening several files in VS Code, setting `select`
in your file configuration to `[]`, and observing that the diagnostics
go away once the file is saved (besides any `Pylance` diagnostics).
Restore it to what it was before, and you should see the diagnostics
automatically return once a save happens.
This commit is contained in:
Jane Lewis 2024-04-17 09:14:45 -07:00 • committed by GitHub
parent 518b29a9ef
commit 0a6327418d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 42 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

4
crates/ruff_server/src/server/api.rs
View file

@ -123,8 +123,8 @@ fn local_notification_task<'a, N: traits::SyncNotificationHandler>(
notif: server::Notification,
) -> super::Result<Task<'a>> {
let (id, params) = cast_notification::<N>(notif)?;
Ok(Task::local(move |session, notifier, _, _| {
if let Err(err) = N::run(session, notifier, params) {
Ok(Task::local(move |session, notifier, requester, _| {
if let Err(err) = N::run(session, notifier, requester, params) {
tracing::error!("An error occurred while running {id}: {err}");
show_err_msg!("Ruff encountered a problem. Check the logs for more details.");
}

3
crates/ruff_server/src/server/api/notifications/cancel.rs
View file

@ -1,4 +1,4 @@
use crate::server::client::Notifier;
use crate::server::client::{Notifier, Requester};
use crate::server::Result;
use crate::session::Session;
use lsp_types as types;
@ -15,6 +15,7 @@ impl super::SyncNotificationHandler for Cancel {
fn run(
_session: &mut Session,
_notifier: Notifier,
_requester: &mut Requester,
_params: types::CancelParams,
) -> Result<()> {
// TODO(jane): Handle this once we have task cancellation in the scheduler.

3
crates/ruff_server/src/server/api/notifications/did_change.rs
View file

@ -1,5 +1,5 @@
use crate::server::api::LSPResult;
use crate::server::client::Notifier;
use crate::server::client::{Notifier, Requester};
use crate::server::Result;
use crate::session::Session;
use lsp_types as types;
@ -16,6 +16,7 @@ impl super::SyncNotificationHandler for DidChange {
fn run(
session: &mut Session,
_notifier: Notifier,
_requester: &mut Requester,
types::DidChangeTextDocumentParams {
text_document:
types::VersionedTextDocumentIdentifier {

3
crates/ruff_server/src/server/api/notifications/did_change_configuration.rs
View file

@ -1,4 +1,4 @@
use crate::server::client::Notifier;
use crate::server::client::{Notifier, Requester};
use crate::server::Result;
use crate::session::Session;
use lsp_types as types;
@ -14,6 +14,7 @@ impl super::SyncNotificationHandler for DidChangeConfiguration {
fn run(
_session: &mut Session,
_notifier: Notifier,
_requester: &mut Requester,
_params: types::DidChangeConfigurationParams,
) -> Result<()> {
// TODO(jane): get this wired up after the pre-release

13
crates/ruff_server/src/server/api/notifications/did_change_watched_files.rs
View file

@ -1,5 +1,6 @@
use crate::server::api::LSPResult;
use crate::server::client::Notifier;
use crate::server::client::{Notifier, Requester};
use crate::server::schedule::Task;
use crate::server::Result;
use crate::session::Session;
use lsp_types as types;
@ -15,13 +16,21 @@ impl super::SyncNotificationHandler for DidChangeWatchedFiles {
fn run(
session: &mut Session,
_notifier: Notifier,
requester: &mut Requester,
params: types::DidChangeWatchedFilesParams,
) -> Result<()> {
for change in params.changes {
for change in &params.changes {
session
.reload_settings(&change.uri)
.with_failure_code(lsp_server::ErrorCode::InternalError)?;
}
if session.resolved_client_capabilities().workspace_refresh && !params.changes.is_empty() {
requester
.request::<types::request::WorkspaceDiagnosticRefresh>((), |()| Task::nothing())
.with_failure_code(lsp_server::ErrorCode::InternalError)?;
}
Ok(())
}
}

3
crates/ruff_server/src/server/api/notifications/did_change_workspace.rs
View file

@ -1,5 +1,5 @@
use crate::server::api::LSPResult;
use crate::server::client::Notifier;
use crate::server::client::{Notifier, Requester};
use crate::server::Result;
use crate::session::Session;
use lsp_types as types;
@ -15,6 +15,7 @@ impl super::SyncNotificationHandler for DidChangeWorkspace {
fn run(
session: &mut Session,
_notifier: Notifier,
_requester: &mut Requester,
params: types::DidChangeWorkspaceFoldersParams,
) -> Result<()> {
for new in params.event.added {

3
crates/ruff_server/src/server/api/notifications/did_close.rs
View file

@ -1,5 +1,5 @@
use crate::server::api::LSPResult;
use crate::server::client::Notifier;
use crate::server::client::{Notifier, Requester};
use crate::server::Result;
use crate::session::Session;
use lsp_types as types;
@ -16,6 +16,7 @@ impl super::SyncNotificationHandler for DidClose {
fn run(
session: &mut Session,
_notifier: Notifier,
_requester: &mut Requester,
types::DidCloseTextDocumentParams {
text_document: types::TextDocumentIdentifier { uri },
}: types::DidCloseTextDocumentParams,

3
crates/ruff_server/src/server/api/notifications/did_open.rs
View file

@ -1,4 +1,4 @@
use crate::server::client::Notifier;
use crate::server::client::{Notifier, Requester};
use crate::server::Result;
use crate::session::Session;
use lsp_types as types;
@ -15,6 +15,7 @@ impl super::SyncNotificationHandler for DidOpen {
fn run(
session: &mut Session,
_notifier: Notifier,
_requester: &mut Requester,
types::DidOpenTextDocumentParams {
text_document:
types::TextDocumentItem {

1
crates/ruff_server/src/server/api/traits.rs
View file

@ -56,6 +56,7 @@ pub(super) trait SyncNotificationHandler: NotificationHandler {
fn run(
session: &mut Session,
notifier: Notifier,
requester: &mut Requester,
params: <<Self as NotificationHandler>::NotificationType as LSPNotification>::Params,
) -> super::Result<()>;
}