/protobuf-jetbrains-plugin

Protobuf Support for JetBrains IDEs

Primary LanguageJavaApache License 2.0Apache-2.0

Protobuf Support for JetBrains IDEs

Join the chat at https://gitter.im/protostuff/protobuf-jetbrains-plugin

Protobuf Support Plugin for IntelliJ IDEA & other JetBrains products.

Latest plugin release is compatible with IntelliJ IDEA 2017.1 (older releases are compatible with IDEA 13+). Other JetBrains IDEs of the same or higher version should be supported as well.

Compatibility Matrix:

Plugin Version IDE Version Range
0.9.0 IDEA 2017.1+
0.8.0 IDEA 2016.1+
0.6.0 IDEA 13 - IDEA 15

Installation

IntelliJ IDEA should suggest you to install plugin automatically when you open .proto file. You can install plugin manually by opening "Plugins" settings, "Browse repositories..." - search for "Protobuf Support".

Plugin page: https://plugins.jetbrains.com/plugin/8277-protobuf-support

Configuration

The plugin does not require any further configuration. Imports for your own proto files do not work immediatly, you will see a 'File not found' notification. Each proto file which is supposed to be used in an import must be located in a source directory.

For gradle you can do it like this:

idea {
    module {
        sourceDirs += file("${projectDir}/src/main/proto")
    }
}

Roadmap

https://github.com/protostuff/protobuf-jetbrains-plugin/wiki/Roadmap

Build

Run following command in the shell:

./gradlew build

It should be possible to run build on any platform (Linux, Windows, MacOS) where Gradle is supported.

JDK 8 must be installed and available on PATH in order to build plugin.

Run IntelliJ IDEA with enabled plugin (for development)

./gradlew runIdea

Screenshots

image