nushell/crates/nu-command/src/system/uname.rs
Darren Schroeder 2ad68e3702
cleanup coreutils tagging (#12286)
# Description

Cleanup search terms and help usage to be consistent and include
coreutils so people can easily find out which commands are coreutils.


![image](https://github.com/nushell/nushell/assets/343840/09b03b11-19ce-49ec-b0b5-9b8455d1b676)

or
```nushell
help commands | where usage =~ coreutils | reject params input_output
```

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# 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` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use std testing; testing run-tests --path
crates/nu-std"` to run the tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

# 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.
-->
2024-03-25 17:13:46 -05:00

101 lines
2.9 KiB
Rust

use nu_protocol::record;
use nu_protocol::Value;
use nu_protocol::{
ast::Call,
engine::{Command, EngineState, Stack},
Category, Example, PipelineData, ShellError, Signature, Type,
};
#[derive(Clone)]
pub struct UName;
impl Command for UName {
fn name(&self) -> &str {
"uname"
}
fn signature(&self) -> Signature {
Signature::build("uname")
.input_output_types(vec![(Type::Nothing, Type::Table(vec![]))])
.category(Category::System)
}
fn usage(&self) -> &str {
"Print certain system information using uutils/coreutils uname."
}
fn search_terms(&self) -> Vec<&str> {
// add other terms?
vec!["system", "coreutils"]
}
fn run(
&self,
_engine_state: &EngineState,
_stack: &mut Stack,
call: &Call,
_input: PipelineData,
) -> Result<PipelineData, ShellError> {
let span = call.head;
// Simulate `uname -all` is called every time
let opts = uu_uname::Options {
all: true,
kernel_name: false,
nodename: false,
kernel_release: false,
kernel_version: false,
machine: false,
processor: false,
hardware_platform: false,
os: false,
};
let output = uu_uname::UNameOutput::new(&opts).map_err(|e| ShellError::GenericError {
error: format!("{}", e),
msg: format!("{}", e),
span: None,
help: None,
inner: Vec::new(),
})?;
let outputs = [
output.kernel_name,
output.nodename,
output.kernel_release,
output.kernel_version,
output.machine,
output.os,
];
let outputs = outputs
.iter()
.map(|name| {
Ok(name
.as_ref()
.ok_or("unknown")
.map_err(|_| ShellError::NotFound { span })?
.to_string())
})
.collect::<Result<Vec<String>, ShellError>>()?;
Ok(PipelineData::Value(
Value::record(
record! {
"kernel-name" => Value::string(outputs[0].clone(), span),
"nodename" => Value::string(outputs[1].clone(), span),
"kernel-release" => Value::string(outputs[2].clone(), span),
"kernel-version" => Value::string(outputs[3].clone(), span),
"machine" => Value::string(outputs[4].clone(), span),
"operating-system" => Value::string(outputs[5].clone(), span),
},
span,
),
None,
))
}
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Print all information",
example: "uname",
result: None,
}]
}
}