panache 2.57.0

An LSP, formatter, and linter for Markdown, Quarto, and R Markdown
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

//! Workspace file-operation notifications (`didCreateFiles`/`didRenameFiles`/
//! `didDeleteFiles`).
//!
//! These are hygiene-only: they re-intern the affected paths into the salsa
//! `FileSet` (so `project_graph`, the set's only reader, re-runs and observes the
//! change), reload every open document's referenced files on the writer, and arm
//! the debounced settle so dependents re-lint over the fresh state. Delete also
//! evicts cached text and clears the deleted URI's own diagnostics.
//!
//! We deliberately do **not** register the `willCreateFiles`/`willDeleteFiles`
//! requests: creating a file inserts no scaffolding, and deleting one never
//! returns a destructive `WorkspaceEdit` — broken references simply surface as
//! diagnostics (`include-not-found`, etc.) on the next settle. The reference
//! rewriting on rename lives in the `willRenameFiles` request
//! ([`super::file_rename`]); this module only keeps server state coherent after
//! the operation has happened.
//!
//! These overlap with [`super::file_watcher::did_change_watched_files`] for
//! on-disk changes, but fire on editor-explorer operations even when a client
//! lacks `didChangeWatchedFiles` dynamic registration, and the delete path here
//! additionally clears the removed file's diagnostics.

use std::path::PathBuf;

use lsp_types::{CreateFilesParams, DeleteFilesParams, RenameFilesParams, Uri};

use crate::lsp::documents::reload_open_documents_referenced_files;
use crate::lsp::global_state::GlobalState;
use crate::lsp::uri_ext::UriExt;

/// Parse a file-operation URI string into a filesystem path.
fn op_uri_to_path(uri: &str) -> Option<PathBuf> {
    uri.parse::<Uri>()
        .ok()
        .and_then(|uri| uri.to_file_path().map(|p| p.into_owned()))
}

/// Handle `workspace/didCreateFiles`: pull each new file into the graph.
///
/// Interning flips a referenced-but-missing path's `None`->`Some` text input
/// (after the reload below), so a dependent's `include-not-found` clears.
pub(crate) fn did_create_files(gs: &mut GlobalState, params: CreateFilesParams) {
    for file in &params.files {
        if let Some(path) = op_uri_to_path(&file.uri) {
            gs.salsa.intern_file(Some(path));
        }
    }
    reload_open_documents_referenced_files(gs);
    gs.arm_settle();
}

/// Handle `workspace/didDeleteFiles`: drop each removed file from the graph.
///
/// Clears the deleted file's own diagnostics, evicts its cached text, and
/// re-interns it so `project_graph` re-runs and its filesystem probes observe
/// the absence — broken references in dependents surface on the next settle.
pub(crate) fn did_delete_files(gs: &mut GlobalState, params: DeleteFilesParams) {
    for file in &params.files {
        if let Ok(uri) = file.uri.parse::<Uri>() {
            gs.diagnostics
                .drop_uri(&uri, &gs.sender, gs.supports_pull_diagnostics);
        }
        if let Some(path) = op_uri_to_path(&file.uri) {
            gs.salsa.evict_file_text(&path);
            gs.salsa.intern_file(Some(path));
        }
    }
    reload_open_documents_referenced_files(gs);
    gs.arm_settle();
}

/// Handle `workspace/didRenameFiles`: treat each rename as delete-old +
/// create-new for graph purposes.
///
/// Open-document relocation is intentionally left to the editor's standard
/// `didClose(old)`/`didOpen(new)` pair; we only re-intern paths and re-lint so
/// references to the old name break and references to the new name resolve.
pub(crate) fn did_rename_files(gs: &mut GlobalState, params: RenameFilesParams) {
    for rename in &params.files {
        if let Ok(old_uri) = rename.old_uri.parse::<Uri>() {
            gs.diagnostics
                .drop_uri(&old_uri, &gs.sender, gs.supports_pull_diagnostics);
        }
        if let Some(old_path) = op_uri_to_path(&rename.old_uri) {
            gs.salsa.evict_file_text(&old_path);
            gs.salsa.intern_file(Some(old_path));
        }
        if let Some(new_path) = op_uri_to_path(&rename.new_uri) {
            gs.salsa.intern_file(Some(new_path));
        }
    }
    reload_open_documents_referenced_files(gs);
    gs.arm_settle();
}