Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryncsn/poorjson.sh
A tiny and POSIX compatible JSON parser and query tool, written in pure POSIX Shell, within 60 lines of codes, only requires `sed`. Compatible with bash, dash, zsh, busybox and any other POSIX shell.
https://github.com/ryncsn/poorjson.sh
bash busybox json json-parser posix shell shellscript
Last synced: 28 days ago
JSON representation
A tiny and POSIX compatible JSON parser and query tool, written in pure POSIX Shell, within 60 lines of codes, only requires `sed`. Compatible with bash, dash, zsh, busybox and any other POSIX shell.
- Host: GitHub
- URL: https://github.com/ryncsn/poorjson.sh
- Owner: ryncsn
- License: gpl-3.0
- Created: 2021-10-26T19:29:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T17:54:37.000Z (7 months ago)
- Last Synced: 2024-04-07T18:43:08.359Z (7 months ago)
- Topics: bash, busybox, json, json-parser, posix, shell, shellscript
- Language: Shell
- Homepage:
- Size: 38.1 KB
- Stars: 76
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# poorjson.sh
A minimal POSIX compatible JSON parser and query tool written in pure 60 lines of POSIX Shell code.
The goal is to be POSIX compatible, lightweight, and fast. Only requires `sed`.
## Usage:
```
# Just pipe JSON to it, and use parameters to query:
# (Note strings are quoted with "")
echo '{"key": ["ele1", "ele2", "ele3", "ele4"]}' | ./poorjson.sh '"key"' 2
# Prints:
"ele3"
# If output is array or object, it's printed a token per line
echo '{"top-key": {"key1": [ "value1", "value2"], "key2": "value2"} }' | ./poorjson.sh '"top-key"' '"key1"'
# Prints:
[
"value1"
,
"value2"
]
# Use \* to match anything, multilevel matching is supported:
echo '{"key0": {"key1": ["ele1-1", "ele1-2"], "key2": ["ele2-1", "ele2-2"]}}' | ./poorjson.sh '"key0"' \* 1
# Prints:
"ele1-1"
"ele2-1"
# poorjson.sh prints the whole JSON one token per line if no param is given:
echo '{"key0": [{"key1": "val1"}]}' | ./poorjson.sh
# Prints:
{
"key0"
:
[
{
"key1"
:
"val1"
}
]
}
# poorjson.sh prints basic error message for invalid JSON
# To simply check if a JSON string is valid:
echo '{"key": "val"}' | ./poorjson.sh - && echo "valid" || echo "invalid"
# Prints:
valid
echo '{"key":: "val"}' | ./poorjson.sh - && echo "valid" || echo "invalid"
# Prints:
Unexpected token: ":"
invalid
echo '' | ./poorjson.sh - && echo "valid" || echo "invalid"
# Prints:
Unexpected EOF after: ""
invalid
```
## Known issues
- If the same key appears multiple times in an object, poorjson.sh will simply parse them repeatedly.
- Due to the function call depths limit in Shell, JSON with thousands of levels of embedment can't be processed by poorjson.sh. But except that, it should be good enough for most common usage.
## Test and comparison
Test result with [JSONTestSuite](https://github.com/nst/JSONTestSuite.git):
