Add optional diagnostic warning about any global element #2040
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Add warning for any global variable via diagnostic * Add messages in en-US TODO: add messages in languages other than en-us as well * fallback: enable/disable diagnostics w/ annotation * Add tests for the new diagnostic * Add diagnostic and group to config.md
sumneko
reviewed
Mar 29, 2023
|
Thanks for your work! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new diagnostic
global-elementand a new diagnostic groupstrict-conventions.In our coding, we want to avoid the usage of global elements almost completely, except for specific, configured elements. As it's easy to forget about the
localkeyword and create global variables/functions/..., we implemented this diagnostic.As this is probably not a convention/guideline everyone wants to follow, we put the diagnostic in a separate group, which will be disabled by default and therefore not affect any existing configurations.
In short, this PR includes
global-elementthat identifies any non-local element in the code that is not listed in the existing settingdiagnostics.globalsstrict-conventions, with default severityWarningand default fileStatusNone, so it's disabled by default