config: Suppress spurious "missing field" warnings from LSP #444
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 is a bit of an RFC, as I am not entirely sure it is the right place for the fix.
lua_ls marks fields that are missing in the configuration. Since they are not marked as optional in the Comment.nvim source code, I get a big "Missing required fields" warning as in the "Before" picture
This PR marks the fields explicitly as optional, giving the "After" picture. I modeled the fix after #hrsh7th/nvim-cmp/pull/1723 .
Before:
![image](https://private-user-images.githubusercontent.com/261949/313505697-04501769-e413-42a6-93bd-3875407e98c9.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTk5ODcxMjIsIm5iZiI6MTcxOTk4NjgyMiwicGF0aCI6Ii8yNjE5NDkvMzEzNTA1Njk3LTA0NTAxNzY5LWU0MTMtNDJhNi05M2JkLTM4NzU0MDdlOThjOS5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwNzAzJTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDcwM1QwNjA3MDJaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1kMTI2YzAwN2VkYjNjMGEzZWM1ZDRmYWJmMjk0YzVjM2M5YzI2YTQ0MDE5ZjJhYTFiYzZhODBhNTgxNjFmY2RiJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.EYvhB1NK6sFI2Z7qLPiqqD3TMFVNnElsyYqS5NgydAc)
After:
![image](https://private-user-images.githubusercontent.com/261949/313505728-d2e48ff8-a74a-45cc-ac1f-4c2f5a372ddf.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTk5ODcxMjIsIm5iZiI6MTcxOTk4NjgyMiwicGF0aCI6Ii8yNjE5NDkvMzEzNTA1NzI4LWQyZTQ4ZmY4LWE3NGEtNDVjYy1hYzFmLTRjMmY1YTM3MmRkZi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwNzAzJTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDcwM1QwNjA3MDJaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT0yZTk1ZTZjOWI1MjgxY2FjYjMzOGU1NmJiOWNhN2I5OGEyODA4OWQxM2RjZmY0YmVkODk2NTkwYWY4MjFhYTU5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.PwmEjrZkuZRBYOfZqRRtBHYB3KoxBdfg2wxH6tV0k74)