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

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

docs: add missing diagnostics and settings. #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22a9794
fix: missing diagnostics
qwertycxz Apr 20, 2025
e92db75
fix: missing settings
qwertycxz Apr 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions src/content/wiki/diagnostics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ The codestyle group contains diagnostics for maintaining a good code style.
</Fragment>
**Default File Status:** `"None"`

Triggered when the opinionated style checking detects an incorrectly styled line.
Triggered when the opinionated style checking detects an incorrectly styled line. The style can be customized using the [`Lua.format.defaultConfig` setting](/wiki/settings#formatdefaultconfig).

</Diagnostic>

Expand All @@ -134,7 +134,7 @@ Triggered when the opinionated style checking detects an incorrectly styled line
</Fragment>
**Default File Status:** `"None"`

Triggered when the opinionated style checking detects an incorrectly named element.
Triggered when the opinionated style checking detects an incorrectly named element. The style can be customized using the [`Lua.nameStyle.config` setting](/wiki/settings#namestyleconfig).

</Diagnostic>

Expand All @@ -144,7 +144,7 @@ Triggered when the opinionated style checking detects an incorrectly named eleme
</Fragment>
**Default File Status:** `"None"`

Triggered when a typo is detected in a string. The dictionary can be customized using the [`Lua.spell.dict` setting](https://github.com/LuaLS/lua-language-server/wiki/Settings#spelldict).
Triggered when a typo is detected in a string. The dictionary can be customized using the [`Lua.spell.dict` setting](/wiki/settings#spelldict).

</Diagnostic>

Expand Down Expand Up @@ -334,7 +334,7 @@ Triggered when there are two [`@param`](/wiki/annotations#param) annotations wit
</Fragment>
**Default File Status:** `"None"`

Triggered when a functions signature is partially documented with [annotations](/wiki/annotations), but the annotations do not cover every element of the signature.
Triggered when a functions signature is partially documented with [annotations](/wiki/annotations), but the annotations do not cover every element of the signature.
E.g. one of the parameters is not annotated, or the return value is not annotated.

</Diagnostic>
Expand Down Expand Up @@ -468,6 +468,14 @@ Triggered when the returns of a function are being ignored when it is not permit

</Diagnostic>

<Diagnostic level="Warning">
<Fragment slot="name">
### invisible
</Fragment>
Triggered when accesses to fields which are invisible. Specifically, access to [`@package`](/wiki/annotations#package) from another file, [`@private`](/wiki/annotations#private) not within self class, or [`@protected`](/wiki/annotations#protected) not within self class or child classes.

</Diagnostic>

## strong

The strong group contains diagnostics considered "strong". These can help you write better code but may require more work to follow.
Expand Down
Loading