Home

Awesome

Protobuf Lint Support for JetBrains IDEs

Build Status

Protocol Buffer Linter Plugin for IntelliJ IDEA & other JetBrains products.

The latest plugin release is compatible with IntelliJ IDEA 2021.2. Other JetBrains IDEs of the same or higher version should be supported as well.

Compatibility Matrix:

Plugin VersionIDE Version Range
1.0.1IDEA 2021.2
1.0.0IDEA 2020.1
0.1.0IDEA 2018.3

Example

Using the following .protolint.yaml configuration file.

lint:
  rules:
    no_default: true

    add:
      - MESSAGE_NAMES_UPPER_CAMEL_CASE
      - SERVICE_NAMES_UPPER_CAMEL_CASE

demo

Installation

You can install the plugin by opening "Plugins" settings, "Marketplace" - search for "Protocol Buffer Linter".

Dependencies

Configuration

The plugin does not require configuration by default, for the majority of projects it should work out of the box.

Path

The plugin refers to the protolint executable in your PATH by default. You can configure the path to the protolint executable and its config directory through Preferences -> Tools -> Protocol Buffer Linter.

Development

Build

./gradlew build

Run IntelliJ IDEA with enabled plugin

./gradlew runide