extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-12-23 23:49:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

finish up with examples (#4637)

Browse Source
This commit is contained in:
JT 2022-02-25 05:19:25 -05:00 committed by GitHub
parent 2b1e4dd242
commit e8a6458f0d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
crates/nu-command/src/core_commands/export.rs
View File

@ -2,7 +2,7 @@ use nu_engine::get_full_help;
use nu_protocol::{
ast::Call,
engine::{Command, EngineState, Stack},
Category, IntoPipelineData, PipelineData, Signature, Value,
Category, Example, IntoPipelineData, PipelineData, Signature, Span, Value,
};
#[derive(Clone)]
@ -39,4 +39,15 @@ impl Command for ExportCommand {
}
.into_pipeline_data())
}
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Export a definition from a module",
example: r#"module utils { export def my-command [] { "hello" } }; use utils my-command; my-command"#,
result: Some(Value::String {
val: "hello".to_string(),
span: Span::test_data(),
}),
}]
}
}

10
crates/nu-command/src/core_commands/extern_.rs
View File

@ -1,6 +1,6 @@
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{Category, PipelineData, Signature, SyntaxShape};
use nu_protocol::{Category, Example, PipelineData, Signature, SyntaxShape};
#[derive(Clone)]
pub struct Extern;
@ -30,4 +30,12 @@ impl Command for Extern {
) -> Result<nu_protocol::PipelineData, nu_protocol::ShellError> {
Ok(PipelineData::new(call.head))
}
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Write a signature for an external command",
example: r#"extern echo [text: string]"#,
result: None,
}]
}
}

10
crates/nu-command/src/system/run_external.rs
View File

@ -8,7 +8,7 @@ use std::sync::mpsc;
use nu_engine::env_to_strings;
use nu_protocol::engine::{EngineState, Stack};
use nu_protocol::{ast::Call, engine::Command, ShellError, Signature, SyntaxShape, Value};
use nu_protocol::{Category, PipelineData, RawStream, Span, Spanned};
use nu_protocol::{Category, Example, PipelineData, RawStream, Span, Spanned};
use itertools::Itertools;
@ -93,6 +93,14 @@ impl Command for External {
};
command.run_with_input(engine_state, stack, input)
}
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Run an external command",
example: r#"run-external "echo" "-n" "hello""#,
result: None,
}]
}
}
pub struct ExternalCommand {