ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Pretty Protobuf

by hanfezh ST4

Plugin to prettify Protobuf message debug string for Sublime Text 4

Labels pretty, format, protobuf, debug

Details

Installs

  • Total 2K
  • Win 609
  • Mac 1K
  • Linux 170
Mar 31 Mar 30 Mar 29 Mar 28 Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9 Mar 8 Mar 7 Mar 6 Mar 5 Mar 4 Mar 3 Mar 2 Mar 1 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14
Windows 0 0 1 0 0 2 2 0 0 0 0 1 0 0 0 0 0 0 2 0 0 0 0 1 2 1 1 0 1 0 1 0 0 1 1 0 0 0 0 0 0 1 0 0 0 0
Mac 0 0 0 0 0 0 1 3 0 0 0 0 0 2 1 0 0 1 1 0 2 1 0 0 0 0 2 1 1 0 1 0 0 0 0 1 0 1 1 0 1 2 1 1 0 2
Linux 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 1

Readme

Source
raw.​githubusercontent.​com

Pretty Protobuf

It is a plugin for Sublime Text 4, used to prettify the debug string of Protobuf messages.

Use Python Lex-Yacc to parse the debug string.

Installation

Install “Pretty Protobuf” via Package Control.

Or manually, take macOS as an example:

# Go to the packages directory of Sublime Text
# Sublime Text -> Preferences -> Browse Packages...
cd $HOME/Library/Application\ Support/Sublime\ Text/Packages
git clone https://github.com/hanfezh/pretty-protobuf.git Pretty\ Protobuf

Usage

To prettify proto's debug string, select message's debug string and run command “Pretty Protobuf: Format Message Debug String” through Command Palette Command+Shift+P (macOS). If no selection, the entire file is used by default.

To map a key combination like Ctrl+Shift+J to the Minify command, you can add a setting like this to your .sublime-keymap file (eg: Packages/User/Default (OSX).sublime-keymap):

[
    {
        "keys": [
            "ctrl+shift+j"
        ],
        "command": "pretty_debug_string"
    }
]

Demo of Pretty Protobuf Debug String

To prettify Protobuf, execute command “Pretty Protobuf: Format Protobuf”:

Configuration

Default settings for prettifying message debug string:

  • indent: 4 spaces
  • sort_keys: false, set true to sort keys
  • use_entire_file_if_no_selection: true
  • clang_format_path: clang-format, change to canonical path, such as /usr/local/bin/clang-format
{
    "indent": 4,
    "sort_keys": false,
    "use_entire_file_if_no_selection": true,
    "clang_format_path": "clang-format"
}