update query json help and examples (#15190)

# Description

This PR adds extra_description stating what syntax query json is with
links. It also adds some examples since query json was written before
examples existed for plugins.

# 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 toolkit.nu; toolkit test stdlib"` 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.
-->
This commit is contained in:
Darren Schroeder 2025-02-26 09:15:14 -06:00 committed by GitHub
parent 0cb4281fdb
commit 1616acd124
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,7 +1,9 @@
use crate::Query;
use gjson::Value as gjValue;
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
use nu_protocol::{Category, LabeledError, Record, Signature, Span, Spanned, SyntaxShape, Value};
use nu_protocol::{
Category, Example, LabeledError, Record, Signature, Span, Spanned, SyntaxShape, Value,
};
pub struct QueryJson;
@ -16,12 +18,60 @@ impl SimplePluginCommand for QueryJson {
"execute json query on json file (open --raw <file> | query json 'query string')"
}
fn extra_description(&self) -> &str {
"query json uses the gjson crate https://github.com/tidwall/gjson.rs to query json data. The query syntax is available at https://github.com/tidwall/gjson/blob/master/SYNTAX.md."
}
fn signature(&self) -> Signature {
Signature::build(self.name())
.required("query", SyntaxShape::String, "json query")
.category(Category::Filters)
}
fn examples(&self) -> Vec<nu_protocol::Example> {
vec![
Example {
description: "Get a list of children from a json object",
example: r#"'{"children": ["Sara","Alex","Jack"]}' | query json children"#,
result: Some(Value::test_list(vec![
Value::test_string("Sara"),
Value::test_string("Alex"),
Value::test_string("Jack"),
])),
},
Example {
description: "Get a list of first names of the friends from a json object",
example: r#"'{
"friends": [
{"first": "Dale", "last": "Murphy", "age": 44, "nets": ["ig", "fb", "tw"]},
{"first": "Roger", "last": "Craig", "age": 68, "nets": ["fb", "tw"]},
{"first": "Jane", "last": "Murphy", "age": 47, "nets": ["ig", "tw"]}
]
}' | query json friends.#.first"#,
result: Some(Value::test_list(vec![
Value::test_string("Dale"),
Value::test_string("Roger"),
Value::test_string("Jane"),
])),
},
Example {
description: "Get the key named last of the name from a json object",
example: r#"'{"name": {"first": "Tom", "last": "Anderson"}}' | query json name.last"#,
result: Some(Value::test_string("Anderson")),
},
Example {
description: "Get the count of children from a json object",
example: r#"'{"children": ["Sara","Alex","Jack"]}' | query json children.#"#,
result: Some(Value::test_int(3)),
},
Example {
description: "Get the first child from the children array in reverse the order using the @reverse modifier from a json object",
example: r#"'{"children": ["Sara","Alex","Jack"]}' | query json "children|@reverse|0""#,
result: Some(Value::test_string("Jack")),
},
]
}
fn run(
&self,
_plugin: &Query,