feat(clients): Add Cucumber support (#4372)

Author: jcs090218

Diff for: CHANGELOG.org

@@ -174,6 +174,7 @@
   * Add support for signatureHelp using ~posframe~. #1999
   * Add ~iedit~ integration. #2478
   * Add client for Verible SystemVerilog language Server ([[https://github.com/chipsalliance/verible]])
+  * Add Cucumber support.
 
 ** Release 7.0.1
   * Introduced ~lsp-diagnostics-mode~.

Diff for: clients/lsp-cucumber.el

@@ -0,0 +1,66 @@
+;;; lsp-cucumber.el --- LSP Clients for Cucumber  -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2024  Shen, Jen-Chieh
+
+;; This file is not part of GNU Emacs.
+
+;; 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:
+;;
+;; LSP server implementation for Cucumber
+;;
+
+;;; Code:
+
+(defgroup lsp-cucumber nil
+  "LSP server implementation for Cucumber."
+  :group 'lsp-mode
+  :link '(url-link "https://github.com/cucumber/language-server"))
+
+(defcustom lsp-cucumber-server-path nil
+  "Path points for Cucumber language server.
+
+This is only for development use."
+  :type 'string
+  :group 'lsp-cucumber)
+
+(defcustom lsp-cucumber-active-modes
+  '( feature-mode)
+  "List of major mode that work with Cucumber language server."
+  :type 'list
+  :group 'lsp-cucumber)
+
+(defun lsp-cucumber--server-command ()
+  "Generate startup command for Cucumber language server."
+  (or (and lsp-cucumber-server-path
+           (list lsp-cucumber-server-path "--stdio"))
+      (list (lsp-package-path 'cucumber-language-server) "--stdio")))
+
+(lsp-dependency 'cucumber-language-server
+                '(:system "cucumber-language-server")
+                '(:npm :package "@cucumber/language-server"
+                       :path "cucumber-language-server"))
+
+(lsp-register-client
+ (make-lsp-client
+  :new-connection (lsp-stdio-connection #'lsp-cucumber--server-command)
+  :major-modes lsp-cucumber-active-modes
+  :priority -1
+  :server-id 'cucumber-language-server
+  :download-server-fn (lambda (_client callback error-callback _update?)
+                        (lsp-package-ensure 'cucumber-language-server callback error-callback))))
+
+(provide 'lsp-cucumber)
+;;; lsp-cucumber.el ends here

Diff for: docs/lsp-clients.json

@@ -188,6 +188,15 @@
     "lsp-install-server": "css-ls",
     "debugger": "Not available"
   },
+  {
+    "name": "cucumber",
+    "full-name": "Cucumber",
+    "server-name": "cucumber-language-server",
+    "server-url": "https://github.com/cucumber/language-server",
+    "installation": "npm install -g @cucumber/language-server",
+    "lsp-install-server": "cucumber-language-server",
+    "debugger": "Not available"
+  },
   {
     "name": "cypher",
     "full-name": "Cypher",
@@ -923,13 +932,13 @@
     "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": "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",

Diff for: lsp-mode.el

@@ -174,21 +174,22 @@ As defined by the Language Server Protocol 3.16."
   :package-version '(lsp-mode . "6.1"))
 
 (defcustom lsp-client-packages
-  '( ccls lsp-actionscript lsp-ada lsp-angular lsp-ansible lsp-autotools lsp-awk lsp-asm lsp-astro
-     lsp-bash lsp-beancount lsp-bufls lsp-clangd lsp-clojure lsp-cmake lsp-credo
-     lsp-crystal lsp-csharp lsp-css lsp-cypher lsp-d lsp-dart lsp-dhall lsp-docker
-     lsp-dockerfile lsp-elm lsp-elixir lsp-emmet lsp-erlang lsp-eslint lsp-fortran
-     lsp-fsharp lsp-gdscript lsp-go lsp-golangci-lint lsp-gleam lsp-glsl lsp-graphql
-     lsp-hack lsp-grammarly lsp-groovy lsp-haskell lsp-haxe lsp-idris lsp-java
-     lsp-javascript lsp-json lsp-kotlin lsp-latex lsp-ltex lsp-lua lsp-markdown
-     lsp-marksman lsp-mdx lsp-mint lsp-move lsp-nginx lsp-nim lsp-nix lsp-magik
-     lsp-mojo lsp-metals lsp-mssql lsp-ocaml lsp-openscad lsp-pascal lsp-perl
-     lsp-perlnavigator lsp-pls lsp-php lsp-pwsh lsp-pyls lsp-pylsp lsp-pyright
-     lsp-python-ms lsp-purescript lsp-r lsp-racket lsp-remark lsp-ruff-lsp lsp-rf
-     lsp-rubocop lsp-rust lsp-semgrep lsp-shader 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
+  '( ccls lsp-actionscript lsp-ada lsp-angular lsp-ansible lsp-autotools lsp-awk
+     lsp-asm lsp-astro lsp-bash lsp-beancount lsp-bufls lsp-clangd lsp-clojure
+     lsp-cmake lsp-credo lsp-crystal lsp-csharp lsp-css lsp-cucumber lsp-cypher
+     lsp-d lsp-dart lsp-dhall lsp-docker lsp-dockerfile lsp-elm lsp-elixir
+     lsp-emmet lsp-erlang lsp-eslint lsp-fortran lsp-fsharp lsp-gdscript lsp-go
+     lsp-golangci-lint lsp-gleam lsp-glsl lsp-graphql lsp-hack lsp-grammarly
+     lsp-groovy lsp-haskell lsp-haxe lsp-idris lsp-java lsp-javascript lsp-json
+     lsp-kotlin lsp-latex lsp-ltex lsp-lua lsp-markdown lsp-marksman lsp-mdx
+     lsp-mint lsp-move lsp-nginx lsp-nim lsp-nix lsp-magik lsp-mojo lsp-metals
+     lsp-mssql lsp-ocaml lsp-openscad lsp-pascal lsp-perl lsp-perlnavigator
+     lsp-pls lsp-php lsp-pwsh lsp-pyls lsp-pylsp lsp-pyright lsp-python-ms
+     lsp-purescript lsp-r lsp-racket lsp-remark lsp-ruff-lsp lsp-rf lsp-rubocop
+     lsp-rust lsp-semgrep lsp-shader 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-solidity lsp-sqls lsp-svelte lsp-steep lsp-tilt lsp-zig lsp-jq)
   "List of the clients to be automatically required."
   :group 'lsp-mode

Diff for: mkdocs.yml

@@ -64,6 +64,7 @@ nav:
     - CMake: page/lsp-cmake.md
     - Crystal: page/lsp-crystal.md
     - CSS/LessCSS/SASS/SCSS: page/lsp-css.md
+    - Cucumber: page/lsp-cucumber.md
     - Cypher: page/lsp-cypher.md
     - D: page/lsp-d.md
     - Dart: https://emacs-lsp.github.io/lsp-dart