testing-language-server

Crates.iotesting-language-server
lib.rstesting-language-server
version0.0.3
sourcesrc
created_at2024-05-23 14:26:17.71436
updated_at2024-06-22 11:06:58.837253
descriptionLSP server for testing
homepage
repository
max_upload_size
id1249564
size187,596
Kodai Kabasawa (kbwo)

documentation

README

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": {
          "cargo test": [
            {
              "path": "<adapter path>/testing-ls-adapter",
              "extra_args": ["--test-kind=cargo-test"],
              "include_pattern": ["**/*.rs"],
              "exclude_pattern": ["**/target/**"]
            }
          ],
          "jest": [
            {
              "path": "<adapter path>/testing-ls-adapter",
              "extra_args": ["--test-kind=jest"],
              "include_patterns": ["/**/*.js"],
              "exclude_patterns": ["/node_modules/**/*"]
            }
          ]
        }
      }
    }
  }
}

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.

Commit count: 0

cargo fmt