nushell/crates/nu-protocol/src/engine
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
..
cached_file.rs Refactor source cache into CachedFile struct (#12240) 2024-03-20 19:43:50 +01:00
call_info.rs Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
capture_block.rs Use Vec for Closure captures (#10940) 2023-11-08 00:43:28 +01:00
command.rs Send LSP Completion Item Kind (#11443) 2024-03-24 20:14:12 -05:00
engine_state.rs Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
mod.rs Refactor source cache into CachedFile struct (#12240) 2024-03-20 19:43:50 +01:00
overlay.rs Style: move some Option if/else to method chains (#12285) 2024-03-26 08:35:51 +08:00
pattern_match.rs Boxes record for smaller Value enum. (#12252) 2024-03-26 17:17:44 +02:00
stack.rs Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
state_delta.rs Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
state_working_set.rs Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
stdio.rs Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
usage.rs Split up nu-protocol/src/engine/engine_state.rs (#10368) 2023-09-21 22:53:36 +02:00
variable.rs Restructure nu-protocol in more meaningful units (#11917) 2024-03-10 18:45:45 +01:00