mirror of
https://github.com/nushell/nushell.git
synced 2025-04-11 06:48:31 +02:00
fix(lsp): ansi strip on hover text (#15331)
Fixes messed ansi escapes in hover text (manpage): <img width="392" alt="image" src="https://github.com/user-attachments/assets/37c16520-d499-4079-93d9-0eccd1cfa8de" /> # Description That bug is introduced in #15115. Also refactored the hover related code to a separate file, just like other features. # User-Facing Changes # Tests + Formatting # After Submitting
This commit is contained in:
zc he
GitHub
parent
c949d2e893
commit
2c35e07c2d
1
Cargo.lock
generated
1
Cargo.lock
generated
@ -3808,6 +3808,7 @@ dependencies = [
|
||||
"nu-parser",
|
||||
"nu-protocol",
|
||||
"nu-test-support",
|
||||
"nu-utils",
|
||||
"nucleo-matcher",
|
||||
"serde",
|
||||
"serde_json",
|
||||
|
||||
@ -12,6 +12,7 @@ nu-cli = { path = "../nu-cli", version = "0.102.1" }
|
||||
nu-glob = { path = "../nu-glob", version = "0.102.1" }
|
||||
nu-parser = { path = "../nu-parser", version = "0.102.1" }
|
||||
nu-protocol = { path = "../nu-protocol", version = "0.102.1" }
|
||||
nu-utils = { path = "../nu-utils", version = "0.102.1" }
|
||||
|
||||
crossbeam-channel = { workspace = true }
|
||||
lsp-server = { workspace = true }
|
||||
|
||||
411
crates/nu-lsp/src/hover.rs
Normal file
411
crates/nu-lsp/src/hover.rs
Normal file
@ -0,0 +1,411 @@
|
||||
use lsp_types::{Hover, HoverContents, HoverParams, MarkupContent, MarkupKind};
|
||||
use nu_protocol::engine::Command;
|
||||
|
||||
use crate::{Id, LanguageServer};
|
||||
|
||||
impl LanguageServer {
|
||||
pub(crate) fn get_decl_description(decl: &dyn Command, skip_description: bool) -> String {
|
||||
let mut description = String::new();
|
||||
|
||||
if !skip_description {
|
||||
// First description
|
||||
description.push_str(&format!("{}\n", decl.description().replace('\r', "")));
|
||||
|
||||
// Additional description
|
||||
if !decl.extra_description().is_empty() {
|
||||
description.push_str(&format!("\n{}\n", decl.extra_description()));
|
||||
}
|
||||
}
|
||||
// Usage
|
||||
description.push_str("---\n### Usage \n```nu\n");
|
||||
let signature = decl.signature();
|
||||
description.push_str(&Self::get_signature_label(&signature));
|
||||
description.push_str("\n```\n");
|
||||
|
||||
// Flags
|
||||
if !signature.named.is_empty() {
|
||||
description.push_str("\n### Flags\n\n");
|
||||
let mut first = true;
|
||||
for named in &signature.named {
|
||||
if first {
|
||||
first = false;
|
||||
} else {
|
||||
description.push('\n');
|
||||
}
|
||||
description.push_str(" ");
|
||||
if let Some(short_flag) = &named.short {
|
||||
description.push_str(&format!("`-{short_flag}`"));
|
||||
}
|
||||
if !named.long.is_empty() {
|
||||
if named.short.is_some() {
|
||||
description.push_str(", ");
|
||||
}
|
||||
description.push_str(&format!("`--{}`", named.long));
|
||||
}
|
||||
if let Some(arg) = &named.arg {
|
||||
description.push_str(&format!(" `<{}>`", arg.to_type()));
|
||||
}
|
||||
if !named.desc.is_empty() {
|
||||
description.push_str(&format!(" - {}", named.desc));
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
|
||||
// Parameters
|
||||
if !signature.required_positional.is_empty()
|
||||
|| !signature.optional_positional.is_empty()
|
||||
|| signature.rest_positional.is_some()
|
||||
{
|
||||
description.push_str("\n### Parameters\n\n");
|
||||
let mut first = true;
|
||||
for required_arg in &signature.required_positional {
|
||||
if first {
|
||||
first = false;
|
||||
} else {
|
||||
description.push('\n');
|
||||
}
|
||||
description.push_str(&format!(
|
||||
" `{}: {}`",
|
||||
required_arg.name,
|
||||
required_arg.shape.to_type()
|
||||
));
|
||||
if !required_arg.desc.is_empty() {
|
||||
description.push_str(&format!(" - {}", required_arg.desc));
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
for optional_arg in &signature.optional_positional {
|
||||
if first {
|
||||
first = false;
|
||||
} else {
|
||||
description.push('\n');
|
||||
}
|
||||
description.push_str(&format!(
|
||||
" `{}: {}`",
|
||||
optional_arg.name,
|
||||
optional_arg.shape.to_type()
|
||||
));
|
||||
if !optional_arg.desc.is_empty() {
|
||||
description.push_str(&format!(" - {}", optional_arg.desc));
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
if let Some(arg) = &signature.rest_positional {
|
||||
if !first {
|
||||
description.push('\n');
|
||||
}
|
||||
description.push_str(&format!(" `...{}: {}`", arg.name, arg.shape.to_type()));
|
||||
if !arg.desc.is_empty() {
|
||||
description.push_str(&format!(" - {}", arg.desc));
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
|
||||
// Input/output types
|
||||
if !signature.input_output_types.is_empty() {
|
||||
description.push_str("\n### Input/output types\n");
|
||||
description.push_str("\n```nu\n");
|
||||
for input_output in &signature.input_output_types {
|
||||
description.push_str(&format!(" {} | {}\n", input_output.0, input_output.1));
|
||||
}
|
||||
description.push_str("\n```\n");
|
||||
}
|
||||
|
||||
// Examples
|
||||
if !decl.examples().is_empty() {
|
||||
description.push_str("### Example(s)\n");
|
||||
for example in decl.examples() {
|
||||
description.push_str(&format!(
|
||||
" {}\n```nu\n {}\n```\n",
|
||||
example.description, example.example
|
||||
));
|
||||
}
|
||||
}
|
||||
description
|
||||
}
|
||||
|
||||
pub(crate) fn hover(&mut self, params: &HoverParams) -> Option<Hover> {
|
||||
let mut engine_state = self.new_engine_state();
|
||||
|
||||
let path_uri = params
|
||||
.text_document_position_params
|
||||
.text_document
|
||||
.uri
|
||||
.to_owned();
|
||||
let (working_set, id, _, _) = self
|
||||
.parse_and_find(
|
||||
&mut engine_state,
|
||||
&path_uri,
|
||||
params.text_document_position_params.position,
|
||||
)
|
||||
.ok()?;
|
||||
|
||||
let markdown_hover = |content: String| {
|
||||
Some(Hover {
|
||||
contents: HoverContents::Markup(MarkupContent {
|
||||
kind: MarkupKind::Markdown,
|
||||
value: content,
|
||||
}),
|
||||
// TODO
|
||||
range: None,
|
||||
})
|
||||
};
|
||||
|
||||
match id {
|
||||
Id::Variable(var_id) => {
|
||||
let var = working_set.get_variable(var_id);
|
||||
let value = var
|
||||
.const_val
|
||||
.clone()
|
||||
.and_then(|v| v.coerce_into_string().ok())
|
||||
.unwrap_or(String::from(if var.mutable {
|
||||
"mutable"
|
||||
} else {
|
||||
"immutable"
|
||||
}));
|
||||
let contents = format!("```\n{}\n``` \n---\n{}", var.ty, value);
|
||||
markdown_hover(contents)
|
||||
}
|
||||
Id::CellPath(var_id, cell_path) => {
|
||||
let var = working_set.get_variable(var_id);
|
||||
markdown_hover(
|
||||
var.const_val
|
||||
.clone()
|
||||
.and_then(|val| val.follow_cell_path(&cell_path, false).ok())
|
||||
.map(|val| {
|
||||
let ty = val.get_type().clone();
|
||||
let value_string = val
|
||||
.coerce_into_string()
|
||||
.ok()
|
||||
.map(|s| format!("\n---\n{}", s))
|
||||
.unwrap_or_default();
|
||||
format!("```\n{}\n```{}", ty, value_string)
|
||||
})
|
||||
.unwrap_or("`unknown`".into()),
|
||||
)
|
||||
}
|
||||
Id::Declaration(decl_id) => markdown_hover(Self::get_decl_description(
|
||||
working_set.get_decl(decl_id),
|
||||
false,
|
||||
)),
|
||||
Id::Module(module_id) => {
|
||||
let description = working_set
|
||||
.get_module_comments(module_id)?
|
||||
.iter()
|
||||
.map(|sp| String::from_utf8_lossy(working_set.get_span_contents(*sp)).into())
|
||||
.collect::<Vec<String>>()
|
||||
.join("\n");
|
||||
markdown_hover(description)
|
||||
}
|
||||
Id::Value(t) => markdown_hover(format!("`{}`", t)),
|
||||
Id::External(cmd) => {
|
||||
let command_output = if cfg!(windows) {
|
||||
std::process::Command::new("powershell.exe")
|
||||
.args(["-NoProfile", "-Command", "help", &cmd])
|
||||
.output()
|
||||
} else {
|
||||
std::process::Command::new("man").arg(&cmd).output()
|
||||
};
|
||||
let manpage_str = match command_output {
|
||||
Ok(output) => nu_utils::strip_ansi_likely(
|
||||
String::from_utf8_lossy(&output.stdout).as_ref(),
|
||||
)
|
||||
.to_string(),
|
||||
Err(_) => format!("No command help found for {}", &cmd),
|
||||
};
|
||||
markdown_hover(manpage_str)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod hover_tests {
|
||||
use crate::{
|
||||
path_to_uri,
|
||||
tests::{
|
||||
initialize_language_server, open_unchecked, result_from_message, send_hover_request,
|
||||
},
|
||||
};
|
||||
use assert_json_diff::assert_json_eq;
|
||||
use nu_test_support::fs::fixtures;
|
||||
|
||||
#[test]
|
||||
fn hover_on_variable() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("var.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 2, 0);
|
||||
|
||||
assert_json_eq!(
|
||||
result_from_message(resp),
|
||||
serde_json::json!({ "contents": { "kind": "markdown", "value": "```\ntable\n``` \n---\nimmutable" } })
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_cell_path() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("cell_path.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 4, 3);
|
||||
let result = result_from_message(resp);
|
||||
assert_json_eq!(
|
||||
result.pointer("/contents/value").unwrap(),
|
||||
serde_json::json!("```\nlist<any>\n```")
|
||||
);
|
||||
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 4, 7);
|
||||
let result = result_from_message(resp);
|
||||
assert_json_eq!(
|
||||
result.pointer("/contents/value").unwrap(),
|
||||
serde_json::json!("```\nrecord<bar: int>\n```")
|
||||
);
|
||||
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 4, 11);
|
||||
let result = result_from_message(resp);
|
||||
assert_json_eq!(
|
||||
result.pointer("/contents/value").unwrap(),
|
||||
serde_json::json!("```\nint\n```\n---\n2")
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_custom_command() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("command.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 3, 0);
|
||||
|
||||
assert_json_eq!(
|
||||
result_from_message(resp),
|
||||
serde_json::json!({
|
||||
"contents": {
|
||||
"kind": "markdown",
|
||||
"value": "Renders some greeting message\n---\n### Usage \n```nu\n hello {flags}\n```\n\n### Flags\n\n `-h`, `--help` - Display the help message for this command\n\n"
|
||||
}
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_custom_in_custom() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("command.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 9, 7);
|
||||
|
||||
assert_json_eq!(
|
||||
result_from_message(resp),
|
||||
serde_json::json!({
|
||||
"contents": {
|
||||
"kind": "markdown",
|
||||
"value": "\n---\n### Usage \n```nu\n bar {flags}\n```\n\n### Flags\n\n `-h`, `--help` - Display the help message for this command\n\n"
|
||||
}
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_external_command() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("command.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 6, 2);
|
||||
|
||||
let hover_text = result_from_message(resp)
|
||||
.pointer("/contents/value")
|
||||
.unwrap()
|
||||
.as_str()
|
||||
.unwrap()
|
||||
.to_string();
|
||||
|
||||
#[cfg(not(windows))]
|
||||
assert!(hover_text.contains("SLEEP"));
|
||||
#[cfg(windows)]
|
||||
assert!(hover_text.contains("Start-Sleep"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_str_join() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("command.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 5, 8);
|
||||
|
||||
assert_json_eq!(
|
||||
result_from_message(resp),
|
||||
serde_json::json!({
|
||||
"contents": {
|
||||
"kind": "markdown",
|
||||
"value": "Concatenate multiple strings into a single string, with an optional separator between each.\n---\n### Usage \n```nu\n str join {flags} <separator?>\n```\n\n### Flags\n\n `-h`, `--help` - Display the help message for this command\n\n\n### Parameters\n\n `separator: string` - Optional separator to use when creating string.\n\n\n### Input/output types\n\n```nu\n list<any> | string\n string | string\n\n```\n### Example(s)\n Create a string from input\n```nu\n ['nu', 'shell'] | str join\n```\n Create a string from input with a separator\n```nu\n ['nu', 'shell'] | str join '-'\n```\n"
|
||||
}
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_module() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("goto");
|
||||
script.push("module.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 3, 12);
|
||||
let result = result_from_message(resp);
|
||||
|
||||
assert_eq!(
|
||||
result
|
||||
.pointer("/contents/value")
|
||||
.unwrap()
|
||||
.to_string()
|
||||
.replace("\\r", ""),
|
||||
"\"# module doc\""
|
||||
);
|
||||
}
|
||||
}
|
||||
@ -3,16 +3,16 @@ use lsp_server::{Connection, IoThreads, Message, Response, ResponseError};
|
||||
use lsp_textdocument::{FullTextDocument, TextDocuments};
|
||||
use lsp_types::{
|
||||
request::{self, Request},
|
||||
Hover, HoverContents, HoverParams, InlayHint, MarkupContent, MarkupKind, OneOf, Position,
|
||||
Range, ReferencesOptions, RenameOptions, SemanticToken, SemanticTokenType,
|
||||
SemanticTokensLegend, SemanticTokensOptions, SemanticTokensServerCapabilities,
|
||||
ServerCapabilities, SignatureHelpOptions, TextDocumentSyncKind, Uri, WorkDoneProgressOptions,
|
||||
WorkspaceFolder, WorkspaceFoldersServerCapabilities, WorkspaceServerCapabilities,
|
||||
InlayHint, OneOf, Position, Range, ReferencesOptions, RenameOptions, SemanticToken,
|
||||
SemanticTokenType, SemanticTokensLegend, SemanticTokensOptions,
|
||||
SemanticTokensServerCapabilities, ServerCapabilities, SignatureHelpOptions,
|
||||
TextDocumentSyncKind, Uri, WorkDoneProgressOptions, WorkspaceFolder,
|
||||
WorkspaceFoldersServerCapabilities, WorkspaceServerCapabilities,
|
||||
};
|
||||
use miette::{miette, IntoDiagnostic, Result};
|
||||
use nu_protocol::{
|
||||
ast::{Block, PathMember},
|
||||
engine::{Command, EngineState, StateDelta, StateWorkingSet},
|
||||
engine::{EngineState, StateDelta, StateWorkingSet},
|
||||
DeclId, ModuleId, Span, Type, VarId,
|
||||
};
|
||||
use std::{
|
||||
@ -31,6 +31,7 @@ mod completion;
|
||||
mod diagnostics;
|
||||
mod goto;
|
||||
mod hints;
|
||||
mod hover;
|
||||
mod notification;
|
||||
mod semantic_tokens;
|
||||
mod signature;
|
||||
@ -424,238 +425,21 @@ impl LanguageServer {
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
fn get_decl_description(decl: &dyn Command, skip_description: bool) -> String {
|
||||
let mut description = String::new();
|
||||
|
||||
if !skip_description {
|
||||
// First description
|
||||
description.push_str(&format!("{}\n", decl.description().replace('\r', "")));
|
||||
|
||||
// Additional description
|
||||
if !decl.extra_description().is_empty() {
|
||||
description.push_str(&format!("\n{}\n", decl.extra_description()));
|
||||
}
|
||||
}
|
||||
// Usage
|
||||
description.push_str("---\n### Usage \n```nu\n");
|
||||
let signature = decl.signature();
|
||||
description.push_str(&Self::get_signature_label(&signature));
|
||||
description.push_str("\n```\n");
|
||||
|
||||
// Flags
|
||||
if !signature.named.is_empty() {
|
||||
description.push_str("\n### Flags\n\n");
|
||||
let mut first = true;
|
||||
for named in &signature.named {
|
||||
if first {
|
||||
first = false;
|
||||
} else {
|
||||
description.push('\n');
|
||||
}
|
||||
description.push_str(" ");
|
||||
if let Some(short_flag) = &named.short {
|
||||
description.push_str(&format!("`-{short_flag}`"));
|
||||
}
|
||||
if !named.long.is_empty() {
|
||||
if named.short.is_some() {
|
||||
description.push_str(", ");
|
||||
}
|
||||
description.push_str(&format!("`--{}`", named.long));
|
||||
}
|
||||
if let Some(arg) = &named.arg {
|
||||
description.push_str(&format!(" `<{}>`", arg.to_type()));
|
||||
}
|
||||
if !named.desc.is_empty() {
|
||||
description.push_str(&format!(" - {}", named.desc));
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
|
||||
// Parameters
|
||||
if !signature.required_positional.is_empty()
|
||||
|| !signature.optional_positional.is_empty()
|
||||
|| signature.rest_positional.is_some()
|
||||
{
|
||||
description.push_str("\n### Parameters\n\n");
|
||||
let mut first = true;
|
||||
for required_arg in &signature.required_positional {
|
||||
if first {
|
||||
first = false;
|
||||
} else {
|
||||
description.push('\n');
|
||||
}
|
||||
description.push_str(&format!(
|
||||
" `{}: {}`",
|
||||
required_arg.name,
|
||||
required_arg.shape.to_type()
|
||||
));
|
||||
if !required_arg.desc.is_empty() {
|
||||
description.push_str(&format!(" - {}", required_arg.desc));
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
for optional_arg in &signature.optional_positional {
|
||||
if first {
|
||||
first = false;
|
||||
} else {
|
||||
description.push('\n');
|
||||
}
|
||||
description.push_str(&format!(
|
||||
" `{}: {}`",
|
||||
optional_arg.name,
|
||||
optional_arg.shape.to_type()
|
||||
));
|
||||
if !optional_arg.desc.is_empty() {
|
||||
description.push_str(&format!(" - {}", optional_arg.desc));
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
if let Some(arg) = &signature.rest_positional {
|
||||
if !first {
|
||||
description.push('\n');
|
||||
}
|
||||
description.push_str(&format!(" `...{}: {}`", arg.name, arg.shape.to_type()));
|
||||
if !arg.desc.is_empty() {
|
||||
description.push_str(&format!(" - {}", arg.desc));
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
description.push('\n');
|
||||
}
|
||||
|
||||
// Input/output types
|
||||
if !signature.input_output_types.is_empty() {
|
||||
description.push_str("\n### Input/output types\n");
|
||||
description.push_str("\n```nu\n");
|
||||
for input_output in &signature.input_output_types {
|
||||
description.push_str(&format!(" {} | {}\n", input_output.0, input_output.1));
|
||||
}
|
||||
description.push_str("\n```\n");
|
||||
}
|
||||
|
||||
// Examples
|
||||
if !decl.examples().is_empty() {
|
||||
description.push_str("### Example(s)\n");
|
||||
for example in decl.examples() {
|
||||
description.push_str(&format!(
|
||||
" {}\n```nu\n {}\n```\n",
|
||||
example.description, example.example
|
||||
));
|
||||
}
|
||||
}
|
||||
description
|
||||
}
|
||||
|
||||
fn hover(&mut self, params: &HoverParams) -> Option<Hover> {
|
||||
let mut engine_state = self.new_engine_state();
|
||||
|
||||
let path_uri = params
|
||||
.text_document_position_params
|
||||
.text_document
|
||||
.uri
|
||||
.to_owned();
|
||||
let (working_set, id, _, _) = self
|
||||
.parse_and_find(
|
||||
&mut engine_state,
|
||||
&path_uri,
|
||||
params.text_document_position_params.position,
|
||||
)
|
||||
.ok()?;
|
||||
|
||||
let markdown_hover = |content: String| {
|
||||
Some(Hover {
|
||||
contents: HoverContents::Markup(MarkupContent {
|
||||
kind: MarkupKind::Markdown,
|
||||
value: content,
|
||||
}),
|
||||
// TODO
|
||||
range: None,
|
||||
})
|
||||
};
|
||||
|
||||
match id {
|
||||
Id::Variable(var_id) => {
|
||||
let var = working_set.get_variable(var_id);
|
||||
let value = var
|
||||
.const_val
|
||||
.clone()
|
||||
.and_then(|v| v.coerce_into_string().ok())
|
||||
.unwrap_or(String::from(if var.mutable {
|
||||
"mutable"
|
||||
} else {
|
||||
"immutable"
|
||||
}));
|
||||
let contents = format!("```\n{}\n``` \n---\n{}", var.ty, value);
|
||||
markdown_hover(contents)
|
||||
}
|
||||
Id::CellPath(var_id, cell_path) => {
|
||||
let var = working_set.get_variable(var_id);
|
||||
markdown_hover(
|
||||
var.const_val
|
||||
.clone()
|
||||
.and_then(|val| val.follow_cell_path(&cell_path, false).ok())
|
||||
.map(|val| {
|
||||
let ty = val.get_type().clone();
|
||||
let value_string = val
|
||||
.coerce_into_string()
|
||||
.ok()
|
||||
.map(|s| format!("\n---\n{}", s))
|
||||
.unwrap_or_default();
|
||||
format!("```\n{}\n```{}", ty, value_string)
|
||||
})
|
||||
.unwrap_or("`unknown`".into()),
|
||||
)
|
||||
}
|
||||
Id::Declaration(decl_id) => markdown_hover(Self::get_decl_description(
|
||||
working_set.get_decl(decl_id),
|
||||
false,
|
||||
)),
|
||||
Id::Module(module_id) => {
|
||||
let description = working_set
|
||||
.get_module_comments(module_id)?
|
||||
.iter()
|
||||
.map(|sp| String::from_utf8_lossy(working_set.get_span_contents(*sp)).into())
|
||||
.collect::<Vec<String>>()
|
||||
.join("\n");
|
||||
markdown_hover(description)
|
||||
}
|
||||
Id::Value(t) => markdown_hover(format!("`{}`", t)),
|
||||
Id::External(cmd) => {
|
||||
let command_output = if cfg!(windows) {
|
||||
std::process::Command::new("powershell.exe")
|
||||
.args(["-NoProfile", "-Command", "help", &cmd])
|
||||
.output()
|
||||
} else {
|
||||
std::process::Command::new("man").arg(&cmd).output()
|
||||
};
|
||||
let manpage_str = match command_output {
|
||||
Ok(output) => String::from_utf8_lossy(&output.stdout).to_string(),
|
||||
Err(_) => format!("No command help found for {}", &cmd),
|
||||
};
|
||||
markdown_hover(manpage_str)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use assert_json_diff::assert_json_eq;
|
||||
use lsp_types::{
|
||||
notification::{
|
||||
DidChangeTextDocument, DidOpenTextDocument, Exit, Initialized, Notification,
|
||||
},
|
||||
request::{HoverRequest, Initialize, Request, Shutdown},
|
||||
DidChangeTextDocumentParams, DidOpenTextDocumentParams, InitializedParams, Position,
|
||||
DidChangeTextDocumentParams, DidOpenTextDocumentParams, HoverParams, InitializedParams,
|
||||
TextDocumentContentChangeEvent, TextDocumentIdentifier, TextDocumentItem,
|
||||
TextDocumentPositionParams, WorkDoneProgressParams,
|
||||
};
|
||||
use nu_protocol::{debugger::WithoutDebug, engine::Stack, PipelineData, ShellError, Value};
|
||||
use nu_test_support::fs::fixtures;
|
||||
use std::sync::mpsc::{self, Receiver};
|
||||
use std::time::Duration;
|
||||
|
||||
@ -879,179 +663,4 @@ mod tests {
|
||||
.recv_timeout(Duration::from_secs(2))
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_variable() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("var.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 2, 0);
|
||||
|
||||
assert_json_eq!(
|
||||
result_from_message(resp),
|
||||
serde_json::json!({ "contents": { "kind": "markdown", "value": "```\ntable\n``` \n---\nimmutable" } })
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_cell_path() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("cell_path.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 4, 3);
|
||||
let result = result_from_message(resp);
|
||||
assert_json_eq!(
|
||||
result.pointer("/contents/value").unwrap(),
|
||||
serde_json::json!("```\nlist<any>\n```")
|
||||
);
|
||||
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 4, 7);
|
||||
let result = result_from_message(resp);
|
||||
assert_json_eq!(
|
||||
result.pointer("/contents/value").unwrap(),
|
||||
serde_json::json!("```\nrecord<bar: int>\n```")
|
||||
);
|
||||
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 4, 11);
|
||||
let result = result_from_message(resp);
|
||||
assert_json_eq!(
|
||||
result.pointer("/contents/value").unwrap(),
|
||||
serde_json::json!("```\nint\n```\n---\n2")
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_custom_command() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("command.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 3, 0);
|
||||
|
||||
assert_json_eq!(
|
||||
result_from_message(resp),
|
||||
serde_json::json!({
|
||||
"contents": {
|
||||
"kind": "markdown",
|
||||
"value": "Renders some greeting message\n---\n### Usage \n```nu\n hello {flags}\n```\n\n### Flags\n\n `-h`, `--help` - Display the help message for this command\n\n"
|
||||
}
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_custom_in_custom() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("command.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 9, 7);
|
||||
|
||||
assert_json_eq!(
|
||||
result_from_message(resp),
|
||||
serde_json::json!({
|
||||
"contents": {
|
||||
"kind": "markdown",
|
||||
"value": "\n---\n### Usage \n```nu\n bar {flags}\n```\n\n### Flags\n\n `-h`, `--help` - Display the help message for this command\n\n"
|
||||
}
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_external_command() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("command.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 6, 2);
|
||||
|
||||
let hover_text = result_from_message(resp)
|
||||
.pointer("/contents/value")
|
||||
.unwrap()
|
||||
.as_str()
|
||||
.unwrap()
|
||||
.to_string();
|
||||
|
||||
#[cfg(not(windows))]
|
||||
assert!(hover_text.contains("SLEEP"));
|
||||
#[cfg(windows)]
|
||||
assert!(hover_text.contains("Start-Sleep"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_str_join() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("hover");
|
||||
script.push("command.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 5, 8);
|
||||
|
||||
assert_json_eq!(
|
||||
result_from_message(resp),
|
||||
serde_json::json!({
|
||||
"contents": {
|
||||
"kind": "markdown",
|
||||
"value": "Concatenate multiple strings into a single string, with an optional separator between each.\n---\n### Usage \n```nu\n str join {flags} <separator?>\n```\n\n### Flags\n\n `-h`, `--help` - Display the help message for this command\n\n\n### Parameters\n\n `separator: string` - Optional separator to use when creating string.\n\n\n### Input/output types\n\n```nu\n list<any> | string\n string | string\n\n```\n### Example(s)\n Create a string from input\n```nu\n ['nu', 'shell'] | str join\n```\n Create a string from input with a separator\n```nu\n ['nu', 'shell'] | str join '-'\n```\n"
|
||||
}
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn hover_on_module() {
|
||||
let (client_connection, _recv) = initialize_language_server(None, None);
|
||||
|
||||
let mut script = fixtures();
|
||||
script.push("lsp");
|
||||
script.push("goto");
|
||||
script.push("module.nu");
|
||||
let script = path_to_uri(&script);
|
||||
|
||||
open_unchecked(&client_connection, script.clone());
|
||||
let resp = send_hover_request(&client_connection, script.clone(), 3, 12);
|
||||
let result = result_from_message(resp);
|
||||
|
||||
assert_eq!(
|
||||
result
|
||||
.pointer("/contents/value")
|
||||
.unwrap()
|
||||
.to_string()
|
||||
.replace("\\r", ""),
|
||||
"\"# module doc\""
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user