LuaLS / LuaLS/lua-language-server
Way to disable HTML tags in hover block
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Lua
- Star
- 4.4k
- Fork
- 442
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách lần theo các đường dẫn kết xuất và cấu hình hover cho Lua language server, sử dụng hành vi supportHtml được tham chiếu trong #996 để so sánh. Kiểm tra cách các cài đặt workspace, .luarc và người dùng được đọc, sau đó tái hiện ví dụ với dấu ngoặc nhọn trong VS Code extension. Hoàn thành khi markdown vẫn được bật, đồng thời việc diễn giải thẻ HTML có thể được tắt theo từng dự án hoặc trong cài đặt người dùng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- lua, vscode
- Lĩnh vực
- developer-experience, tooling
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100