Feature: Adding support for custom @tags

Offen

#3,314 erstellt am 14.12.2025 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 45/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: lua
Bereich: documentation

Rechercherichtung

Beginne damit, den Dokumentationsexporter und das von ihm erzeugte JSON-Dokument zu finden, und verfolge anschließend, wie Lua-Annotationen geparst und exportiert werden. Lege fest, wie custom_tags-Einträge einschließlich Titeln, Hidden-Flags und Formatierungsfunktionen im exportierten JSON dargestellt werden sollen; fertig ist die Aufgabe, wenn benutzerdefinierte Tags geparst und nachbearbeitet werden können, ohne eine interne Verwendung zu erfordern.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

One of the nice things with LDoc was the ability to define custom tags, so they could be used to give additional annotations.

As an example, this is the tags section of one of our projects.

custom_tags = {
	{"baseclass", title = "BaseClass", hidden = true},
	{"state", title = "State", hidden = true},

	{"warns", title = "Warnings", format = function(...)
		return "<span class='tag-warning'>" .. markup(...) .. "</span>"
	end},
	{"bugs", title = "Known Issues", format = function(...)
		return "<span class='tag-bugs'>" .. markup(...) .. "</span>"
	end},
	{"deprecated", title = "Deprecated", format = function(str)
		if str == "" then
			return "<span class='tag-deprecated'>This function is deprecated and may be removed in a future version.</span>"
		else
			return "<span class='tag-deprecated'>This function is deprecated and may be removed in a future version.<br>" .. markup(str) .. "</span>"
		end
	end},
	{"internal", title = "Internal", format = function(str)
		if str == "" then
			return "<span class='tag-internal'>This function is internal. Whilst you can call it, you probably shouldn't.</span>"
		else
			return "<span class='tag-internal'>This function is internal. Whilst you can call it, you probably shouldn't.<br>" .. markup(str) .. "</span>"
		end
	end}
}

Even if these aren't used internally, being able to define them for LuaLS to parse and export from the docs exporter in the json document would allow us to do post-processing on the files.

Vorherrschende Sprache: Lua
Sterne: 4.4k
Forks: 442
Ø Merge: 8 T. 9 Std.
Gemergte PRs (30 T.): 1

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus LuaLS/lua-language-server

[love-api] love.Data:clone() -> love.Data Offen

enhancement

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100

LuaLS/lua-language-server#1776 · Erstellt am 21.12.2022
泛型for迭代器的类型推导漏掉了带__call的类 Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 65/100

LuaLS/lua-language-server#3463 · 5 Kommentare · Erstellt am 19.9.2026
Type checking for functions as argument? Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 55/100

LuaLS/lua-language-server#3461 · Erstellt am 06.9.2026
Indentation when formatting off for values inside square brackets Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100

LuaLS/lua-language-server#3460 · 1 Kommentar · 1 Reaktion · Erstellt am 02.9.2026
Using LuaJIT's nil-coalescing extension does not narrow the type correctly Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100

LuaLS/lua-language-server#3459 · 1 Reaktion · Erstellt am 31.8.2026

Alle Issues in LuaLS/lua-language-server