WIP

crates/nu-engine/src/documentation.rs

@@ -1,5 +1,8 @@
 use itertools::Itertools;
-use nu_protocol::{engine::EvaluationContext, Example, Signature, Span, Value};
+use nu_protocol::{
+    engine::{EngineState, EvaluationContext},
+    Example, Signature, Span, Value,
+};
 use std::collections::HashMap;
 
 const COMMANDS_DOCS_DIR: &str = "docs/commands";
@@ -22,14 +25,13 @@ impl Default for DocumentationConfig {
     }
 }
 
-fn generate_doc(name: &str, context: &EvaluationContext) -> (Vec<String>, Vec<Value>) {
+fn generate_doc(name: &str, engine_state: &EngineState) -> (Vec<String>, Vec<Value>) {
     let mut cols = vec![];
     let mut vals = vec![];
 
-    let command = context
-        .engine_state
+    let command = engine_state
         .find_decl(name.as_bytes())
-        .map(|decl_id| context.engine_state.get_decl(decl_id))
+        .map(|decl_id| engine_state.get_decl(decl_id))
         .unwrap_or_else(|| panic!("Expected command '{}' from names to be in registry", name));
 
     cols.push("name".to_string());
@@ -57,7 +59,7 @@ fn generate_doc(name: &str, context: &EvaluationContext) -> (Vec<String>, Vec<Va
         val: get_documentation(
             &command.signature(),
             &command.examples(),
-            context,
+            engine_state,
             &DocumentationConfig {
                 no_subcommands: true,
                 no_color: true,
@@ -71,8 +73,8 @@ fn generate_doc(name: &str, context: &EvaluationContext) -> (Vec<String>, Vec<Va
 }
 
 // generate_docs gets the documentation from each command and returns a Table as output
-pub fn generate_docs(context: &EvaluationContext) -> Value {
-    let signatures = context.get_signatures();
+pub fn generate_docs(engine_state: &EngineState) -> Value {
+    let signatures = engine_state.get_signatures();
 
     // cmap will map parent commands to it's subcommands e.g. to -> [to csv, to yaml, to bson]
     let mut cmap: HashMap<String, Vec<String>> = HashMap::new();
@@ -98,11 +100,11 @@ pub fn generate_docs(context: &EvaluationContext) -> Value {
         if !cmap.contains_key(&sig.name) {
             continue;
         }
-        let mut row_entries = generate_doc(&sig.name, context);
+        let mut row_entries = generate_doc(&sig.name, engine_state);
         // Iterate over all the subcommands of the parent command
         let mut sub_table = Vec::new();
         for sub_name in cmap.get(&sig.name).unwrap_or(&Vec::new()) {
-            let (cols, vals) = generate_doc(sub_name, context);
+            let (cols, vals) = generate_doc(sub_name, engine_state);
             sub_table.push(Value::Record {
                 cols,
                 vals,
@@ -148,7 +150,7 @@ fn retrieve_doc_link(name: &str) -> Option<String> {
 pub fn get_documentation(
     sig: &Signature,
     examples: &[Example],
-    context: &EvaluationContext,
+    engine_state: &EngineState,
     config: &DocumentationConfig,
 ) -> String {
     let cmd_name = &sig.name;
@@ -168,7 +170,7 @@ pub fn get_documentation(
 
     let mut subcommands = vec![];
     if !config.no_subcommands {
-        let signatures = context.get_signatures();
+        let signatures = engine_state.get_signatures();
         for sig in signatures {
             if sig.name.starts_with(&format!("{} ", cmd_name)) {
                 subcommands.push(format!("  {} - {}", sig.name, sig.usage));
@@ -324,15 +326,11 @@ fn get_flags_section(signature: &Signature) -> String {
     long_desc
 }
 
-pub fn get_brief_help(
-    sig: &Signature,
-    examples: &[Example],
-    context: &EvaluationContext,
-) -> String {
+pub fn get_brief_help(sig: &Signature, examples: &[Example], engine_state: &EngineState) -> String {
     get_documentation(
         sig,
         examples,
-        context,
+        engine_state,
         &DocumentationConfig {
             no_subcommands: false,
             no_color: false,
@@ -341,6 +339,6 @@ pub fn get_brief_help(
     )
 }
 
-pub fn get_full_help(sig: &Signature, examples: &[Example], context: &EvaluationContext) -> String {
-    get_documentation(sig, examples, context, &DocumentationConfig::default())
+pub fn get_full_help(sig: &Signature, examples: &[Example], engine_state: &EngineState) -> String {
+    get_documentation(sig, examples, engine_state, &DocumentationConfig::default())
 }