LuaLS / LuaLS/lua-language-server
Way to disable HTML tags in hover block
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Lua
- Sterne
- 4.4k
- Forks
- 442
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
How are you using the lua-language-server?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Windows
What is the issue affecting?
Hover
Expected Behaviour
Hi. I've come across the fact that some people want to use angle brackets as a classic description for arguments, like command-line arguments <arg>[, arg]. But VS Code automatically considers these HTML tags in hover block and deletes them. I would like to be able to disable this behavior in per-project (workspace or .luarc) and user settings.
-- Adds <amount> of <item> to character.
---@param item string
---@param amount integer
function Character:AddItem(item, amount) end
Also I like to use markdown style, but not html tags.
I found #996 where it feels like html tags can be disabled without disabling markdown - supportHtml.
Actual Behaviour
It ate my names, they're not html tags.
Reproduction steps
- Place anything in angle brackets in your comment
- Look, it's gone when you hover
Additional Notes
I found some info on this page https://luals.github.io/wiki/annotations/
The below methods can be added to the end of a line:
HTML <br> tag (recommended)
\n newline escape character
Two trailing spaces (may be removed by formatting tools)
Markdown backslash \ ( [not recommended](https://www.markdownguide.org/basic-syntax#line-break-best-practices) )
but only the first one seems to work, and the others don't do anything.
Log File
No response
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Rendering- und Konfigurationspfade für Hover-Anzeigen des Lua language server nachzuverfolgen, und verwende dabei das referenzierte Verhalten von #996 supportHtml als Vergleich. Prüfe, wie workspace-, .luarc- und Benutzereinstellungen gelesen werden, und reproduziere anschließend das Beispiel mit spitzen Klammern in der VS Code extension. Erledigt ist die Aufgabe, wenn markdown aktiviert bleibt, während die Interpretation von HTML-Tags pro Projekt oder über Benutzereinstellungen deaktiviert werden kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua, vscode
- Bereich
- developer-experience, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100