Skip to content

Commit b545111

Browse files
authored
refactor(types): change neotree.Config to a partial class (#1722)
1 parent 940063e commit b545111

File tree

2 files changed

+41
-39
lines changed

2 files changed

+41
-39
lines changed

lua/neo-tree/defaults.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---@type neotree.Config
1+
---@type neotree.Config.Base
22
local config = {
33
-- If a user has a sources list it will replace this one.
44
-- Only sources listed here will be loaded.

lua/neo-tree/types/config.lua

Lines changed: 40 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -106,45 +106,47 @@
106106

107107
---@alias neotree.Config.BorderStyle "NC"|"none"|"rounded"|"shadow"|"single"|"solid"
108108

109-
---@class (exact) neotree.Config
110-
---@field sources string[]?
111-
---@field add_blank_line_at_top boolean?
112-
---@field auto_clean_after_session_restore boolean?
113-
---@field close_if_last_window boolean?
114-
---@field default_source string?
115-
---@field enable_diagnostics boolean?
116-
---@field enable_git_status boolean?
117-
---@field enable_modified_markers boolean?
118-
---@field enable_opened_markers boolean?
119-
---@field enable_refresh_on_write boolean?
120-
---@field enable_cursor_hijack boolean?
121-
---@field git_status_async boolean?
122-
---@field git_status_async_options neotree.Config.GitStatusAsync?
123-
---@field hide_root_node boolean?
124-
---@field retain_hidden_root_indent boolean?
109+
---@class (exact) neotree.Config.Base
110+
---@field sources string[]
111+
---@field add_blank_line_at_top boolean
112+
---@field auto_clean_after_session_restore boolean
113+
---@field close_if_last_window boolean
114+
---@field default_source string
115+
---@field enable_diagnostics boolean
116+
---@field enable_git_status boolean
117+
---@field enable_modified_markers boolean
118+
---@field enable_opened_markers boolean
119+
---@field enable_refresh_on_write boolean
120+
---@field enable_cursor_hijack boolean
121+
---@field git_status_async boolean
122+
---@field git_status_async_options neotree.Config.GitStatusAsync
123+
---@field hide_root_node boolean
124+
---@field retain_hidden_root_indent boolean
125125
---@field log_level "trace"|"debug"|"info"|"warn"|"error"|"fatal"|nil
126-
---@field log_to_file boolean|string?
127-
---@field open_files_in_last_window boolean?
128-
---@field open_files_do_not_replace_types string[]?
129-
---@field open_files_using_relative_paths boolean?
130-
---@field popup_border_style neotree.Config.BorderStyle?
131-
---@field resize_timer_interval integer|-1?
132-
---@field sort_case_insensitive boolean?
133-
---@field sort_function fun(a: any, b: any)?
134-
---@field use_popups_for_input boolean?
135-
---@field use_default_mappings boolean?
136-
---@field source_selector neotree.Config.SourceSelector?
137-
---@field event_handlers neotree.Event.Handler[]?
138-
---@field default_component_configs neotree.Config.ComponentDefaults?
139-
---@field renderers neotree.Config.Renderers?
140-
---@field nesting_rules neotree.FileNesting.Rule[]?
141-
---@field commands table<string, fun()>?
142-
---@field window neotree.Config.Window?
126+
---@field log_to_file boolean|string
127+
---@field open_files_in_last_window boolean
128+
---@field open_files_do_not_replace_types string[]
129+
---@field open_files_using_relative_paths boolean
130+
---@field popup_border_style neotree.Config.BorderStyle
131+
---@field resize_timer_interval integer|-1
132+
---@field sort_case_insensitive boolean
133+
---@field sort_function? fun(a: any, b: any):boolean
134+
---@field use_popups_for_input boolean
135+
---@field use_default_mappings boolean
136+
---@field source_selector neotree.Config.SourceSelector
137+
---@field event_handlers? neotree.Event.Handler[]
138+
---@field default_component_configs neotree.Config.ComponentDefaults
139+
---@field renderers neotree.Config.Renderers
140+
---@field nesting_rules neotree.FileNesting.Rule[]
141+
---@field commands table<string, fun()>
142+
---@field window neotree.Config.Window
143143
---
144-
---@field filesystem neotree.Config.Filesystem?
145-
---@field buffers neotree.Config.Buffers?
146-
---@field git_status neotree.Config.GitStatus?
147-
---@field document_symbols neotree.Config.DocumentSymbols?
144+
---@field filesystem neotree.Config.Filesystem
145+
---@field buffers neotree.Config.Buffers
146+
---@field git_status neotree.Config.GitStatus
147+
---@field document_symbols neotree.Config.DocumentSymbols
148148

149-
---@class (exact) neotree.Config._Full : neotree.Config
149+
---@class (exact) neotree.Config._Full : neotree.Config.Base
150150
---@field prior_windows table<string, integer[]>?
151+
152+
---@class (partial) neotree.Config : neotree.Config.Base

0 commit comments

Comments
 (0)