buf
buf copied to clipboard
bufbuild
IntelliJ IDEA integration
What kind of integration are we talking about here? I would love to work on it
I think we can build over https://plugins.jetbrains.com/plugin/14004-protocol-buffers/
Big things that would be helpful from this:
- Buf lint integration
- Buf breaking integration
- Option to auto-generate on save
I will be happy to see a general solution for external tools for editing .proto files, these tools (like IDEA) know nothing about buf dependencies (like googleapis), so .proto files with such includes are incorrect from their point of view, also go to the definition doesn't work either
@nordicdyno I agree with you that there are lots of ways a Buf plugin could improve on the proto editing experience, but you might have a slightly better time if you use the HIGAN protobuf plugin rather than the bundled one.
Also, both plugins allow you to specify additional folders where they should look for protos. If you point them at the a local copy of grpc/etc, you should be able to get rid of the import errors. It will still dumbly assume that they're included even if they're not, but it's better than it just showing errors all the time.
A better story around IDE integration (including IntelliJ) is on our roadmap, but it's not our primary focus right now.
Like the roadmap describes, we're very interested in LSP since it would give us a solution for so many editors without needing to tailor a solution to each editor independently (like vim-buf and vscode-buf).
I don't have much familiarity with IntelliJ, but it looks like IntelliJ doesn't support LSP.
We'll eventually develop a solution that will work for our IntelliJ users (regardless of LSP support), but we don't have a timeline for this just yet.
One very simple workaround is to just add buf's cache directories as extra search paths:
Thanks @leoluk, more docs on the module cache can be found here. I should have also mentioned that you can set up buf lint to run on a save with a couple configurations described here.
One very simple workaround is to just add buf's cache directories as extra search paths:
I've thought about it. I think it would be handy if buf had some command which prints all cache paths for a lock file, so it would be easy just copy&paste them.
So, I've solved my problem by just putting googleapi's files which are used as includes into third-party directory, which is not in build/roots list. I suppose that in a new 1.x buf version I will be forced to use excludes option because roots have been removed.
Hello folks, I am happy to inform you that the first version of Buf integration for JetBrains IDEs has been released (community support).
There are some highlight features for Buf:
- Code completion and documentation for buf configuration files (only for v1).
- Auto config protobuf import roots from buf.yaml and buf.work.yaml, it support locked deps and workspace local module.
- Execute buf command like buf build , buf mod update and view the module deps tree in Buf Tool Window.
- Code annotator by buf lint.
Explore more editing features of protobuf:
- Smarter import management, auto import and import optimization.
- Smarter import path management, auto config from libraries.
- Protobuf decompile for golang.
- Import fix suggestion.
Search and install protobuf in plugin page or download it from JetBrains Marketplace.
If you feel usable for this plugin, you can comment and rating it, share it to your workmate. If you have trouble using this plugin, feel free to create Github Issue.
We're going to be releasing bufbuild/intellij-buf in the next week or so as well.