te32
/
SublimePrettyJson
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #118 from dzhibas/st4 

Minor Changes: README, Newlines, json_loads
This commit is contained in:
Terminal 2020-04-26 15:17:23 -04:00 committed by GitHub
parent 5cd9d0b3a7 5220810676
commit b7801fe751
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 117 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
PrettyJson.py
View File

@ -50,10 +50,9 @@ class PrettyJsonBaseCommand:
bracket_newline = re.compile(r'^((\s*)".*?":)\s*([\[])', re.MULTILINE) bracket_newline = re.compile(r'^((\s*)".*?":)\s*([\[])', re.MULTILINE)
@staticmethod @staticmethod
def json_loads(selection: str, object_pairs_hook=None) -> dict: def json_loads(selection: str, object_pairs_hook=OrderedDict) -> dict:
hook = OrderedDict if object_pairs_hook is None else object_pairs_hook
return json.loads( return json.loads(
selection, object_pairs_hook=hook, parse_float=decimal.Decimal selection, object_pairs_hook=object_pairs_hook, parse_float=decimal.Decimal
) )
@staticmethod @staticmethod
@ -410,6 +409,7 @@ class JqQueryPrettyJson(sublime_plugin.WindowCommand):
PREVIOUS_CONTENT[0] = raw_json PREVIOUS_CONTENT[0] = raw_json
if PREVIOUS_CONTENT[1] == "": if PREVIOUS_CONTENT[1] == "":
PREVIOUS_CONTENT[1] = raw_json PREVIOUS_CONTENT[1] = raw_json
out, err = p.communicate(bytes(raw_json, "UTF-8")) out, err = p.communicate(bytes(raw_json, "UTF-8"))
output = out.decode("UTF-8").replace(os.linesep, "\n").strip() output = out.decode("UTF-8").replace(os.linesep, "\n").strip()
errors = err.decode("UTF-8").replace(os.linesep, "\n").strip() errors = err.decode("UTF-8").replace(os.linesep, "\n").strip()

174
README.md
View File

