[Enhancement]: KCL Diagnostic

[He1pa]

Enhancement

Diagnostic postion

LSP Diagnostic position is a range(start and end) position but in KCL is a single (start) postion.

LSP DIagnostic: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnostic
KCL Diagnostic position: https://github.com/kcl-lang/kcl/blob/82d149c36736fc4cae710f33ecf775a5766561e6/kclvm/error/src/diagnostic.rs

This will affect the display of diagnostics in the IDE, as well as the development of some features.

Multiple positions diagnostic

For some errors that have multiple locations, e.g. attr confict, the error message is scattered across different position. Incomplete error messages at a single position make it hard to understand

Edit message

Steps:

1. Client: open/edit file.
2. Server: generate and publish LSP Diagnostics(message, range, code(number or string), related messages and some information) from KCL Diagnostics.
3. Client: click on quick fix button and send CodeAction request, the param contains LSP Diagnostics generated in step 2.
4. Server: generate code action(TextEdit(range, newtext) to replace the diagnostic source code) and response to client.

LSP CodeAction(quick fix) use some edit message to replace source code in diagnostic position.

• https://github.com/YuanboXue-Amber/endevor-scl-support/blob/master/server/src/CodeActionProvider.ts

Rely on diagnostic unique ID/code to provide edit message

pub(crate) fn handle_code_action(
    _snap: LanguageServerSnapshot,
    params: lsp_types::CodeActionParams,
    _sender: Sender<Task>,
) -> anyhow::Result<Option<lsp_types::CodeActionResponse>> {
    let diags = params.context.diagnostics;
    let mut code_actions: Vec<lsp_types::CodeActionOrCommand> = vec![];
    for diag in diags {
        match diag.code.into_kcl_diag_code() {
            code::UnusedImport => {
                let mut changes = HashMap::new();
                changes.insert(
                    params.text_document.uri.clone(),
                    vec![TextEdit {
                        range: diag.range,
                        new_text: "".to_string(),
                    }],
                );
                code_actions.push(CodeActionOrCommand::CodeAction(CodeAction {
                    title: "Unused import".to_string(),
                    kind: Some(CodeActionKind::QUICKFIX),
                    diagnostics: Some(vec![diag.clone()]),
                    edit: Some(lsp_types::WorkspaceEdit {
                        changes: Some(changes),
                        ..Default::default()
                    }),
                    ..Default::default()
                }))
            }
            code::ReImport => {
                let mut changes = HashMap::new();
                changes.insert(
                    params.text_document.uri.clone(),
                    vec![TextEdit {
                        range: diag.range,
                        new_text: "".to_string(),
                    }],
                );
                code_actions.push(CodeActionOrCommand::CodeAction(CodeAction {
                    title: "Unused import".to_string(),
                    kind: Some(CodeActionKind::QUICKFIX),
                    diagnostics: Some(vec![diag.clone()]),
                    edit: Some(lsp_types::WorkspaceEdit {
                        changes: Some(changes),
                        ..Default::default()
                    }),
                    ..Default::default()
                }))
            }
            ...
        }
    }
    Ok(Some(code_actions))
}