LuaLS / LuaLS/lua-language-server

Way to disable HTML tags in hover block

Aperta
#3,010 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

{3779F4A5-C19D-4E30-94AC-29FDC491F3DD}

It ate my names, they're not html tags.

Reproduction steps
  1. Place anything in angle brackets in your comment
  2. 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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia tracciando i percorsi di rendering e configurazione dell’hover per il Lua language server, usando come confronto il comportamento supportHtml citato in #996. Verifica come vengono lette le impostazioni di workspace, .luarc e dell’utente, quindi riproduci l’esempio con le parentesi angolari nella VS Code extension. Il lavoro è completato quando markdown rimane abilitato, mentre l’interpretazione dei tag HTML può essere disabilitata per progetto o tramite le impostazioni dell’utente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua, vscode
Ambito
developer-experience, tooling
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.