LuaLS / LuaLS/lua-language-server
[Question] Why is `ignoreSubmodules` by default true?
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
The title is my question.
To be more clear, I didn't know this option for years, and always kept seeing 3K errors of undeclared global values that are defined in my submodules. This almost keeps me away from this language server, and I think it is the same for some other people (although I didn't find any issue in this repo reporting such problem).
Is there any particular reason to ignore submodules by default? If this is reasonable, maybe we should prompt the user to let them choose whether they want to ignore submodules? Or we can keep this option to be `false` by default, and make ignoring submodule an extra `diagnostics.disable`?
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 investigating the `ignoreSubmodules` option and the related `diagnostics.disable` behavior described in the issue. Determine why submodules are ignored by default, then compare the proposed default and prompting alternatives; the work is done when the project has a clear, agreed decision and corresponding behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100