Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ksprojects/protobuf-jetbrains-plugin
Protobuf Support for JetBrains IDEs
https://github.com/ksprojects/protobuf-jetbrains-plugin
intellij jetbrains-plugin protobuf
Last synced: about 1 month ago
JSON representation
Protobuf Support for JetBrains IDEs
- Host: GitHub
- URL: https://github.com/ksprojects/protobuf-jetbrains-plugin
- Owner: ksprojects
- License: apache-2.0
- Created: 2016-03-26T15:46:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-20T10:08:07.000Z (over 4 years ago)
- Last Synced: 2024-09-27T05:22:22.118Z (about 2 months ago)
- Topics: intellij, jetbrains-plugin, protobuf
- Language: Java
- Homepage: https://plugins.jetbrains.com/plugin/8277
- Size: 729 KB
- Stars: 259
- Watchers: 12
- Forks: 46
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Protobuf Support for JetBrains IDEs
[](https://gitter.im/protostuff/protobuf-jetbrains-plugin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[Protobuf Support Plugin](https://plugins.jetbrains.com/plugin/8277) for IntelliJ IDEA & other JetBrains products.
## THIS PLUGIN IS NOT SUPPORTED SINCE 2019
PLEASE SWITCH TO https://github.com/jvolkman/intellij-protobuf-editor
## Releases
Latest plugin release is compatible with IntelliJ IDEA 2018.2 (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.11.0 | IDEA 2018.2 |
| 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 configuration by default, for majority of projects it should work out of the box.
#### Imports
If you see 'File not found' error mark for the import statement, it means plugin cannot resolve target file within current set of source (or resource) roots.
In order to fix it, you should tell to plugin where is the "sources root" for your proto files.
There are a couple ways of doing that:
1. Mark directory as a source/resources root (right click on folder in project structure, "Mark forlder as...."):
2. Configure directory as source/resources folder in `maven`/`gradle` or other build system (if IDEA has support for that build system).
For gradle you can do it like this:
```gradle
idea {
module {
sourceDirs += file("${projectDir}/src/main/proto")
}
}
```
for maven, you can add as a resource directory:
```xml
4.0.0
groupId
artifactId
1.0.0-SNAPSHOT
...
src/main/proto
```
3. You can go to plugin settings, and add source roots there (this is also useful for external imports):
### 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](https://gradle.org/) 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
## For the sake of history
