nushell/crates/nu-command/src/experimental/is_admin.rs
Stefan Holderbach 0afe1e4e67
Test command names and search terms for redundancy (#6380)
* Test commands for proper names and search terms

Assert that the `Command.name()` is equal to `Signature.name`

Check that search terms are not just substrings of the command name as
they would not help finding the command.

* Clean up search terms

Remove redundant terms that just replicate the command name.
Try to eliminate substring between search terms, clean up where
necessary.
2022-08-24 11:16:47 +02:00

53 lines
1.5 KiB
Rust

use is_root::is_root;
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{Category, Example, IntoPipelineData, PipelineData, Signature, Span, Value};
#[derive(Clone)]
pub struct IsAdmin;
impl Command for IsAdmin {
fn name(&self) -> &str {
"is-admin"
}
fn usage(&self) -> &str {
"Check if nushell is running with administrator or root privileges"
}
fn signature(&self) -> nu_protocol::Signature {
Signature::build("is-admin").category(Category::Core)
}
fn search_terms(&self) -> Vec<&str> {
vec!["root", "administrator", "superuser", "supervisor"]
}
fn run(
&self,
_engine_state: &EngineState,
_stack: &mut Stack,
call: &Call,
_input: PipelineData,
) -> Result<nu_protocol::PipelineData, nu_protocol::ShellError> {
Ok(Value::Bool {
val: is_root(),
span: call.head,
}
.into_pipeline_data())
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Echo 'iamroot' if nushell is running with admin/root privileges, and 'iamnotroot' if not.",
example: r#"if is-admin { echo "iamroot" } else { echo "iamnotroot" }"#,
result: Some(Value::String {
val: "iamnotroot".to_string(),
span: Span::test_data(),
}),
},
]
}
}