mirror of
https://github.com/nushell/nushell
synced 2025-01-15 22:54:16 +00:00
99076af18b
# Description _(Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.)_ I opened this PR to unify the run command method. It's mainly to improve consistency across the tree. # User-Facing Changes None. # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
50 lines
1.4 KiB
Rust
50 lines
1.4 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, ShellError, Signature, Type, 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)
|
|
.input_output_types(vec![(Type::Nothing, Type::Bool)])
|
|
.allow_variants_without_examples(true)
|
|
}
|
|
|
|
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<PipelineData, ShellError> {
|
|
Ok(Value::boolean(is_root(), call.head).into_pipeline_data())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Return 'iamroot' if nushell is running with admin/root privileges, and 'iamnotroot' if not.",
|
|
example: r#"if is-admin { "iamroot" } else { "iamnotroot" }"#,
|
|
result: Some(Value::test_string("iamnotroot")),
|
|
},
|
|
]
|
|
}
|
|
}
|