Add command_prelude module (#12291)

# Description
When implementing a `Command`, one must also import all the types
present in the function signatures for `Command`. This makes it so that
we often import the same set of types in each command implementation
file. E.g., something like this:
```rust
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
    record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, PipelineData,
    ShellError, Signature, Span, Type, Value,
};
```

This PR adds the `nu_engine::command_prelude` module which contains the
necessary and commonly used types to implement a `Command`:
```rust
// command_prelude.rs
pub use crate::CallExt;
pub use nu_protocol::{
    ast::{Call, CellPath},
    engine::{Command, EngineState, Stack},
    record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, IntoSpanned,
    PipelineData, Record, ShellError, Signature, Span, Spanned, SyntaxShape, Type, Value,
};
```

This should reduce the boilerplate needed to implement a command and
also gives us a place to track the breadth of the `Command` API. I tried
to be conservative with what went into the prelude modules, since it
might be hard/annoying to remove items from the prelude in the future.
Let me know if something should be included or excluded.

crates/nu-cli/src/commands/commandline/commandline_.rs

@@ -1,9 +1,4 @@
-use nu_engine::CallExt;
-use nu_protocol::{
-    ast::Call,
-    engine::{Command, EngineState, Stack},
-    Category, IntoPipelineData, PipelineData, ShellError, Signature, SyntaxShape, Type, Value,
-};
+use nu_engine::command_prelude::*;
 use unicode_segmentation::UnicodeSegmentation;
 
 #[derive(Clone)]

crates/nu-cli/src/commands/commandline/edit.rs

@@ -1,9 +1,4 @@
-use nu_engine::CallExt;
-use nu_protocol::{
-    ast::Call,
-    engine::{Command, EngineState, Stack},
-    Category, IntoPipelineData, PipelineData, ShellError, Signature, SyntaxShape, Type, Value,
-};
+use nu_engine::command_prelude::*;
 
 #[derive(Clone)]
 pub struct SubCommand;

crates/nu-cli/src/commands/commandline/get_cursor.rs

@@ -1,8 +1,4 @@
-use nu_protocol::{
-    ast::Call,
-    engine::{Command, EngineState, Stack},
-    Category, IntoPipelineData, PipelineData, ShellError, Signature, Type, Value,
-};
+use nu_engine::command_prelude::*;
 use unicode_segmentation::UnicodeSegmentation;
 
 #[derive(Clone)]

crates/nu-cli/src/commands/commandline/set_cursor.rs

@@ -1,9 +1,5 @@
-use nu_engine::CallExt;
-use nu_protocol::{
-    ast::Call,
-    engine::{Command, EngineState, Stack},
-    Category, IntoPipelineData, PipelineData, ShellError, Signature, SyntaxShape, Type, Value,
-};
+use nu_engine::command_prelude::*;
+
 use unicode_segmentation::UnicodeSegmentation;
 
 #[derive(Clone)]

crates/nu-cli/src/commands/default_context.rs

@@ -1,6 +1,5 @@
-use nu_protocol::engine::{EngineState, StateWorkingSet};
-
 use crate::commands::*;
+use nu_protocol::engine::{EngineState, StateWorkingSet};
 
 pub fn add_cli_context(mut engine_state: EngineState) -> EngineState {
     let delta = {

crates/nu-cli/src/commands/history/history_.rs

@@ -1,10 +1,5 @@
-use nu_engine::CallExt;
-use nu_protocol::ast::Call;
-use nu_protocol::engine::{Command, EngineState, Stack};
-use nu_protocol::{
-    record, Category, Example, HistoryFileFormat, IntoInterruptiblePipelineData, PipelineData,
-    ShellError, Signature, Span, Type, Value,
-};
+use nu_engine::command_prelude::*;
+use nu_protocol::HistoryFileFormat;
 use reedline::{
     FileBackedHistory, History as ReedlineHistory, HistoryItem, SearchDirection, SearchQuery,
     SqliteBackedHistory,

crates/nu-cli/src/commands/history/history_session.rs

@@ -1,8 +1,4 @@
-use nu_protocol::ast::Call;
-use nu_protocol::engine::{Command, EngineState, Stack};
-use nu_protocol::{
-    Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, Type, Value,
-};
+use nu_engine::command_prelude::*;
 
 #[derive(Clone)]
 pub struct HistorySession;

crates/nu-cli/src/commands/keybindings.rs

@@ -1,9 +1,4 @@
-use nu_engine::get_full_help;
-use nu_protocol::{
-    ast::Call,
-    engine::{Command, EngineState, Stack},
-    Category, IntoPipelineData, PipelineData, ShellError, Signature, Type, Value,
-};
+use nu_engine::{command_prelude::*, get_full_help};
 
 #[derive(Clone)]
 pub struct Keybindings;

crates/nu-cli/src/commands/keybindings_default.rs

@@ -1,8 +1,4 @@
-use nu_protocol::{
-    ast::Call,
-    engine::{Command, EngineState, Stack},
-    record, Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, Type, Value,
-};
+use nu_engine::command_prelude::*;
 use reedline::get_reedline_default_keybindings;
 
 #[derive(Clone)]

crates/nu-cli/src/commands/keybindings_list.rs

@@ -1,9 +1,4 @@
-use nu_protocol::{
-    ast::Call,
-    engine::{Command, EngineState, Stack},
-    record, Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, Span, Type,
-    Value,
-};
+use nu_engine::command_prelude::*;
 use reedline::{
     get_reedline_edit_commands, get_reedline_keybinding_modifiers, get_reedline_keycodes,
     get_reedline_prompt_edit_modes, get_reedline_reedline_events,

crates/nu-cli/src/commands/keybindings_listen.rs

@@ -1,12 +1,7 @@
-use crossterm::execute;
-use crossterm::QueueableCommand;
-use crossterm::{event::Event, event::KeyCode, event::KeyEvent, terminal};
-use nu_protocol::ast::Call;
-use nu_protocol::engine::{Command, EngineState, Stack};
-use nu_protocol::{
-    record, Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, Span, Type,
-    Value,
+use crossterm::{
+    event::Event, event::KeyCode, event::KeyEvent, execute, terminal, QueueableCommand,
 };
+use nu_engine::command_prelude::*;
 use std::io::{stdout, Write};
 
 #[derive(Clone)]

crates/nu-cli/src/completions/completer.rs

@@ -5,14 +5,13 @@ use crate::completions::{
 use nu_color_config::{color_record_to_nustyle, lookup_ansi_color_style};
 use nu_engine::eval_block;
 use nu_parser::{flatten_pipeline_element, parse, FlatShape};
-use nu_protocol::debugger::WithoutDebug;
 use nu_protocol::{
+    debugger::WithoutDebug,
     engine::{EngineState, Stack, StateWorkingSet},
     BlockId, PipelineData, Span, Value,
 };
 use reedline::{Completer as ReedlineCompleter, Suggestion};
-use std::str;
-use std::sync::Arc;
+use std::{str, sync::Arc};
 
 use super::base::{SemanticSuggestion, SuggestionKind};
 

crates/nu-cli/src/completions/completion_common.rs

@@ -2,11 +2,15 @@ use crate::completions::{matches, CompletionOptions};
 use nu_ansi_term::Style;
 use nu_engine::env_to_string;
 use nu_path::home_dir;
-use nu_protocol::engine::{EngineState, Stack};
-use nu_protocol::{engine::StateWorkingSet, Span};
+use nu_protocol::{
+    engine::{EngineState, Stack, StateWorkingSet},
+    Span,
+};
 use nu_utils::get_ls_colors;
-use std::ffi::OsStr;
-use std::path::{is_separator, Component, Path, PathBuf, MAIN_SEPARATOR as SEP};
+use std::{
+    ffi::OsStr,
+    path::{is_separator, Component, Path, PathBuf, MAIN_SEPARATOR as SEP},
+};
 
 fn complete_rec(
     partial: &[String],

crates/nu-cli/src/completions/completion_options.rs

@@ -1,8 +1,7 @@
-use std::fmt::Display;
-
 use fuzzy_matcher::{skim::SkimMatcherV2, FuzzyMatcher};
 use nu_parser::trim_quotes_str;
 use nu_protocol::CompletionAlgorithm;
+use std::fmt::Display;
 
 #[derive(Copy, Clone)]
 pub enum SortBy {

crates/nu-cli/src/completions/custom_completions.rs

@@ -1,17 +1,16 @@
-use crate::completions::{Completer, CompletionOptions, MatchAlgorithm, SortBy};
+use crate::completions::{
+    completer::map_value_completions, Completer, CompletionOptions, MatchAlgorithm,
+    SemanticSuggestion, SortBy,
+};
 use nu_engine::eval_call;
-use nu_protocol::debugger::WithoutDebug;
 use nu_protocol::{
     ast::{Argument, Call, Expr, Expression},
+    debugger::WithoutDebug,
     engine::{EngineState, Stack, StateWorkingSet},
     PipelineData, Span, Type, Value,
 };
 use nu_utils::IgnoreCaseExt;
-use std::collections::HashMap;
-use std::sync::Arc;
-
-use super::base::SemanticSuggestion;
-use super::completer::map_value_completions;
+use std::{collections::HashMap, sync::Arc};
 
 pub struct CustomCompletion {
     engine_state: Arc<EngineState>,

crates/nu-cli/src/completions/directory_completions.rs

@@ -8,8 +8,10 @@ use nu_protocol::{
     levenshtein_distance, Span,
 };
 use reedline::Suggestion;
-use std::path::{Path, MAIN_SEPARATOR as SEP};
-use std::sync::Arc;
+use std::{
+    path::{Path, MAIN_SEPARATOR as SEP},
+    sync::Arc,
+};
 
 use super::SemanticSuggestion;
 

crates/nu-cli/src/completions/file_completions.rs

@@ -9,8 +9,10 @@ use nu_protocol::{
 };
 use nu_utils::IgnoreCaseExt;
 use reedline::Suggestion;
-use std::path::{Path, MAIN_SEPARATOR as SEP};
-use std::sync::Arc;
+use std::{
+    path::{Path, MAIN_SEPARATOR as SEP},
+    sync::Arc,
+};
 
 use super::SemanticSuggestion;
 

crates/nu-cli/src/completions/flag_completions.rs

@@ -4,7 +4,6 @@ use nu_protocol::{
     engine::StateWorkingSet,
     Span,
 };
-
 use reedline::Suggestion;
 
 use super::SemanticSuggestion;

crates/nu-cli/src/completions/variable_completions.rs

@@ -1,15 +1,13 @@
-use crate::completions::{Completer, CompletionOptions};
+use crate::completions::{
+    Completer, CompletionOptions, MatchAlgorithm, SemanticSuggestion, SuggestionKind,
+};
 use nu_engine::{column::get_columns, eval_variable};
 use nu_protocol::{
     engine::{EngineState, Stack, StateWorkingSet},
     Span, Value,
 };
-
 use reedline::Suggestion;
-use std::str;
-use std::sync::Arc;
-
-use super::{MatchAlgorithm, SemanticSuggestion, SuggestionKind};
+use std::{str, sync::Arc};
 
 #[derive(Clone)]
 pub struct VariableCompletion {

crates/nu-cli/src/config_files.rs

@@ -1,9 +1,10 @@
 use crate::util::eval_source;
 #[cfg(feature = "plugin")]
 use nu_path::canonicalize_with;
-use nu_protocol::engine::{EngineState, Stack, StateWorkingSet};
-use nu_protocol::report_error;
-use nu_protocol::{HistoryFileFormat, PipelineData};
+use nu_protocol::{
+    engine::{EngineState, Stack, StateWorkingSet},
+    report_error, HistoryFileFormat, PipelineData,
+};
 #[cfg(feature = "plugin")]
 use nu_protocol::{ParseError, Spanned};
 #[cfg(feature = "plugin")]

crates/nu-cli/src/eval_cmds.rs

@@ -2,12 +2,10 @@ use log::info;
 use miette::Result;
 use nu_engine::{convert_env_values, eval_block};
 use nu_parser::parse;
-use nu_protocol::debugger::WithoutDebug;
-use nu_protocol::engine::Stack;
-use nu_protocol::report_error;
 use nu_protocol::{
-    engine::{EngineState, StateWorkingSet},
-    PipelineData, Spanned, Value,
+    debugger::WithoutDebug,
+    engine::{EngineState, Stack, StateWorkingSet},
+    report_error, PipelineData, Spanned, Value,
 };
 
 /// Run a command (or commands) given to us by the user

crates/nu-cli/src/eval_file.rs

@@ -1,21 +1,17 @@
-use std::sync::Arc;
-
 use crate::util::eval_source;
-use log::info;
-use log::trace;
+use log::{info, trace};
 use miette::{IntoDiagnostic, Result};
-use nu_engine::eval_block;
-use nu_engine::{convert_env_values, current_dir};
+use nu_engine::{convert_env_values, current_dir, eval_block};
 use nu_parser::parse;
 use nu_path::canonicalize_with;
-use nu_protocol::debugger::WithoutDebug;
-use nu_protocol::report_error;
 use nu_protocol::{
     ast::Call,
+    debugger::WithoutDebug,
     engine::{EngineState, Stack, StateWorkingSet},
-    Config, PipelineData, ShellError, Span, Value,
+    report_error, Config, PipelineData, ShellError, Span, Value,
 };
 use nu_utils::stdout_write_all_and_flush;
+use std::sync::Arc;
 
 /// Main function used when a file path is found as argument for nu
 pub fn evaluate_file(

crates/nu-cli/src/menus/help_completions.rs

@@ -2,8 +2,7 @@ use nu_engine::documentation::get_flags_section;
 use nu_protocol::{engine::EngineState, levenshtein_distance};
 use nu_utils::IgnoreCaseExt;
 use reedline::{Completer, Suggestion};
-use std::fmt::Write;
-use std::sync::Arc;
+use std::{fmt::Write, sync::Arc};
 
 pub struct NuHelpCompleter(Arc<EngineState>);
 

crates/nu-cli/src/menus/menu_completions.rs

@@ -1,6 +1,6 @@
 use nu_engine::eval_block;
-use nu_protocol::debugger::WithoutDebug;
 use nu_protocol::{
+    debugger::WithoutDebug,
     engine::{EngineState, Stack},
     IntoPipelineData, Span, Value,
 };

crates/nu-cli/src/nu_highlight.rs

@@ -1,6 +1,4 @@
-use nu_protocol::ast::Call;
-use nu_protocol::engine::{Command, EngineState, Stack};
-use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, Type, Value};
+use nu_engine::command_prelude::*;
 use reedline::{Highlighter, StyledText};
 
 #[derive(Clone)]

crates/nu-cli/src/print.rs

@@ -1,10 +1,4 @@
-use nu_engine::CallExt;
-use nu_protocol::ast::Call;
-use nu_protocol::engine::{Command, EngineState, Stack};
-use nu_protocol::{
-    Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, SyntaxShape, Type,
-    Value,
-};
+use nu_engine::command_prelude::*;
 
 #[derive(Clone)]
 pub struct Print;

crates/nu-cli/src/prompt.rs

@@ -1,13 +1,11 @@
 use crate::prompt_update::{POST_PROMPT_MARKER, PRE_PROMPT_MARKER};
 #[cfg(windows)]
 use nu_utils::enable_vt_processing;
-use reedline::DefaultPrompt;
-use {
-    reedline::{
-        Prompt, PromptEditMode, PromptHistorySearch, PromptHistorySearchStatus, PromptViMode,
-    },
-    std::borrow::Cow,
+use reedline::{
+    DefaultPrompt, Prompt, PromptEditMode, PromptHistorySearch, PromptHistorySearchStatus,
+    PromptViMode,
 };
+use std::borrow::Cow;
 
 /// Nushell prompt definition
 #[derive(Clone)]

crates/nu-cli/src/prompt_update.rs

@@ -1,11 +1,9 @@
 use crate::NushellPrompt;
 use log::trace;
 use nu_engine::get_eval_subexpression;
-
-use nu_protocol::report_error;
 use nu_protocol::{
     engine::{EngineState, Stack, StateWorkingSet},
-    Config, PipelineData, Value,
+    report_error, Config, PipelineData, Value,
 };
 use reedline::Prompt;
 

crates/nu-cli/src/reedline_config.rs

@@ -3,9 +3,9 @@ use crossterm::event::{KeyCode, KeyModifiers};
 use nu_color_config::{color_record_to_nustyle, lookup_ansi_color_style};
 use nu_engine::eval_block;
 use nu_parser::parse;
-use nu_protocol::debugger::WithoutDebug;
 use nu_protocol::{
     create_menus,
+    debugger::WithoutDebug,
     engine::{EngineState, Stack, StateWorkingSet},
     extract_value, Config, EditBindings, ParsedKeybinding, ParsedMenu, PipelineData, Record,
     ShellError, Span, Value,
@@ -1311,9 +1311,8 @@ fn extract_char(value: &Value, config: &Config) -> Result<char, ShellError> {
 
 #[cfg(test)]
 mod test {
-    use nu_protocol::record;
-
     use super::*;
+    use nu_protocol::record;
 
     #[test]
     fn test_send_event() {

crates/nu-cli/src/repl.rs

@@ -9,8 +9,10 @@ use crate::{
 use crossterm::cursor::SetCursorStyle;
 use log::{error, trace, warn};
 use miette::{ErrReport, IntoDiagnostic, Result};
-use nu_cmd_base::util::get_guaranteed_cwd;
-use nu_cmd_base::{hook::eval_hook, util::get_editor};
+use nu_cmd_base::{
+    hook::eval_hook,
+    util::{get_editor, get_guaranteed_cwd},
+};
 use nu_color_config::StyleComputer;
 use nu_engine::{convert_env_values, env_to_strings};
 use nu_parser::{lex, parse, trim_quotes_str};
@@ -31,8 +33,7 @@ use std::{
     env::temp_dir,
     io::{self, IsTerminal, Write},
     panic::{catch_unwind, AssertUnwindSafe},
-    path::Path,
-    path::PathBuf,
+    path::{Path, PathBuf},
     sync::{atomic::Ordering, Arc},
     time::{Duration, Instant},
 };

crates/nu-cli/src/syntax_highlight.rs

@@ -3,9 +3,11 @@ use nu_ansi_term::Style;
 use nu_color_config::{get_matching_brackets_style, get_shape_color};
 use nu_engine::env;
 use nu_parser::{flatten_block, parse, FlatShape};
-use nu_protocol::ast::{Argument, Block, Expr, Expression, PipelineRedirection, RecordItem};
-use nu_protocol::engine::{EngineState, Stack, StateWorkingSet};
-use nu_protocol::{Config, Span};
+use nu_protocol::{
+    ast::{Argument, Block, Expr, Expression, PipelineRedirection, RecordItem},
+    engine::{EngineState, Stack, StateWorkingSet},
+    Config, Span,
+};
 use reedline::{Highlighter, StyledText};
 use std::sync::Arc;
 

crates/nu-cli/src/util.rs

@@ -1,13 +1,11 @@
 use nu_cmd_base::hook::eval_hook;
 use nu_engine::{eval_block, eval_block_with_early_return};
 use nu_parser::{escape_quote_string, lex, parse, unescape_unquote_string, Token, TokenContents};
-use nu_protocol::debugger::WithoutDebug;
-use nu_protocol::engine::StateWorkingSet;
 use nu_protocol::{
-    engine::{EngineState, Stack},
-    print_if_stream, PipelineData, ShellError, Span, Value,
+    debugger::WithoutDebug,
+    engine::{EngineState, Stack, StateWorkingSet},
+    print_if_stream, report_error, report_error_new, PipelineData, ShellError, Span, Value,
 };
-use nu_protocol::{report_error, report_error_new};
 #[cfg(windows)]
 use nu_utils::enable_vt_processing;
 use nu_utils::utils::perf;