fix: remove missing required fields diagnostic from config
#812
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
|
As a note here is an analogous pr in for nvim-cmp, which the original issue was about: hrsh7th/nvim-cmp#1694 |
| ---@field style "underline" | "icon" | "none" | ||
| ---@field icon string? | ||
| ---@field style? "underline" | "icon" | "none" | ||
| ---@field icon? string? |
There was a problem hiding this comment.
If adding ? after the field/param name, then maybe it might be a good idea to also remove the ? after the type to make it consistent.
Suggested change
| ---@field icon? string? | |
| ---@field icon? string |
I think there are also others like this in this file:
lines 15, 37, 42, 50*, 181*
* = for those lines I am not completely sure
1 task
akinsho
approved these changes
Nov 29, 2023
sstallion
pushed a commit
to sstallion/bufferline.nvim
that referenced
this pull request
Jul 3, 2024
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.
As discussed in the mentioned issue, it appears that some changes to lua_ls mean that not including non-optional fields in a config table throws a diagnostic warning, as shown in the screenshot. As the issue mentions, it's possible to disable this behavior globally or with a
---@diagnostic disable-next-line missing-fieldscomment before the table, but I think it would still be greatly desirable to have bufferline not throw warnings for non-mandatory fields by default.I've tried my best to only make the non-mandatory fields optional, but I probably over or under-modified the types, so please feel free to add/remove
?s around the types file.LuaLS/lua-language-server#2214 (comment)
