neovim/.github/ISSUE_TEMPLATE/lsp_bug_report.yml
2021-08-22 16:56:41 -07:00

65 lines
2.3 KiB
YAML

name: Language server (LSP) client bug report
description: Report an issue with Neovim builtin LSP
labels: [bug, lsp]
body:
- type: markdown
attributes:
value: |
_Before reporting:_ search [existing issues](https://github.com/neovim/neovim/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and check the [FAQ](https://github.com/neovim/neovim/wiki/FAQ). Usage questions such as "How do I...?" or "Why isn't X language server/feature working?" belong on the [Neovim Discourse](https://neovim.discourse.group/c/7-category/7) and will be closed.
- type: input
attributes:
label: "Neovim version (`nvim -v`)"
placeholder: "0.6.0 commit db1b0ee3b30f"
validations:
required: true
- type: input
attributes:
label: "Language server name/version"
placeholder: "rls 0.5.2"
validations:
required: true
- type: input
attributes:
label: "Operating system/version"
validations:
required: true
- type: textarea
attributes:
label: `:checkhealth nvim lspconfig`
description: |
Paste the results from `nvim -c ":checkhealth nvim lspconfig"`
render: markdown
- type: markdown
attributes:
value: |
Note: if the issue is with an autocompletion or other LSP plugin, report it to that plugin's issue tracker. Download the minimal config with `curl -LO https://raw.githubusercontent.com/neovim/nvim-lspconfig/master/test/minimal_init.lua` and modify it to include any specific commands or servers pertaining to your issues.
- type: textarea
attributes:
label: "Steps to reproduce using `nvim -u minimal_init.lua`"
validations:
required: true
- type: textarea
attributes:
label: "Expected behavior"
description: "Describe the behavior you expect. May include logs, images, or videos."
- type: textarea
attributes:
label: "Actual behavior"
- type: markdown
attributes:
value: |
Upload `lsp.log` before and after the problem in a [secret gist](https://gist.github.com/). Paste the url to the gist in the text field below.
- You can set the log level by adding this after setting up LSP in your config: `vim.lsp.set_log_level("debug")`
- You can find the location of the log with `:lua print(vim.lsp.get_log_path())`
- type: input
attributes:
label: "Uploaded log file"