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

Sublime​Linter-contrib-protoc-gen-lint

by ckaznocha ST3

SublimeLinter plugin for Protocol Buffers, using protoc-gen-lint.

Details

Installs

  • Total 1K
  • Win 955
  • OS X 336
  • Linux 79
Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1
Windows 0 0 1 2 2 0 1 1 0 0 2 2 5 4 0 1 3 2 2 3 0 0 0 1 2 0 1 0 1 0 1 1 1 2 0 0 0 0 0 1 0 1 0 1 1 2
OS X 0 0 0 1 1 0 1 2 0 0 1 0 0 1 0 0 0 1 0 3 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 1 0 2 0 0 0 2 0
Linux 0 0 0 0 0 0 0 0 0 0 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 1

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-protoc-gen-lint

Build Status

This linter plugin for SublimeLinter provides an interface to protoc-gen-lint. It will be used with files that have the “Protocol Buffer” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that protoc-gen-lint is installed on your system. To install protoc-gen-lint, do the following:

  1. Install sublime-protobuf-syntax

  2. Install protoc-gen-lint by following the instructions in the README

Note: I've had issues with sublime text finding the path when using the go get install method. Downloading the protoc-gen-lint binary for your system and manually adding it to your PATH is recommended.

Linter configuration

In order for protoc-gen-lint to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured protoc-gen-lint, you can proceed to install the SublimeLinter-contrib-protoc-gen-lint plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type protoc-gen-lint. Among the entries you should see SublimeLinter-contrib-protoc-gen-lint. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!