Skip to content

Commit

Permalink
🐛 remove 3 backticks messing the hover (#12273)
Browse files Browse the repository at this point in the history
# Description

The hover was bugged with 3 backticks. I don't understand how it worked
before, but this apparently now works correctly on my machine. This is
really puzzling. My next step is to make a test to assert this will
break a little less. I fixed it 3 times in the past

# Tests + Formatting

Added a test to be sure this doesn't breaks again 😄 (at least from
nushell/nushell side)
  • Loading branch information
AucaCoyan committed Mar 24, 2024
1 parent 4ddc35c commit b3721a2
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 3 deletions.
32 changes: 31 additions & 1 deletion crates/nu-lsp/src/lib.rs
Expand Up @@ -964,7 +964,7 @@ mod tests {
}

#[test]
fn hover_on_command() {
fn hover_on_custom_command() {
let (client_connection, _recv) = initialize_language_server();

let mut script = fixtures();
Expand Down Expand Up @@ -993,6 +993,36 @@ mod tests {
);
}

#[test]
fn hover_on_str_join() {
let (client_connection, _recv) = initialize_language_server();

let mut script = fixtures();
script.push("lsp");
script.push("hover");
script.push("command.nu");
let script = Url::from_file_path(script).unwrap();

open_unchecked(&client_connection, script.clone());

let resp = hover(&client_connection, script.clone(), 5, 8);
let result = if let Message::Response(response) = resp {
response.result
} else {
panic!()
};

assert_json_eq!(
result,
serde_json::json!({
"contents": {
"kind": "markdown",
"value": "Concatenate multiple strings into a single string, with an optional separator between each.\n### Usage \n```\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```\n list<any> | string\n string | string\n\n```\n### Example(s)\n Create a string from input\n```\n ['nu', 'shell'] | str join\n```\n Create a string from input with a separator\n```\n ['nu', 'shell'] | str join '-'\n```\n"
}
})
);
}

fn complete(client_connection: &Connection, uri: Url, line: u32, character: u32) -> Message {
client_connection
.sender
Expand Down
3 changes: 1 addition & 2 deletions src/ide.rs
Expand Up @@ -211,8 +211,7 @@ pub fn hover(engine_state: &mut EngineState, file_path: &str, location: &Value)
Some((Id::Declaration(decl_id), offset, span)) => {
let decl = working_set.get_decl(decl_id);

//let mut description = "```\n### Signature\n```\n".to_string();
let mut description = "```\n".to_string();
let mut description = String::new();

// first description
description.push_str(&format!("{}\n", decl.usage()));
Expand Down
2 changes: 2 additions & 0 deletions tests/fixtures/lsp/hover/command.nu
Expand Up @@ -2,3 +2,5 @@
def hello [] {}

hello

[""] | str join

0 comments on commit b3721a2

Please sign in to comment.