nushell/crates/nu_plugin_formats
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
..
src Add command_prelude module (#12291) 2024-03-26 21:17:30 +00:00
Cargo.toml Add example tests (nu-plugin-test-support) for plugins in repo (#12281) 2024-03-25 21:20:35 -05:00
README.md Move some from xxx commands to plugin (#7942) 2023-02-13 12:42:08 +00:00

nu_plugin_formats

A nushell plugin to convert data to nushell tables.

support commands:

  1. from eml - original ported from nushell core.
  2. from ics - original ported from nushell core.
  3. from ini - original ported from nushell core.
  4. from vcf - original ported from nushell core.

Prerequisite

nushell, It's a nushell plugin, so you need it.

Usage

  1. compile the binary: cargo build
  2. register plugin(assume it's compiled in ./target/debug/):
register ./target/debug/nu_plugin_formats