Skip to content

Commit

Permalink
Update project metadata and docs for v0.6 release
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasebsmith committed Jul 21, 2020
1 parent 170b07a commit 8f346d0
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,8 @@
## 0.5.0 - Released 2020-07-15
- Detailed documentation available at
https://thomasebsmith.github.io/json-quick.

## 0.6.0 - Released 2020-07-20
- Selection syntax
- "Select" command allows selection of a subset of JSON input based on
property names, indices, and more.
18 changes: 18 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ for more detailed instructions.
the following commands are available:
- [`help`](#help-command) - Displays usage and version information.
- [`prettify`](#prettify-command) - Pretty-prints any JSON given as input.
- [`select`](#select-command) - Selects a subset of JSON given as input.
- [`verify`](#verify-command) - Verifies that and JSON given as input is
specification-conformant.

Expand All @@ -36,9 +37,26 @@ Pretty-prints any JSON given as input. Currently, this command always indents
with two spaces. However, options to customize indentation will be available
in the future.

## Select Command
Selects a subset of the JSON that is given as input. Uses
[selection syntax](#selection-syntax) for patterns.

Options:
- `--pattern <pattern>`, `-p <pattern>`: Selects using *<pattern>*. If no
pattern is specified, the entire JSON object is selected.

## Verify Command
Ensures that its input is valid JSON (conformant to the official specification).
Returns with a zero exit code and prints "Valid JSON" to output if the JSON
is valid.
Returns with a non-zero exit code and prints an error to stderr if the JSON
is not valid.

## Selection Syntax
To select part of a JSON object, you can use dot-separated parts. Each part
can be a double-quoted property name, a non-quoted property name, or an
asterisk, which matches all property names.

For example, the syntax `my_property."a.key".0"` would select an object's
`my_property` property, then the `a.key` property of that object, and finally
the first element of that array.
2 changes: 1 addition & 1 deletion json-quick.cabal
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
cabal-version: 2.4

name: json-quick
version: 0.5.0.0
version: 0.6.0.0
synopsis: A fast command-line utility for dealing with JSON
homepage: https://github.com/thomasebsmith/json-quick
bug-reports: https://github.com/thomasebsmith/json-quick/issues
Expand Down

0 comments on commit 8f346d0

Please sign in to comment.