From e3e80b98b575ab75b9c7d182184faffc0b51c5f9 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Sun, 15 Sep 2024 15:14:38 +0200 Subject: chore(jsontools): change link to NDJSON spec (#12671) Fixes #12671 --- plugins/jsontools/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins/jsontools/README.md') diff --git a/plugins/jsontools/README.md b/plugins/jsontools/README.md index 6a2740014..d92608806 100644 --- a/plugins/jsontools/README.md +++ b/plugins/jsontools/README.md @@ -19,7 +19,7 @@ Usage is simple... just take your json data and pipe it into the appropriate jso ### Supports NDJSON (Newline Delimited JSON) -The plugin also supports [NDJSON](http://ndjson.org/) input, which means all functions +The plugin also supports [NDJSON](https://github.com/ndjson/ndjson-spec) input, which means all functions have an alternative function that reads and processes the input line by line. These functions have the same name except using `ndjson` instead of `json`: -- cgit v1.2.3-70-g09d2 From 45516ca1d830fd21f75942bf414d540db1ab0db2 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Sun, 27 Oct 2024 15:13:05 +0100 Subject: docs(jsontools): document requirements Fixes #10834 --- plugins/jsontools/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'plugins/jsontools/README.md') diff --git a/plugins/jsontools/README.md b/plugins/jsontools/README.md index d92608806..804edba40 100644 --- a/plugins/jsontools/README.md +++ b/plugins/jsontools/README.md @@ -8,6 +8,17 @@ To use it, add `jsontools` to the plugins array in your zshrc file: plugins=(... jsontools) ``` +## Requirements + +The plugin uses one of these tools to process JSON data, in the following order: + +- `node` +- `python3` +- `ruby` + +Any of these must be in `$PATH` before the plugin is loaded, otherwise the plugin exits +prematurely and the functions will not be available. + ## Usage Usage is simple... just take your json data and pipe it into the appropriate jsontool: -- cgit v1.2.3-70-g09d2