python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-09 01:05:53 +02:00
Code Issues Releases Activity

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2023-01-08 10:55:48 -08:00
parent bf88407902
commit 32521ac91a
7 changed files with 33 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
CHANGELOG
View File

@ -1,12 +1,14 @@
jc changelog jc changelog
20230105 v1.22.5 20230105 v1.22.5
- Add TOML parser - Add TOML file parser
- Add AIX support for the `arp` command parser
- Add AIX support for the `mount` command parser - Add AIX support for the `mount` command parser
- Fix `lsusb` parser when extra hub port status information is output - Fix `lsusb` command parser when extra hub port status information is output
- Refactor `lsusb` parser for more code reuse - Refactor `lsusb` command parser for more code reuse
- Fix INI parser to include top-level values with no section header - Fix INI file parser to include top-level values with no section header
- Fix INI and Key/Value parsers to only remove one quotation mark from the - Fix INI file parser to not specially handle the [DEFAULT] section
- Fix INI file and Key/Value parsers to only remove one quotation mark from the
beginning and end of values. beginning and end of values.
- Update copyright dates - Update copyright dates

16
EXAMPLES.md
View File

@ -1636,21 +1636,21 @@ cat example.ini | jc --ini -p
``` ```
```json ```json
{ {
"bitbucket.org": { "DEFAULT": {
"ServeraLiveInterval": "45", "ServerAliveInterval": "45",
"Compression": "yes", "Compression": "yes",
"CompressionLevel": "9", "CompressionLevel": "9",
"ForwardX11": "yes", "ForwardX11": "yes"
},
"bitbucket.org": {
"User": "hg" "User": "hg"
}, },
"topsecret.server.com": { "topsecret.server.com": {
"ServeraLiveInterval": "45", "Port": "50022",
"Compression": "yes", "ForwardX11": "no"
"CompressionLevel": "9",
"ForwardX11": "no",
"Port": "50022"
} }
} }
``` ```
### iostat ### iostat
```bash ```bash

16
README.md
View File

@ -775,21 +775,21 @@ cat example.ini | jc -p --ini
``` ```
```json ```json
{ {
"bitbucket.org": { "DEFAULT": {
"ServeraLiveInterval": "45", "ServerAliveInterval": "45",
"Compression": "yes", "Compression": "yes",
"CompressionLevel": "9", "CompressionLevel": "9",
"ForwardX11": "yes", "ForwardX11": "yes"
},
"bitbucket.org": {
"User": "hg" "User": "hg"
}, },
"topsecret.server.com": { "topsecret.server.com": {
"ServeraLiveInterval": "45", "Port": "50022",
"Compression": "yes", "ForwardX11": "no"
"CompressionLevel": "9",
"ForwardX11": "no",
"Port": "50022"
} }
} }
``` ```
### ls ### ls
```bash ```bash

5
docs/parsers/ini.md
View File

@ -11,11 +11,6 @@ Parses standard `INI` files.
- Comment prefix can be `#` or `;`. Comments must be on their own line. - Comment prefix can be `#` or `;`. Comments must be on their own line.
- If duplicate keys are found, only the last value will be used. - If duplicate keys are found, only the last value will be used.
> Note: The section identifier `[DEFAULT]` is special and provides default
> values for the section keys that follow. To disable this behavior you must
> rename the `[DEFAULT]` section identifier to something else before
> parsing.
> Note: Values starting and ending with double or single quotation marks > Note: Values starting and ending with double or single quotation marks
> will have the marks removed. If you would like to keep the quotation > will have the marks removed. If you would like to keep the quotation
> marks, use the `-r` command-line argument or the `raw=True` argument in > marks, use the `-r` command-line argument or the `raw=True` argument in

1
docs/parsers/kv.md
View File

@ -41,6 +41,7 @@ Examples:
name = John Doe name = John Doe
address=555 California Drive address=555 California Drive
age: 34 age: 34
; comments can include # or ; ; comments can include # or ;
# delimiter can be = or : # delimiter can be = or :
# quoted values have quotation marks stripped by default # quoted values have quotation marks stripped by default

2
man/jc.1
View File

@ -1,4 +1,4 @@
.TH jc 1 2023-01-06 1.22.5 "JSON Convert" .TH jc 1 2023-01-08 1.22.5 "JSON Convert"
.SH NAME .SH NAME
\fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, and strings \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, and strings
.SH SYNOPSIS .SH SYNOPSIS

16
templates/readme_template
View File

@ -640,21 +640,21 @@ cat example.ini | jc -p --ini
``` ```
```json ```json
{ {
"bitbucket.org": { "DEFAULT": {
"ServeraLiveInterval": "45", "ServerAliveInterval": "45",
"Compression": "yes", "Compression": "yes",
"CompressionLevel": "9", "CompressionLevel": "9",
"ForwardX11": "yes", "ForwardX11": "yes"
},
"bitbucket.org": {
"User": "hg" "User": "hg"
}, },
"topsecret.server.com": { "topsecret.server.com": {
"ServeraLiveInterval": "45", "Port": "50022",
"Compression": "yes", "ForwardX11": "no"
"CompressionLevel": "9",
"ForwardX11": "no",
"Port": "50022"
} }
} }
``` ```
### ls ### ls
```bash ```bash