@ -1,12 +1,22 @@
[![Build Status](https://travis-ci.org/dzhibas/SublimePrettyJson.svg)](https://travis-ci.org/dzhibas/SublimePrettyJson) ![Pretty Json Tests](https://github.com/dzhibas/SublimePrettyJson/workflows/Pretty%20Json%20Tests/badge.svg?branch=master)
Prettify/Minify/Query/Goto/Validate/Lint JSON plugin for Sublime Text 2 & 3 Prettify/Minify/Query/Goto/Validate/Lint JSON plugin for Sublime Text 3 & 4
## Installation ## Installation
Install this sublime text 2/3 package via [Package Control](https://sublime.wbond.net) search for package: "[**Pretty JSON**](https://sublime.wbond.net/packages/Pretty%20JSON)" ### Package Control (Recommended)
### or manually install Install this sublime text 3/4 package via [Package Control][]
search for package: "[**Pretty JSON**][]"
### Manual Installation
**Sublime Text 4**
- `cd <Packages directory>` (for example on Mac it is `~/Library/Application\ Support/Sublime\ Text\ 2/Packages` or `~/Library/Application\ Support/Sublime\ Text\ 3/Packages`)
- `git clone https://github.com/dzhibas/SublimePrettyJson.git "Pretty JSON"`
**Sublime Text 3**
**Sublime Text 4** **Sublime Text 4**
@ -19,37 +29,58 @@ Install this sublime text 2/3 package via [Package Control](https://sublime.wbon
- `git clone https://github.com/dzhibas/SublimePrettyJson.git "Pretty JSON"` - `git clone https://github.com/dzhibas/SublimePrettyJson.git "Pretty JSON"`
- `git checkout st3` - `git checkout st3`
**Sublime Text 2**
No longer supported
## Usage ## Usage
To prettify JSON, make selection of json (or else it will try to use full view buffer) and press keys: To prettify JSON, make selection of json
(or else it will try to use full view buffer) and press keys:
- Linux: <kbd>ctrl+alt+j</kbd> - Linux: <kbd>ctrl+alt+j</kbd>
- Windows: <kbd>ctrl+alt+j</kbd> - Windows: <kbd>ctrl+alt+j</kbd>
- OS X: <kbd>cmd+ctrl+j</kbd> - OS X: <kbd>cmd+ctrl+j</kbd>
or through Command Palette <kbd>Ctrl+Shift+P</kbd> find "Pretty JSON: Format (Pretty Print) JSON" (you can search for part of it like 'pretty format') or through Command Palette <kbd>Ctrl+Shift+P</kbd>
find "Pretty JSON: Format JSON"
(you can search for part of it like 'pretty format')
If selection is empty and configuration entry **use_entire_file_if_no_selection** is true, tries to prettify whole file If selection is empty and configuration entry
**use_entire_file_if_no_selection** is true,
tries to prettify whole file
If JSON is not valid it will be displayed in status bar of Sublime Text If JSON is not valid it will be displayed in status bar of Sublime Text
### Validate JSON ### Validate JSON
Using Command Palette <kbd>Ctrl+Shift+P</kbd> find "Pretty JSON: Validate" (you can search for partial string 'validate') this will validate selection or full file and will show in dialog if it's valid or invalid. In case of found errors view will jump to error and will highlight it Using Command Palette <kbd>Ctrl+Shift+P</kbd> find "Pretty JSON: Validate"
(you can search for partial string 'validate')
this will validate selection or full file
and will show in dialog if it's valid or invalid.
In case of found errors view will jump to error and will highlight it
### Compress / Minify JSON ### Compress / Minify JSON
Using Command Palette <kbd>Ctrl+Shift+P</kbd> find "Pretty JSON: Minify (compress) JSON" (you can search for part of it like 'json minify') this will make selection or full buffer as single line JSON which later you can use in command lines (curl/httpie) or somewhere else... Using Command Palette <kbd>Ctrl+Shift+P</kbd>
find "Pretty JSON: Minify JSON"
(you can search for part of it like 'json minify')
this will make selection or full buffer as single line
JSON which later you can use in command lines (curl/httpie) or somewhere else...
To map a key combination like <kbd>Ctrl+Alt+M</kbd> to the Minify command, you can add a setting like this to your .sublime-keymap file (eg: `Packages/User/Default (Windows).sublime-keymap`): To map a key combination like <kbd>Ctrl+Alt+M</kbd> to the Minify command,
you can add a setting like this to your .sublime-keymap file
(eg: `Packages/User/Default (Windows).sublime-keymap`):
``` ```json
{ "keys": [ "ctrl+alt+m" ], "command": "un_pretty_json" } { "keys": [ "ctrl+alt+m" ], "command": "un_pretty_json" }
``` ```
### Convert JSON to XML ### Convert JSON to XML
Using Command Palette <kbd>Ctrl+Shift+P</kbd> search fo "Pretty JSON: JSON 2 XML" (you can search for part of it like '2XML') this will convert your selected JSON of full buffer to XML and replace syntax and buffer to XML output Using Command Palette <kbd>Ctrl+Shift+P</kbd> search for
"Pretty JSON: json2xml" (you can search for part of it like '2XML')
this will convert your selected JSON of full buffer to XML and
replace syntax and buffer to XML output
## ./jQ query/filter usage ## ./jQ query/filter usage
@ -57,7 +88,9 @@ Demo:
[![Demo](http://i.imgur.com/sw7Hrsp.gif?1)](http://i.imgur.com/sw7Hrsp.gif?1) [![Demo](http://i.imgur.com/sw7Hrsp.gif?1)](http://i.imgur.com/sw7Hrsp.gif?1)
If on your machine "[./jq](http://stedolan.github.io/jq/)" tool is available with <kdb>ctrl+atl+shift+j</kdb> you can run against your json. output will be opened in new view so you can once again apply jq on new buffer If on your machine "[./jq][]" tool is available with <kdb>ctrl+atl+shift+j</kdb>
you can run against your json.
output will be opened in new view so you can once again apply jq on new buffer
You can find instructions of tool here: You can find instructions of tool here:
@ -65,82 +98,103 @@ http://stedolan.github.io/jq/
## Default configuration ## Default configuration
**use_entire_file_if_no_selection** - true - `use_entire_file_if_no_selection`
- Default: `true`
**indent** - 2 - `indent`
- Default: `2`
- Integer represents amount of spaces
- `\t` will utilize a tab character
int used for how many spaces to use for indent, replace it with value "\t" and tabs will be used instead - `sort_keys`
- Default: `false`
**sort_keys** - false - `ensure_ascii`
- Default: `false`
**ensure_ascii** - false - `line_separator`
- ","
**line_separator** - "," - `value_separator`
- ": "
- Value separator in config,
so if you need to get rid of extra space you can remove it with this param
**value_separator** - ": " - `keep_arrays_single_line`
- Default: `false`
- If we need to re-structure arrays and make them single-line
value separator in config, so if you need to get rid of extra space you can remove it with this param - `max_arrays_line_length`
- Default: `120`
- If array for example '["a", "b", 123213, ....]'
length will reach max it will be kept multi-line
**keep_arrays_single_line** - false - `pretty_on_save`
- Default: `false`
- Do we need to automatically Pretty JSON on save
if we need to re-structure arrays and make them single-line - `validate_on_save`
- Default: `true`
- Do we need validate JSON files on each save
**max_arrays_line_length** - 120 - `reindent_block`
- Default: `false`
- If we are formatting a selection, if we need to reindent the
resulting block to follow the flow of the source document
the posible values are 'minimal' and 'start'
using `minimal`, the resulting json lines are indented as much
spaces as the line where the selection starts. e.g
if array for example '["a", "b", 123213, ....]' length will reach max it will be kept multi-line (for beauty) ```yaml
yaml_container:
**pretty_on_save** - false yaml_key: { "json": "value" }
```
do we need to automatically Pretty JSON on save
**validate_on_save** - true
do we need validate JSON files on each save
**reindent_block** - false
if we are formatting a selection, if we need to reindent the
resulting block to follow the flow of the source document
the posible values are 'minimal' and 'start'
using `minimal`, the resulting json lines are indented as much
spaces as the line where the selection starts. e.g
yaml_container:
yaml_key: { "json": "value" }
gets formatted as: gets formatted as:
yaml_container: ```yaml
yaml_key: { yaml_container:
"json": "value" yaml_key: {
} "json": "value"
}
```
using `start`, the resulting json lines are indented a number using `start`, the resulting json lines are indented a number
of spaces equal to the column number of the start of the selection of spaces equal to the column number of the start of the selection
with `start` the previous example gets formatted as: with `start` the previous example gets formatted as:
yaml_container: ```yaml
yaml_key: { yaml_container:
"json": "value" yaml_key: {
} "json": "value"
}
```
## Using tabs for indentation ## Using tabs for indentation
You can change configuration key **indent** to string value "\t" or any other string You can change configuration key **indent** to string value `"\t"` or any other string
``` ```json
"indent" : "\t", "indent" : "\t",
``` ```
Be sure "Indent Using Spaces" is unchecked otherwise you will not see effect and ST2/3 will convert it back to spaces Be sure `"Indent Using Spaces"` is unchecked otherwise you will not see
effect and ST3/4 will convert it back to spaces
## Thanks ## Contributors
- @the3rdhbtaylor https://github.com/the3rdhbtaylor <a href="https://github.com/dzhibas/SublimePrettyJson/graphs/contributors">
- @crcastle https://github.com/crcastle <img src="https://contributors-img.web.app/image?repo=dzhibas/SublimePrettyJson" />
</a>
## Others ## Others
If you YAMLing then maybe you interested in this plugin: https://github.com/aukaost/SublimePrettyYAML If you YAMLing then maybe you interested in this plugin: [PrettyYAML][]
[Package Control]: https://packagecontrol.io
[**Pretty JSON**]: https://packagecontrol.io/packages/Pretty%20JSON
[PrettyYAML]: https://github.com/aukaost/SublimePrettyYAML
[./jq]: http://stedolan.github.io/jq/