From 92d968b8c8f29dfa453e3319185a5a187de02db3 Mon Sep 17 00:00:00 2001
From: Auca Coyan <aucacoyan@gmail.com>
Date: Fri, 15 Dec 2023 10:00:08 -0300
Subject: [PATCH] :recycle: Match `--ide-hover` with `help` command (#11284)

# Description
Hi! @fdncred pointed that the `help` command doesn't give the same
result as hovering a command in the VS Code extension. I digged out that
this trace back from `src/ide.rs`, so I decided to change this: (look at
the window of VS Code when hovering help)

![image](https://github.com/nushell/nushell/assets/30557287/32e24090-9238-423e-88ba-7dd6eb53d885)

into this:

![image](https://github.com/nushell/nushell/assets/30557287/51457cf7-4baf-4220-b901-66a78f7ee817)


# User-Facing Changes
The `--ide-hover` change a lot, by matching the `help` command of the
terminal nushell

The only missing part is the `subcommands` part

# Tests + Formatting
All good!

# After Submitting
---
 src/ide.rs | 91 ++++++++++++++++++++++++++++++------------------------
 1 file changed, 50 insertions(+), 41 deletions(-)

diff --git a/src/ide.rs b/src/ide.rs
index 961b3a774..07d57d8ab 100644
--- a/src/ide.rs
+++ b/src/ide.rs
@@ -211,8 +211,19 @@ 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### Signature\n```\n".to_string();
+            let mut description = "```\n".to_string();
 
+            // first description
+            description.push_str(&format!("{}\n", decl.usage()));
+
+            // additional description
+            if !decl.extra_usage().is_empty() {
+                description.push_str(&format!("\n{}\n", decl.extra_usage()));
+            }
+
+            // Usage
+            description.push_str("### Usage\n```\n");
             let signature = decl.signature();
             description.push_str(&format!("  {}", signature.name));
             if !signature.named.is_empty() {
@@ -230,6 +241,41 @@ pub fn hover(engine_state: &mut EngineState, file_path: &str, location: &Value)
 
             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 {
+                        description.push_str("\\\n");
+                    } else {
+                        first = false;
+                    }
+                    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');
+            }
+
+            // Parameters
             if !signature.required_positional.is_empty()
                 || !signature.optional_positional.is_empty()
                 || signature.rest_positional.is_some()
@@ -285,41 +331,9 @@ pub fn hover(engine_state: &mut EngineState, file_path: &str, location: &Value)
                 description.push('\n');
             }
 
-            if !signature.named.is_empty() {
-                description.push_str("\n### Flags\n\n");
-
-                let mut first = true;
-                for named in &signature.named {
-                    if !first {
-                        description.push_str("\\\n");
-                    } else {
-                        first = false;
-                    }
-                    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');
-            }
-
+            // Input/output types
             if !signature.input_output_types.is_empty() {
-                description.push_str("\n### Input/output\n");
+                description.push_str("\n### Input/output types\n");
 
                 description.push_str("\n```\n");
                 for input_output in &signature.input_output_types {
@@ -328,12 +342,7 @@ pub fn hover(engine_state: &mut EngineState, file_path: &str, location: &Value)
                 description.push_str("\n```\n");
             }
 
-            description.push_str(&format!("### Usage\n  {}\n", decl.usage()));
-
-            if !decl.extra_usage().is_empty() {
-                description.push_str(&format!("\n### Extra usage:\n  {}\n", decl.extra_usage()));
-            }
-
+            // Examples
             if !decl.examples().is_empty() {
                 description.push_str("### Example(s)\n```\n");