https://github.com/yoheimuta/intellij-protolint
A protobuf linter for JetBrains IDEs
https://github.com/yoheimuta/intellij-protolint
intellij-plugin jetbrains-plugin linter-plugin protobuf
Last synced: 9 months ago
JSON representation
A protobuf linter for JetBrains IDEs
- Host: GitHub
- URL: https://github.com/yoheimuta/intellij-protolint
- Owner: yoheimuta
- Created: 2019-06-19T12:03:53.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-07T03:53:38.000Z (almost 5 years ago)
- Last Synced: 2025-06-17T23:05:07.601Z (12 months ago)
- Topics: intellij-plugin, jetbrains-plugin, linter-plugin, protobuf
- Language: Java
- Homepage: https://plugins.jetbrains.com/plugin/12641
- Size: 127 KB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Protobuf Lint Support for JetBrains IDEs
[](https://travis-ci.org/yoheimuta/intellij-protolint)
[Protocol Buffer Linter Plugin](https://plugins.jetbrains.com/plugin/12641-protocol-buffer-linter) 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 Version | IDE Version Range |
|-----------------|--------------------|
| 1.0.1 | IDEA 2021.2 |
| 1.0.0 | IDEA 2020.1 |
| 0.1.0 | IDEA 2018.3 |
### Example
Using the following `.protolint.yaml` configuration file.
```yaml
lint:
rules:
no_default: true
add:
- MESSAGE_NAMES_UPPER_CAMEL_CASE
- SERVICE_NAMES_UPPER_CAMEL_CASE
```
### Installation
You can install the plugin by opening "Plugins" settings, "Marketplace" - search for "Protocol Buffer Linter".
#### Dependencies
- [protolint](https://github.com/yoheimuta/protolint) must be installed.
- [Protocol Buffers plugin](https://plugins.jetbrains.com/plugin/14004-protocol-buffer-editor) must be installed.
### 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
```