feat: Add a solidity language server (#4208)

* feat: Add a solidity language server

* feat(lsp-solidity): Provide a way to download automatically the server

Following the example of bash-lsp.

Also, don't confuse the user by telling about alternative
implementations, while this package was mostly tested with the
implementation of nomicfoundation.

Author: Konubinix

CHANGELOG.org

@@ -1,5 +1,6 @@
 * Changelog
 ** Unreleased 8.0.1
+  * Add lsp-solidity, using the implementation from NomicFoundation
   * Change rust-analyzer base URL to be github.com/rust-lang/rust-analyzer, rather than rust-analyzer/rust-analyzer.
   * Add [[https://github.com/wader/jq-lsp][jq-lsp]]
   * Add architecture triples for [[https://github.com/WhatsApp/erlang-language-platform][erlang-language-platform]] file downloads, to support macos on ARM and X86.

clients/lsp-solidity.el

@@ -0,0 +1,61 @@
+;;; lsp-solidity.el --- solidity LSP                      -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2023  konubinix
+
+;; Author: konubinix <[email protected]>
+;; Keywords: tools
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;;; Code:
+
+(require 'lsp-mode)
+
+(lsp-dependency 'solidity-language-server
+                '(:system "solidity-language-server")
+                '(:npm :package "@nomicfoundation/solidity-language-server"
+                       :path "nomicfoundation-solidity-language-server"))
+
+
+(defun lsp-client--solidity-ls-server-command ()
+  "Startup command for Solidity language server."
+  (list (lsp-package-path 'solidity-language-server) "--stdio"))
+
+
+(defgroup lsp-solidity nil
+  "LSP support for Solidity."
+  :group 'lsp-mode
+  :link '(url-link "https://github.com/NomicFoundation/hardhat-vscode/blob/development/server/README.md"))
+
+
+(lsp-register-client
+ (make-lsp-client :new-connection (lsp-stdio-connection #'lsp-client--solidity-ls-server-command)
+                  :activation-fn (lsp-activate-on "solidity" "sol")
+                  :server-id 'solidity
+                  :notification-handlers
+                  (ht ("custom/validation-job-status"
+                       #'lsp-client--solidity-validation-job-status))
+                  :download-server-fn (lambda (_client callback error-callback _update?)
+                                        (lsp-package-ensure 'solidity-language-server callback error-callback))))
+
+(defun lsp-client--solidity-validation-job-status (_workspace params)
+  ;; noop until I find out what to do with this
+  )
+
+(lsp-consistency-check lsp-solidity)
+
+(provide 'lsp-solidity)
+;;; lsp-solidity.el ends here

docs/lsp-clients.json

@@ -843,6 +843,15 @@
     "installation": "gem install solargraph",
     "debugger": "Yes"
   },
+  {
+      "name": "solidity",
+      "full-name": "nomicfoundation/solidity-language-server",
+      "server-name": "solidity-language-server",
+      "installation": "npx @nomicfoundation/solidity-language-server",
+      "server-url": "https://github.com/NomicFoundation/hardhat-vscode/blob/development/server/README.md",
+      "installation-url": "https://github.com/NomicFoundation/hardhat-vscode/blob/development/server/README.md",
+      "debugger": "Not available"
+  },
   {
     "name": "sorbet",
     "full-name": "Ruby (Sorbet)",

lsp-mode.el

@@ -187,7 +187,7 @@ As defined by the Language Server Protocol 3.16."
      lsp-solargraph lsp-sorbet lsp-sourcekit lsp-sonarlint lsp-tailwindcss lsp-tex lsp-terraform
      lsp-toml lsp-ttcn3 lsp-typeprof lsp-v lsp-vala lsp-verilog lsp-vetur lsp-volar
      lsp-vhdl lsp-vimscript lsp-xml lsp-yaml lsp-ruby-lsp lsp-ruby-syntax-tree
-     lsp-sqls lsp-svelte lsp-steep lsp-tilt lsp-zig lsp-jq)
+     lsp-solidity lsp-sqls lsp-svelte lsp-steep lsp-tilt lsp-zig lsp-jq)
   "List of the clients to be automatically required."
   :group 'lsp-mode
   :type '(repeat symbol))
@@ -927,6 +927,7 @@ Changes take effect only when a new session is started."
     (gleam-mode . "gleam")
     (graphviz-dot-mode . "dot")
     (tiltfile-mode . "tiltfile")
+    (solidity-mode . "solidity")
     (bibtex-mode . "bibtex")
     (rst-mode . "restructuredtext")
     (glsl-mode . "glsl")