From 4add4300a72de0edb5064d39296c044b6b5a5e92 Mon Sep 17 00:00:00 2001 From: TheSecEng Date: Fri, 24 Apr 2020 12:20:11 -0400 Subject: [PATCH 1/3] update: README.md --- README.md | 168 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 107 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index d7edd1e..60f5b62 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,70 @@ -[![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 -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)" +Install this sublime text 3/4 package via [Package Control][] +search for package: "[**Pretty JSON**][]" ### or manually install -- `cd ` (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` +- `cd ` + (for example on Mac it is + `~/Library/Application\ Support/Sublime\ Text\ 3/Packages` + or + `~/Library Application\ Support/Sublime\ Text/Packages`) +- `git clone https://github.com/dzhibas/SublimePrettyJson.git "Pretty JSON"` ## 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: ctrl+alt+j - Windows: ctrl+alt+j - OS X: cmd+ctrl+j -or through Command Palette Ctrl+Shift+P find "Pretty JSON: Format (Pretty Print) JSON" (you can search for part of it like 'pretty format') +or through Command Palette Ctrl+Shift+P +find "Pretty JSON: Format (Pretty Print) 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 ### Validate JSON -Using Command Palette Ctrl+Shift+P 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 Ctrl+Shift+P 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 -Using Command Palette Ctrl+Shift+P 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 Ctrl+Shift+P +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... -To map a key combination like Ctrl+Alt+M 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 Ctrl+Alt+M 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" } ``` ### Convert JSON to XML -Using Command Palette Ctrl+Shift+P 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 Ctrl+Shift+P search for +"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 ## ./jQ query/filter usage @@ -49,7 +72,9 @@ Demo: [![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 ctrl+atl+shift+j 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 ctrl+atl+shift+j +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: @@ -57,82 +82,103 @@ http://stedolan.github.io/jq/ ## 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) - -**pretty_on_save** - false - - 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" } + ```yaml + yaml_container: + yaml_key: { "json": "value" } + ``` gets formatted as: - yaml_container: - yaml_key: { - "json": "value" - } + ```yaml + yaml_container: + yaml_key: { + "json": "value" + } + ``` using `start`, the resulting json lines are indented a number of spaces equal to the column number of the start of the selection with `start` the previous example gets formatted as: - yaml_container: - yaml_key: { - "json": "value" - } + ```yaml + yaml_container: + yaml_key: { + "json": "value" + } + ``` ## 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", ``` -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 -- @crcastle https://github.com/crcastle + + + ## 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/ \ No newline at end of file From 667cacbbc9ef25820e3c861480b5125e83c631b6 Mon Sep 17 00:00:00 2001 From: TheSecEng Date: Sun, 26 Apr 2020 15:07:14 -0400 Subject: [PATCH 2/3] fix: minor changes fix: README.md fix: default value of `object_pairs_hook` --- PrettyJson.py | 5 ++--- README.md | 27 ++++++++++++++++++--------- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/PrettyJson.py b/PrettyJson.py index c3561ec..d7d2ae5 100644 --- a/PrettyJson.py +++ b/PrettyJson.py @@ -50,10 +50,9 @@ class PrettyJsonBaseCommand: bracket_newline = re.compile(r'^((\s*)".*?":)\s*([\[])', re.MULTILINE) @staticmethod - def json_loads(selection: str, object_pairs_hook=None) -> dict: - hook = OrderedDict if object_pairs_hook is None else object_pairs_hook + def json_loads(selection: str, object_pairs_hook=OrderedDict) -> dict: return json.loads( - selection, object_pairs_hook=hook, parse_float=decimal.Decimal + selection, object_pairs_hook=object_pairs_hook, parse_float=decimal.Decimal ) @staticmethod diff --git a/README.md b/README.md index 60f5b62..6336667 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,27 @@ Prettify/Minify/Query/Goto/Validate/Lint JSON plugin for Sublime Text 3 & 4 ## Installation +### Package Control (Recommended) + Install this sublime text 3/4 package via [Package Control][] search for package: "[**Pretty JSON**][]" -### or manually install +### Manual Installation -- `cd ` - (for example on Mac it is - `~/Library/Application\ Support/Sublime\ Text\ 3/Packages` - or - `~/Library Application\ Support/Sublime\ Text/Packages`) +**Sublime Text 4** + +- `cd ` (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** + +- `cd ` (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"` +- `git checkout st3` + +**Sublime Text 2** +No longer supported + ## Usage To prettify JSON, make selection of json @@ -26,7 +35,7 @@ To prettify JSON, make selection of json - OS X: cmd+ctrl+j or through Command Palette Ctrl+Shift+P -find "Pretty JSON: Format (Pretty Print) JSON" +find "Pretty JSON: Format JSON" (you can search for part of it like 'pretty format') If selection is empty and configuration entry @@ -46,7 +55,7 @@ In case of found errors view will jump to error and will highlight it ### Compress / Minify JSON Using Command Palette Ctrl+Shift+P -find "Pretty JSON: Minify (compress) JSON" +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... @@ -62,7 +71,7 @@ you can add a setting like this to your .sublime-keymap file ### Convert JSON to XML Using Command Palette Ctrl+Shift+P search for -"Pretty JSON: JSON 2 XML" (you can search for part of it like '2XML') +"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 From 52208106768481d1bd64f095ef80ed8eebfe4551 Mon Sep 17 00:00:00 2001 From: TheSecEng Date: Sun, 26 Apr 2020 15:10:50 -0400 Subject: [PATCH 3/3] newline isssue --- PrettyJson.py | 1 + 1 file changed, 1 insertion(+) diff --git a/PrettyJson.py b/PrettyJson.py index d7d2ae5..724b3cd 100644 --- a/PrettyJson.py +++ b/PrettyJson.py @@ -409,6 +409,7 @@ class JqQueryPrettyJson(sublime_plugin.WindowCommand): PREVIOUS_CONTENT[0] = raw_json if PREVIOUS_CONTENT[1] == "": PREVIOUS_CONTENT[1] = raw_json + out, err = p.communicate(bytes(raw_json, "UTF-8")) output = out.decode("UTF-8").replace(os.linesep, "\n").strip() errors = err.decode("UTF-8").replace(os.linesep, "\n").strip()