nushell/crates/nu-explore/src
Ian Manske c747ec75c9
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.
2024-03-26 21:17:30 +00:00
..
commands Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
nu_common Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
pager Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
registry explore: remove :config, :show-config, :tweak commands (#10259) 2023-09-07 10:34:08 -05:00
views Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
default_context.rs Move explore command out of nu-command deps (#9421) 2023-06-14 01:18:36 +02:00
explore.rs Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
lib.rs Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00