1 unstable release

new 0.1.0 May 23, 2024
0.0.1 May 23, 2024

#97 in #diagnostics

MIT license

57KB
560 lines

testing-language-server

General purpose LSP server that integrate with testing. The language server is characterized by portability and extensibility.

Motivation

This LSP server is heavily influenced by the following tools

These tools are very useful and powerful. However, they depend on the execution environment, such as VSCode and NeoVim, and the portability aspect was inconvenient for me. So, I designed this testing-language-server and its dedicated adapters for each test tool to be the middle layer to the parts that depend on each editor.

This design makes it easy to view diagnostics from tests in any editor. Environment-dependent features like neotest and VSCode's built-in testing tools can also be achieved with minimal code using testing-language-server.

Features

  • Realtime testing diagnostics
  • More efficient checking of diagnostics
  • Adapter installation command
  • VSCode extension
  • Coc.nvim extension
  • NeoVim builtin LSP plugin

Configuration

language server config:

"languageserver": {
  "testing": {
    "command": "<server path>/testing-language-server",
    "trace.server": "verbose",
    "filetypes": [
      "rust",
      "javascript"
    ],
    "initializationOptions": {
      "initializationOptions": {
        "adapterCommand": {
          ".rs": [
            {
              "path": "<adapter path>/testing-ls-adapter",
              "extra_args": ["--test-kind=cargo-test"]
            }
          ],
          ".js": [
            {
              "path": "<adapter path>/testing-ls-adapter",
              "extra_args": ["--test-kind=jest"]
            }
          ]
        }
      }
    }
  }
}

Adapter

  • cargo test
  • jest
  • others

Writing custom adapter

⚠ The specification of adapter CLI is not stabilized yet.

See spec.rs.

clap crate makes it easy to address specification, but in principle you can create an adapter in any way you like, regardless of the language you implement.

Dependencies

~8–20MB
~268K SLoC