LuaLS / LuaLS/lua-language-server
add a `--help`command
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the command-line entry point and argument parsing used by lua-language-server; the issue names no files or tests. Compare the accepted arguments with the Configuration File wiki page, then verify that invoking the command with --help lists the available flags and reflects their actual value types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100