| Name | kak-lsp-diags JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | None |
| Summary | Kakoune plugin for LSP hover diagnostics |
| upload_time | 2025-07-18 02:29:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
kakoune
lsp
plugin
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1>Kakoune LSP Diagnostics Hover</h1>
This plugin integrates with
[kakoune-lsp](https://github.com/kakoune-lsp/kakoune-lsp) to provide better
hover support for inline diagnostics. It has a single function: to show
**inlay** diagnostics _only_ when the cursor is on an **inline** diagnostic.
In other words, if the cursor is over an error (the part underlined in red), the
_diagnostic's text_ will be displayed at the end of the line. As soon as the
cursor is moved, the text clears.
## Installation
`kak-lsp-diags` is available as a package on PyPI. You can install it with your
favorite python package manager:
```sh
uv tool install kak-lsp-diags
```
## Usage
Invoking the `kak-lsp-diags` command outputs necessary Kakoune commands and
starts a daemon. To use the plugin, add the following to your `kakrc`:
```kak
evaluate-commands %sh{ kak-lsp-diags }
```
Then, you can use the `lsp-diag-hover-enable` and `lsp-diag-hover-disable`
commands to control the plugin.
If you wish, you can see the contents of `static.kak` (the injected commands)
_without_ starting the server:
```sh
kak-lsp-diags --print-static
```
## Advanced Usage
Some users may want to customize what happens when the cursor hovers & leaves a
diagnostic. In this case, you'll need to replace the commands injected by the
plugin. To reference what's currently executed, use the `--print-static` flag,
or see `static.kak` in this repository. Feel free to write your own version and
add it to your `kakrc`.
Invoking the command with the `--no-static` option will **not** print
`static.kak` for evaluation by Kakoune. However, note that the `diagpipe_in` and
`diagpipe_out` options are **always** declared.
Raw data
{
"_id": null,
"home_page": null,
"name": "kak-lsp-diags",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "kakoune, lsp, plugin",
"author": null,
"author_email": "Daniel Fichtinger <daniel@ficd.sh>",
"download_url": "https://files.pythonhosted.org/packages/75/71/522306128248ba83f9472f5b2d8372ddc72c16ac58a41fb17f4d95b1df74/kak_lsp_diags-1.1.1.tar.gz",
"platform": null,
"description": "<h1>Kakoune LSP Diagnostics Hover</h1>\n\nThis plugin integrates with\n[kakoune-lsp](https://github.com/kakoune-lsp/kakoune-lsp) to provide better\nhover support for inline diagnostics. It has a single function: to show\n**inlay** diagnostics _only_ when the cursor is on an **inline** diagnostic.\n\nIn other words, if the cursor is over an error (the part underlined in red), the\n_diagnostic's text_ will be displayed at the end of the line. As soon as the\ncursor is moved, the text clears.\n\n## Installation\n\n`kak-lsp-diags` is available as a package on PyPI. You can install it with your\nfavorite python package manager:\n\n```sh\nuv tool install kak-lsp-diags\n```\n\n## Usage\n\nInvoking the `kak-lsp-diags` command outputs necessary Kakoune commands and\nstarts a daemon. To use the plugin, add the following to your `kakrc`:\n\n```kak\nevaluate-commands %sh{ kak-lsp-diags }\n```\n\nThen, you can use the `lsp-diag-hover-enable` and `lsp-diag-hover-disable`\ncommands to control the plugin.\n\nIf you wish, you can see the contents of `static.kak` (the injected commands)\n_without_ starting the server:\n\n```sh\nkak-lsp-diags --print-static\n```\n\n## Advanced Usage\n\nSome users may want to customize what happens when the cursor hovers & leaves a\ndiagnostic. In this case, you'll need to replace the commands injected by the\nplugin. To reference what's currently executed, use the `--print-static` flag,\nor see `static.kak` in this repository. Feel free to write your own version and\nadd it to your `kakrc`.\n\nInvoking the command with the `--no-static` option will **not** print\n`static.kak` for evaluation by Kakoune. However, note that the `diagpipe_in` and\n`diagpipe_out` options are **always** declared.\n",
"bugtrack_url": null,
"license": null,
"summary": "Kakoune plugin for LSP hover diagnostics",
"version": "1.1.1",
"project_urls": {
"Repository": "https://codeberg.org/ficd/kak-lsp-diags"
},
"split_keywords": [
"kakoune",
" lsp",
" plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8e9082190f9223badda3aaf8c50f04bd0657c432e0828b3b55efae32b2b20690",
"md5": "63c0492e53795ad874ca38ad3e429375",
"sha256": "0b94155092892dc843c86d082b9648365b4825dc9c6300390701b7f4dbe5f135"
},
"downloads": -1,
"filename": "kak_lsp_diags-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63c0492e53795ad874ca38ad3e429375",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 6450,
"upload_time": "2025-07-18T02:29:34",
"upload_time_iso_8601": "2025-07-18T02:29:34.567084Z",
"url": "https://files.pythonhosted.org/packages/8e/90/82190f9223badda3aaf8c50f04bd0657c432e0828b3b55efae32b2b20690/kak_lsp_diags-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7571522306128248ba83f9472f5b2d8372ddc72c16ac58a41fb17f4d95b1df74",
"md5": "95bdd5eca060334b6eac896b2aa86831",
"sha256": "475f68ea86312ca325a06282e9bc1be2075dac2867915079ad6389a6f9c8a8db"
},
"downloads": -1,
"filename": "kak_lsp_diags-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "95bdd5eca060334b6eac896b2aa86831",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 6738,
"upload_time": "2025-07-18T02:29:35",
"upload_time_iso_8601": "2025-07-18T02:29:35.259930Z",
"url": "https://files.pythonhosted.org/packages/75/71/522306128248ba83f9472f5b2d8372ddc72c16ac58a41fb17f4d95b1df74/kak_lsp_diags-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 02:29:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "ficd",
"codeberg_project": "kak-lsp-diags",
"lcname": "kak-lsp-diags"
}
