Add jq_raw function to simplexpr #952
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jq_raw() shares the jq()'s implementation, with the difference being that _top level_ strings are not quoted (nested strings are quoted). This behavior is consistent with jq's documented and observed behavior for --raw-output.
w-lfchen
suggested changes
Aug 26, 2024
| @@ -20,6 +20,7 @@ All notable changes to eww will be listed here, starting at changes since versio | |||
| - Add trigonometric functions (`sin`, `cos`, `tan`, `cot`) and degree/radian conversions (`degtorad`, `radtodeg`) (By: end-4) | |||
| - Add `substring` function to simplexpr | |||
| - Add `--duration` flag to `eww open` | |||
| - Add `jq_raw` function | |||
There was a problem hiding this comment.
this entry needs to be moved and potentially updated
Comment on lines
+433
to
+434
| what @ ("jq" | "jq_raw") => match args.as_slice() { | ||
| [json, code] => run_jaq_function(json.as_json_value()?, code.as_string()?, what == "jq_raw") |
There was a problem hiding this comment.
Suggested change
| what @ ("jq" | "jq_raw") => match args.as_slice() { | |
| [json, code] => run_jaq_function(json.as_json_value()?, code.as_string()?, what == "jq_raw") | |
| jq_fn @ ("jq" | "jqraw") => match args.as_slice() { | |
| [json, code] => run_jaq_function(json.as_json_value()?, code.as_string()?, jq_fn == "jqraw") |
jqraw would be in line with the other function names, also consider renaming the binding to better reflect what it holds.
two further considerations:
- maybe pass
jq_fndirectly for a better interface, if we ever want to support further flags - split
jqandjqraw, this would probably yield better performance
| @@ -478,16 +478,23 @@ fn prepare_jaq_filter(code: String) -> Result<Arc<jaq_core::Filter>, EvalError> | |||
| Ok(Arc::new(filter)) | |||
| } | |||
|
|
|||
| fn run_jaq_function(json: serde_json::Value, code: String) -> Result<DynVal, EvalError> { | |||
| let filter = prepare_jaq_filter(code)?; | |||
| fn run_jaq_function(json: serde_json::Value, code: String, raw_string: bool) -> Result<DynVal, EvalError> { | |||
There was a problem hiding this comment.
Suggested change
| fn run_jaq_function(json: serde_json::Value, code: String, raw_string: bool) -> Result<DynVal, EvalError> { | |
| fn run_jaq_function(json: serde_json::Value, code: String, raw_output: bool) -> Result<DynVal, EvalError> { |
using the same name as the flag makes it easier to look up
| // Per jq docs, "raw-output" behavior simply omits | ||
| // quotation marks from strings, and outputs what would | ||
| // otherwise be valid JSON, so this should replicate that. | ||
| serde_json::Value::String(contents) if raw_string => DynVal::from_string(contents), |
There was a problem hiding this comment.
Suggested change
| serde_json::Value::String(contents) if raw_string => DynVal::from_string(contents), | |
| serde_json::Value::String(contents) if raw_output => DynVal::from_string(contents), |
Comment on lines
53
to
+54
| - `jq(value, jq_filter_string)`: run a [jq](https://stedolan.github.io/jq/manual/) style command on a json value. (Uses [jaq](https://crates.io/crates/jaq) internally). | ||
| - `jq_raw(value, jq_filter_string)`: as above, but top-level strings will not be quoted, as with `jq --raw-output`. |
There was a problem hiding this comment.
Suggested change
| - `jq(value, jq_filter_string)`: run a [jq](https://stedolan.github.io/jq/manual/) style command on a json value. (Uses [jaq](https://crates.io/crates/jaq) internally). | |
| - `jq_raw(value, jq_filter_string)`: as above, but top-level strings will not be quoted, as with `jq --raw-output`. | |
| - `jq(value, jq_filter_string)`: run a [jq](https://jqlang.github.io/jq/manual/) style command on a json value. (Uses [jaq](https://crates.io/crates/jaq) internally). | |
| - `jqraw(value, jq_filter_string)`: acts as if `jq` was invoked with the `--raw-output` flag, removing quotation marks if the resulting value is a JSON string. See the [jq docs](https://jqlang.github.io/jq/manual/) for more information. |
point to the documentation here to make things easier for us
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is a fairly simple change which adds a
jq_rawfunction -jq_raw()sharesjq()'s implementation, with the difference being that top level strings are not quoted (nested strings are quoted). This behavior is consistent withjq's documented and observed behavior for --raw-output.This PR resolves #745.
For instance, we see the following behavior with orthodox
jqSimilarly, the expressions
Produce the following output,
Usage
Use
jq_rawas you wouldjqwhen unquoted strings are needed (typically for display)Checklist
Please make sure you can check all the boxes that apply to this PR.
docs/srcdirectory has been adjusted to reflect my changes.cargo fmtto automatically format all code before committing