Add new client for Buf/Protocol Buffers (#4580)

* lsp-buf: add new client for protocol buffers using buf CLI

* docs: add new entry for protocol buffers

* Update CHANGELOG

* lsp-buf: change priorities

Author: suzuki

CHANGELOG.org

@@ -20,6 +20,7 @@
   * If asm-lsp is installed, lsp-asm won't try to download it to cache store
   * Fix lsp-unzip on windows when unzip was found on the PATH
   * Fix zls wrong bin path
+  * Add support for buf CLI ([[https://github.com/bufbuild/buf/releases/tag/v1.43.0][beta]])
 
 ** 9.0.0
   * Add language server config for QML (Qt Modeling Language) using qmlls.

clients/lsp-bufls.el

@@ -31,8 +31,9 @@
 (require 'lsp-mode)
 (require 'lsp-go)
 
+;; Buf Language Server
 (defgroup lsp-bufls nil
-  "Configuration options for lsp-bufls."
+  "Configuration options for Buf Language Server."
   :group 'lsp-mode
   :link '(url-lint "https://github.com/bufbuild/buf-language-server")
   :package-version '(lsp-mode . "9.0.0"))
@@ -60,9 +61,44 @@
                                    #'lsp-bufls-server--stdio-command)
                   :activation-fn (lsp-activate-on "protobuf")
                   :language-id "protobuf"
-                  :priority 0
+                  :priority -1
                   :server-id 'bufls))
 
+;; Buf CLI
+(defgroup lsp-buf nil
+  "Configuration options for buf CLI."
+  :group 'lsp-mode
+  :link '(url-lint "https://github.com/bufbuild/buf")
+  :package-version '(lsp-mode . "9.0.0"))
+
+(defcustom lsp-buf-args `("beta" "lsp")
+  "Arguments to pass to buf CLI."
+  :type '(repeat string)
+  :group 'lsp-buf
+  :package-version '(lsp-mode . "9.0.0"))
+
+(defcustom lsp-buf-path "buf"
+  "Command to run buf CLI."
+  :type 'string
+  :group 'lsp-buf
+  :package-version '(lsp-mode . "9.0.0"))
+
+(defun lsp-buf--stdio-command ()
+  "Return the command and args to start buf CLI LSP server."
+  (let ((args (list lsp-buf-path)))
+    (when (and (listp lsp-buf-args)
+               (> (length lsp-buf-args) 0))
+      (setq args (append args lsp-buf-args)))
+    args))
+
+(lsp-register-client
+ (make-lsp-client :new-connection (lsp-stdio-connection
+                                   #'lsp-buf--stdio-command)
+                  :activation-fn (lsp-activate-on "protobuf")
+                  :language-id "protobuf"
+                  :priority 0
+                  :server-id 'buf))
+
 (lsp-consistency-check lsp-bufls)
 
 (provide 'lsp-bufls)

docs/lsp-clients.json

@@ -89,6 +89,15 @@
     "lsp-install-server": "beancount-ls",
     "debugger": "Not available"
   },
+  {
+    "name": "buf",
+    "full-name": "buf CLI (Beta)",
+    "server-name": "buf",
+    "server-url": "https://github.com/bufbuild/buf",
+    "installation": "npm install -g @bufbuild/buf",
+    "installation-url": "https://buf.build/docs/installation",
+    "debugger": "Not available"
+  },
   {
     "name": "bufls",
     "full-name": "buf-language-server",

mkdocs.yml

@@ -55,7 +55,8 @@ nav:
     - AWK: page/lsp-awk.md
     - Bash: page/lsp-bash.md
     - Beancount: page/lsp-beancount.md
-    - Buf/Protocol Buffers: page/lsp-bufls.md
+    - Buf/Protocol Buffers (Buf CLI): page/lsp-buf.md
+    - Buf/Protocol Buffers (Buf Language Server): page/lsp-bufls.md
     - Camel: page/lsp-camel.md
     - C++ (ccls): page/lsp-ccls.md
     - C++ (clangd): page/lsp-clangd.md