Skip to content

docs: add missing diagnostics and settings. #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add missing diagnostics and settings. #50

wants to merge 2 commits into from

Conversation

qwertycxz
Copy link

List

  1. Add invisible diagnostic.
  2. Complete diagnostics setting.
  3. Improve hyperlink in format setting.
  4. Add addonManager.repositoryBranch setting.
  5. Add addonManager.repositoryPath setting.
  6. Add codeLens setting.
  7. Add diagnostics.globalsRegex setting.
  8. Add doc.regengine setting.
  9. Add docScriptPath setting.
  10. Add hint.awaitPropagate setting.
  11. Add language setting.
  12. Add nameStyle setting.
  13. Add type.checkTableShape setting.
  14. Add type.inferParamType setting.
  15. Add type.inferTableSize setting.
  16. Add typeFormat setting.

感想

解决一下文档残缺的历史遗留问题，真多呀……

花了一天时间肝出来的，可能会有笔误，敬请谅解！

另外，我尝试按照README.md进行部署，但是没有成功😟。因此所有的改动都未经测试，拜托请代为进行测试！

@qwertycxz
Copy link
Author

联动LuaLS/lua-language-server#3160

@qwertycxz qwertycxz mentioned this pull request Apr 20, 2025
Open
@qwertycxz qwertycxz changed the title Add missing diagnostics and settings. docs: add missing diagnostics and settings. Apr 21, 2025
@carsakiller carsakiller added the wiki/authoring Adds new content to the website label Apr 23, 2025
carsakiller
carsakiller requested changes Apr 23, 2025
View reviewed changes
Copy link
Collaborator

@carsakiller carsakiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Just one change, please.

src/content/wiki/settings.mdx

Specifies a custom Lua script path to override the default documentation generation behavior. When set, the server uses this script (instead of [the built-in one](https://github.com/LuaLS/lua-language-server/blob/master/script/cli/doc/export.lua)) to generate LuaDocs, allowing customization of filtering, sorting, and formatting rules. Leave empty to use the default script. Requires the custom script to implement specific APIs for compatibility.

<Accordion>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the API for documentation generation should go on the Export documentation page instead, with a link to it here. I think it is a bit too cluttered having it in here with all the settings 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carsakiller carsakiller carsakiller requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
wiki/authoring Adds new content to the website
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@qwertycxz @carsakiller