LuaLS / LuaLS/lua-language-server

add a `--help`command

Offen
#2,097 1 Kommentar 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Lua
Sterne
4.4k
Forks
442
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

I was trying to debug a lua-language-server command I found on a CI pipeline but I was not able to make sense of the command line without internet access and especially access to https://github.com/LuaLS/lua-language-server/wiki/Configuration-File

How is one supposed to discover the arguments ? Most programs I know support a --help argument that presents the available flags/commands. I wish we could have one. Also it avoids the problem of documentation going out of sync: the wiki page mentions check as a boolean but my version 3.6.19 says it expects a string

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, den Befehlszeileneinstiegspunkt und die für lua-language-server verwendete Argumentanalyse zu finden; das Issue nennt keine Dateien oder Tests. Vergleiche die akzeptierten Argumente mit der Configuration File-Wikiseite und überprüfe anschließend, dass die Ausführung des Befehls mit --help die verfügbaren Flags auflistet und ihre tatsächlichen Werttypen widerspiegelt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
cli
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.