Mark non-required setup fields as optional (#1723)

... to correct "Missing required fields" messages from lua_ls
This commit is contained in:
Adam Price
2023-12-10 06:14:50 -05:00
committed by GitHub
parent 36eb3a6917
commit c01a038469

View File

@@ -83,21 +83,21 @@ cmp.ItemField = {
---@alias cmp.Mapping cmp.MappingFunction | cmp.MappingClass ---@alias cmp.Mapping cmp.MappingFunction | cmp.MappingClass
---@class cmp.ConfigSchema ---@class cmp.ConfigSchema
---@field private revision integer ---@field private revision? integer
---@field public enabled boolean | fun(): boolean ---@field public enabled? boolean | fun(): boolean
---@field public performance cmp.PerformanceConfig ---@field public performance? cmp.PerformanceConfig
---@field public preselect cmp.PreselectMode ---@field public preselect? cmp.PreselectMode
---@field public completion cmp.CompletionConfig ---@field public completion? cmp.CompletionConfig
---@field public window cmp.WindowConfig|nil ---@field public window? cmp.WindowConfig|nil
---@field public confirmation cmp.ConfirmationConfig ---@field public confirmation? cmp.ConfirmationConfig
---@field public matching cmp.MatchingConfig ---@field public matching? cmp.MatchingConfig
---@field public sorting cmp.SortingConfig ---@field public sorting? cmp.SortingConfig
---@field public formatting cmp.FormattingConfig ---@field public formatting? cmp.FormattingConfig
---@field public snippet cmp.SnippetConfig ---@field public snippet? cmp.SnippetConfig
---@field public mapping table<string, cmp.Mapping> ---@field public mapping? table<string, cmp.Mapping>
---@field public sources cmp.SourceConfig[] ---@field public sources? cmp.SourceConfig[]
---@field public view cmp.ViewConfig ---@field public view? cmp.ViewConfig
---@field public experimental cmp.ExperimentalConfig ---@field public experimental? cmp.ExperimentalConfig
---@class cmp.PerformanceConfig ---@class cmp.PerformanceConfig
---@field public debounce integer ---@field public debounce integer
@@ -108,24 +108,24 @@ cmp.ItemField = {
---@field public max_view_entries integer ---@field public max_view_entries integer
---@class cmp.WindowConfig ---@class cmp.WindowConfig
---@field completion cmp.WindowConfig ---@field completion? cmp.WindowConfig
---@field documentation cmp.WindowConfig|nil ---@field documentation? cmp.WindowConfig|nil
---@class cmp.CompletionConfig ---@class cmp.CompletionConfig
---@field public autocomplete cmp.TriggerEvent[]|false ---@field public autocomplete? cmp.TriggerEvent[]|false
---@field public completeopt string ---@field public completeopt? string
---@field public get_trigger_characters fun(trigger_characters: string[]): string[] ---@field public get_trigger_characters? fun(trigger_characters: string[]): string[]
---@field public keyword_length integer ---@field public keyword_length? integer
---@field public keyword_pattern string ---@field public keyword_pattern? string
---@class cmp.WindowConfig ---@class cmp.WindowConfig
---@field public border string|string[] ---@field public border? string|string[]
---@field public winhighlight string ---@field public winhighlight? string
---@field public zindex integer|nil ---@field public zindex? integer|nil
---@field public max_width integer|nil ---@field public max_width? integer|nil
---@field public max_height integer|nil ---@field public max_height? integer|nil
---@field public scrolloff integer|nil ---@field public scrolloff? integer|nil
---@field public scrollbar boolean|true ---@field public scrollbar? boolean|true
---@class cmp.ConfirmationConfig ---@class cmp.ConfirmationConfig
---@field public default_behavior cmp.ConfirmBehavior ---@field public default_behavior cmp.ConfirmBehavior
@@ -168,8 +168,8 @@ cmp.ItemField = {
---@field public entry_filter nil|function(entry: cmp.Entry, ctx: cmp.Context): boolean ---@field public entry_filter nil|function(entry: cmp.Entry, ctx: cmp.Context): boolean
---@class cmp.ViewConfig ---@class cmp.ViewConfig
---@field public entries cmp.EntriesViewConfig ---@field public entries? cmp.EntriesViewConfig
---@field public docs cmp.DocsViewConfig ---@field public docs? cmp.DocsViewConfig
---@alias cmp.EntriesViewConfig cmp.CustomEntriesViewConfig|cmp.NativeEntriesViewConfig|cmp.WildmenuEntriesViewConfig|string ---@alias cmp.EntriesViewConfig cmp.CustomEntriesViewConfig|cmp.NativeEntriesViewConfig|cmp.WildmenuEntriesViewConfig|string