Servidor LSP

Tradução automática

Esta página foi traduzida automaticamente do inglês e ainda não foi revisada por um falante nativo; correções são bem-vindas no GitHub. Se algo não bater, vale o original em inglês.

O quantum-lsp é um servidor do Language Server Protocol para arquivos .q: qualquer editor com um cliente LSP pode usá-lo.

Ele oferece:

• autocompletar de tags, atributos, valores de atributos, variáveis e funções;
• documentação ao passar o mouse sobre tags, atributos e variáveis;
• ir para a definição de q:function, q:component e variáveis;
• encontrar referências de funções, componentes e variáveis;
• diagnósticos enquanto você digita;
• formatação de um documento ou de uma seleção;
• símbolos do documento (o outline).

Instalação

O servidor fica na pasta quantum-lsp/ do repositório; ele não está no PyPI. Instale-o a partir de um clone:

git clone https://github.com/danielgregorio/quantum
pip install ./quantum/quantum-lsp

quantum-lsp --version
# quantum-lsp 1.0.0

Linha de comando

quantum-lsp [--stdio | --tcp] [--host HOST] [--port PORT] [--log-level LEVEL]

  --stdio           Use stdio for communication (the default)
  --tcp             Use TCP, on --host (127.0.0.1) and --port (2087)
  --log-level       DEBUG, INFO, WARNING or ERROR
  --version         Show the version

python -m quantum_lsp --stdio é o mesmo, sem o script no PATH.

Configuração do editor

Cada editor precisa de duas coisas: um tipo de arquivo para os arquivos .q, e o comando quantum-lsp --stdio.

Neovim

Com o nvim-lspconfig:

vim.filetype.add({ extension = { q = 'quantum' } })

local lspconfig = require('lspconfig')
local configs = require('lspconfig.configs')

if not configs.quantum_ls then
  configs.quantum_ls = {
    default_config = {
      cmd = { 'quantum-lsp', '--stdio' },
      filetypes = { 'quantum' },
      root_dir = lspconfig.util.root_pattern('quantum.config.yaml', '.git'),
    },
  }
end

lspconfig.quantum_ls.setup({})

Helix

Em ~/.config/helix/languages.toml:

[language-server.quantum-lsp]
command = "quantum-lsp"
args = ["--stdio"]

[[language]]
name = "quantum"
scope = "source.quantum"
file-types = ["q"]
roots = ["quantum.config.yaml"]
comment-token = "<!--"
language-servers = ["quantum-lsp"]

Emacs

Com o lsp-mode:

(define-derived-mode quantum-mode nxml-mode "Quantum"
  "Major mode for Quantum .q files.")
(add-to-list 'auto-mode-alist '("\\.q\\'" . quantum-mode))

(with-eval-after-load 'lsp-mode
  (add-to-list 'lsp-language-id-configuration '(quantum-mode . "quantum"))
  (lsp-register-client
   (make-lsp-client
    :new-connection (lsp-stdio-connection '("quantum-lsp" "--stdio"))
    :major-modes '(quantum-mode)
    :server-id 'quantum-ls)))

(add-hook 'quantum-mode-hook #'lsp)

Kate

Nas configurações do LSP Client (lsp.json):

{
  "servers": {
    "quantum": {
      "command": ["quantum-lsp", "--stdio"],
      "highlightingModeRegex": "^XML$",
      "rootIndicationFileNames": ["quantum.config.yaml", ".git"]
    }
  }
}

VS Code

A extensão do VS Code não usa este servidor: ela tem o seu próprio autocompletar, hover e diagnósticos, construídos a partir do mesmo esquema de tags.

Comandos

Além das requisições padrão, o servidor responde a dois comandos workspace/executeCommand: quantum.validateDocument e quantum.showAst.

Desenvolvimento

cd quantum-lsp
pip install -e ".[dev]"
pytest tests/
quantum-lsp --stdio --log-level DEBUG

Relacionados

• Extensão do VS Code - Integração com o VS Code
• Comandos da CLI - Ferramentas de linha de comando