feat: add compatibility to old config style

Author: s1n7ax

README.md

@@ -1,19 +1,20 @@
 # nvim-window-picker
 
-https://user-images.githubusercontent.com/18459807/161597479-a3d8cf73-3dca-44b1-9eb6-d00b4e6eb842.mp4
+<https://user-images.githubusercontent.com/18459807/161597479-a3d8cf73-3dca-44b1-9eb6-d00b4e6eb842.mp4>
 
-This plugins prompts the user to pick a window and returns the window id of the picked window.
-Part of the code is from [nvim-tree](https://github.com/kyazdani42/nvim-tree.lua) so shout out to
-them for coming up with this idea.
+This plugins prompts the user to pick a window and returns the window id of the
+picked window. Part of the code is from
+[nvim-tree](https://github.com/kyazdani42/nvim-tree.lua) so shout out to them
+for coming up with this idea.
 
 ## Install
 
-#### packer
+### packer
 
 ```lua
 use {
     's1n7ax/nvim-window-picker',
-    tag = 'v1.*',
+    tag = 'v2.*',
     config = function()
         require'window-picker'.setup()
     end,
@@ -28,33 +29,45 @@ use {
 local picked_window_id = require('window-picker').pick_window()
 ```
 
-**You can put the picked window id to good use**
+You can put the picked window id to good use
 
 ## Configuration
 
 If you want to have custom properties just for one time, you can pass any of
-following directly to `pick_window()` function itself.
+following directly to `pick_window()` function itself to override the default
+behaviour.
 
 ```lua
 require 'window-picker'.setup({
-    -- when there is only one window available to pick from, use that window
-    -- without prompting the user to select
-    autoselect_one = true,
-
-    -- whether you want to include the window you are currently on to window
-    -- selection or not
-    include_current_win = false,
-
     -- when you go to window selection mode, status bar will show one of
     -- following letters on them so you can use that letter to select the window
     selection_chars = 'FJDKSLA;CMRUEIWOQP',
 
+    -- You can change the display string in status bar.
+    -- It supports '%' printf style. Such as `return char .. ': %f'` to display
+    -- buffer filepath. See :h 'stl' for details.
+    selection_display = function(char, windowid)
+        return '%=' .. char .. '%='
+    end,
+
+    -- whether you want to use winbar instead of the statusline
+    -- "always" means to always use winbar,
+    -- "never" means to never use winbar
+    -- "smart" means to use winbar if cmdheight=0 and statusline if cmdheight > 0
+    use_winbar = 'smart', -- "always" | "never" | "smart"
+
+    -- whether to show 'Pick window:' prompt
+    show_prompt = false,
+
+    -- prompt message to show to get the user input
+    prompt_message = 'Pick window: ',
+
     -- if you want to manually filter out the windows, pass in a function that
-    -- takes two parameters. you should return window ids that should be
+    -- takes two parameters. You should return window ids that should be
     -- included in the selection
     -- EX:-
     -- function(window_ids, filters)
-    --    -- filter the window_ids
+    --    -- folder the window_ids
     --    -- return only the ones you want to include
     --    return {1000, 1001}
     -- end
@@ -64,12 +77,20 @@ require 'window-picker'.setup({
     -- defined by this plugin. if you pass in a function to "filter_func"
     -- property, you are on your own
     filter_rules = {
+        -- when there is only one window available to pick from, use that window
+        -- without prompting the user to select
+        autoselect_one = true,
+
+        -- whether you want to include the window you are currently on to window
+        -- selection or not
+        include_current_win = false,
+
         -- filter using buffer options
         bo = {
             -- if the file type is one of following, the window will be ignored
-            filetype = { 'NvimTree', "neo-tree", "notify" },
+            filetype = { 'NvimTree', 'neo-tree', 'notify' },
 
-            -- if the buffer type is one of following, the window will be ignored
+            -- if the file type is one of following, the window will be ignored
             buftype = { 'terminal' },
         },
 
@@ -85,6 +106,9 @@ require 'window-picker'.setup({
         file_name_contains = {},
     },
 
+    -- the foreground (text) color of the picker
+    fg_color = '#ededed',
+
     -- if you have include_current_win == true, then current_win_hl_color will
     -- be highlighted using this background color
     current_win_hl_color = '#e35e4f',
@@ -97,12 +121,21 @@ require 'window-picker'.setup({
 
 ```lua
 require(package_name).pick_window({
-    include_current_win = true,
     selection_chars = '123345',
     filter_rules = {
+        include_current_win = true,
         bo = {
             filetype = {'markdown'}
         }
     },
 })
 ```
+
+## Breaking changes in v2.0.0
+
+_Before_: return value from `selection_display` will be wrapped by `'%='` and
+`'%='` to fill the empty space of status line or winbar.
+
+_After_: return value of `selection_display` will be passed directly to the
+status line or winbar. This allows all the customizations available from
+statusline syntax. You can check `:help statusline` for more info.

lua/window-picker/builder.lua

@@ -1,6 +1,7 @@
+local dconfig = require('window-picker.config')
 local dfilter = require('window-picker.filters.default-window-filter')
 local dpicker = require('window-picker.pickers.window-picker')
-local dhint = require('window-picker.hints.statusline-hint')
+local dhint = require('window-picker.hints.statusline-winbar-hint')
 local dconfigurer = require('window-picker.configurer')
 
 --- @class DefaultBuilder
@@ -17,7 +18,7 @@ function M:new(configurer)
 end
 
 function M:set_config(config)
-	self.config = config
+	self.config = vim.tbl_deep_extend('force', dconfig, config or {})
 	return self
 end
 

lua/window-picker/config.lua

@@ -1,12 +1,4 @@
 local config = {
-	-- when there is only one window available to pick from, use that window
-	-- without prompting the user to select
-	autoselect_one = true,
-
-	-- whether you want to include the window you are currently on to window
-	-- selection or not
-	include_current_win = false,
-
 	-- when you go to window selection mode, status bar will show one of
 	-- following letters on them so you can use that letter to select the window
 	selection_chars = 'FJDKSLA;CMRUEIWOQP',
@@ -22,11 +14,14 @@ local config = {
 	-- "always" means to always use winbar,
 	-- "never" means to never use winbar
 	-- "smart" means to use winbar if cmdheight=0 and statusline if cmdheight > 0
-	use_winbar = 'smart', -- "always" | "never" | "smart"
+	use_winbar = 'never', -- "always" | "never" | "smart"
 
 	-- whether to show 'Pick window:' prompt
 	show_prompt = true,
 
+	-- prompt message to show to get the user input
+	prompt_message = 'Pick window: ',
+
 	-- if you want to manually filter out the windows, pass in a function that
 	-- takes two parameters. You should return window ids that should be
 	-- included in the selection
@@ -42,6 +37,14 @@ local config = {
 	-- defined by this plugin. if you pass in a function to "filter_func"
 	-- property, you are on your own
 	filter_rules = {
+		-- when there is only one window available to pick from, use that window
+		-- without prompting the user to select
+		autoselect_one = true,
+
+		-- whether you want to include the window you are currently on to window
+		-- selection or not
+		include_current_win = false,
+
 		-- filter using buffer options
 		bo = {
 			-- if the file type is one of following, the window will be ignored

lua/window-picker/configurer.lua

@@ -6,20 +6,42 @@ local dconfig = require('window-picker.config')
 local M = {}
 
 function M:new(config)
+	config = config and util.merge_config(dconfig, config) or dconfig
+	config = M._backward_compatibility_config_changes(config)
+	config = M._basic_config_manipulations(config)
+
 	local o = {
-		config = config and util.merge_config(dconfig, config) or dconfig,
+		config = config,
 	}
 
-	o.config.chars = self._str_to_char_list(
-		o.config.selection_chars
-	)
-
 	setmetatable(o, self)
+
 	self.__index = self
 
 	return o
 end
 
+function M._basic_config_manipulations(config)
+	config.chars = M._str_to_char_list(config.selection_chars)
+	return config
+end
+
+function M._backward_compatibility_config_changes(config)
+	local filter_rules = config.filter_rules
+
+	-- backward compatibility to config.autoselect_one
+	if config.autoselect_one then
+		filter_rules.autoselect_one = config.autoselect_one
+	end
+
+	-- backward compatibility to config.include_current_win
+	if config.include_current_win then
+		filter_rules.include_current_win = config.include_current_win
+	end
+
+	return config
+end
+
 function M:config_filter(filter)
 	filter:set_config(self.config.filter_rules)
 	return filter

lua/window-picker/filters/default-window-filter.lua

@@ -19,6 +19,7 @@ function M:new()
 		o._buffer_options_filter,
 		o._file_path_contains_filter,
 		o._file_path_contains_filter,
+		o._current_window_filter,
 	}
 
 	return o
@@ -29,6 +30,7 @@ function M:set_config(config)
 	self.buffer_options = config.bo or {}
 	self.file_name_contains = config.file_name_contains or {}
 	self.file_path_contains = config.file_path_contains or {}
+	self.include_current_win = config.include_current_win
 end
 
 function M:filter_windows(windows)
@@ -136,4 +138,16 @@ function M:_file_name_contains_filter(windows)
 	end
 end
 
+function M:_current_window_filter(windows)
+	if self.include_current_win then
+		return windows
+	end
+
+	local curr_win = vim.api.nvim_get_current_win()
+
+	return util.tbl_filter(windows, function(winid)
+		return winid ~= curr_win
+	end)
+end
+
 return M

lua/window-picker/init.lua

@@ -1,4 +1,3 @@
-local hint = require('window-picker.hints.floating-big-letter-hint')
 local builder = require('window-picker.builder')
 
 local M = {}
@@ -7,7 +6,7 @@ function M.pick_window(custom_config)
 	return builder
 		:new()
 		:set_config(custom_config)
-		:set_hint(hint:new())
+		:set_hint()
 		:set_picker()
 		:set_filter()
 		:build()

lua/window-picker/pickers/window-picker.lua

@@ -14,6 +14,9 @@ end
 
 function M:set_config(config)
 	self.chars = config.chars
+	self.show_prompt = config.show_prompt
+	self.prompt_message = config.prompt_message
+	self.autoselect_one = config.filter_rules.autoselect_one
 	return self
 end
 
@@ -42,13 +45,25 @@ end
 
 function M:pick_window()
 	local windows = self:_get_windows()
+
+	if self.autoselect_one and #windows == 1 then
+		return windows[1]
+	end
+
 	local window = nil
 
 	self.hint:draw(windows)
 
 	vim.cmd.redraw()
 
+	if self.show_prompt then
+		print(self.prompt_message)
+	end
+
 	local char = util.get_user_input_char()
+
+	vim.cmd.redraw()
+
 	self.hint:clear()
 
 	if char then

lua/window-picker/util.lua

@@ -27,7 +27,6 @@ function M.map_find(tbl, match_func)
 end
 
 function M.get_user_input_char()
-	print('Window: ')
 	local c = vim.fn.getchar()
 	while type(c) ~= 'number' do
 		c = vim.fn.getchar()