Merge branch 'release/2.0'

Author: s1n7ax

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*.lua]
+charset = utf-8
+indent_style = tab
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true

.luacheckrc

@@ -0,0 +1,14 @@
+ignore = {
+  "631",    -- max_line_length
+}
+
+globals = {
+  "vim.o",
+  "vim.wo",
+}
+read_globals = {
+  "vim",
+  "describe",
+  "it",
+  "assert"
+}

.luarc.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
+    "Lua.diagnostics.globals": [
+        "vim"
+    ]
+}

README.md

@@ -1,92 +1,130 @@
 # nvim-window-picker
 
-https://user-images.githubusercontent.com/18459807/161597479-a3d8cf73-3dca-44b1-9eb6-d00b4e6eb842.mp4
+`hint = 'floating-big-letter'`
 
-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.
+`hint = 'statusline-winbar'`
+
+This plugins prompts the user to pick a window and returns the window id of the
+picked window.
 
 ## Install
 
-#### packer
+### lazy
 
 ```lua
-use {
+{
     's1n7ax/nvim-window-picker',
-    tag = 'v1.*',
+    name = 'window-picker',
+    event = 'VeryLazy',
+    version = '2.*',
     config = function()
         require'window-picker'.setup()
     end,
 }
 ```
 
-**Make sure to `:PackerCompile` after installing**
-
-## How to use
+### packer
 
 ```lua
-local picked_window_id = require('window-picker').pick_window()
+use {
+    's1n7ax/nvim-window-picker',
+    tag = 'v2.*',
+    config = function()
+        require'window-picker'.setup()
+    end,
+}
 ```
 
-**You can put the picked window id to good use**,
-for example, set a keymap to switch the current window like this:
+## How to use
 
 ```lua
-vim.keymap.set("n", "<leader>w", function()
-    local picked_window_id = picker.pick_window() or vim.api.nvim_get_current_win()
-    vim.api.nvim_set_current_win(picked_window_id)
-end, { desc = "Pick a window" })
+local picked_window_id = require('window-picker').pick_window()
 ```
 
+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,
+    -- type of hints you want to get
+    -- following types are supported
+    -- 'statusline-winbar' | 'floating-big-letter'
+    -- 'statusline-winbar' draw on 'statusline' if possible, if not 'winbar' will be
+    -- 'floating-big-letter' draw big letter on a floating window
+    -- used
+    hint = 'statusline-winbar',
 
     -- 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',
 
-    -- 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 = 'never', -- "always" | "never" | "smart"
+    -- This section contains picker specific configurations
+    picker_config = {
+        statusline_winbar_picker = {
+            -- You can change the display string in status bar.
+            -- It supports '%' printf style. Such as `return char .. ': %f'` to display
+            -- buffer file path. 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 = 'never', -- "always" | "never" | "smart"
+        },
+
+        floating_big_letter = {
+            -- window picker plugin provides bunch of big letter fonts
+            -- fonts will be lazy loaded as they are being requested
+            -- additionally, user can pass in a table of fonts in to font
+            -- property to use instead
+
+            font = 'ansi-shadow', -- ansi-shadow |
+        },
+    },
 
     -- 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
+    -- 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
     filter_func = nil,
 
     -- following filters are only applied when you are using the default filter
-    -- defined by this plugin. if you pass in a function to "filter_func"
+    -- 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' },
         },
 
@@ -102,32 +140,48 @@ 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',
-
-    -- all the windows except the curren window will be highlighted using this
-    -- color
-    other_win_hl_color = '#44cc41',
-
-    -- 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) return char end,
+    -- You can pass in the highlight name or a table of content to set as
+    -- highlight
+    highlights = {
+        statusline = {
+            focused = {
+                fg = '#ededed',
+                bg = '#e35e4f',
+                bold = true,
+            },
+            unfocused = {
+                fg = '#ededed',
+                bg = '#44cc41',
+                bold = true,
+            },
+        },
+        winbar = {
+            focused = {
+                fg = '#ededed',
+                bg = '#e35e4f',
+                bold = true,
+            },
+            unfocused = {
+                fg = '#ededed',
+                bg = '#44cc41',
+                bold = true,
+            },
+        },
+    },
 })
 ```
 
 ```lua
-require(package_name).pick_window({
-    include_current_win = true,
-    selection_chars = '123345',
-    filter_rules = {
-        bo = {
-            filetype = {'markdown'}
-        }
-    },
+require('window-picker').pick_window({
+    hint = 'floating-big-letter'
 })
 ```
+
+## 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.

dev/init.lua

@@ -1,33 +1,42 @@
 --[[
 -- plugin name will be used to reload the loaded modules
---]] local package_name = 'window-picker'
+--]]
+local package_name = 'window-picker'
 
 -- add the escape character to special characters
 local escape_pattern = function(text)
-    return text:gsub('([^%w])', '%%%1')
+	return text:gsub('([^%w])', '%%%1')
 end
 
 -- unload loaded modules by the matching text
 local unload_packages = function()
-    local esc_package_name = escape_pattern(package_name)
+	local esc_package_name = escape_pattern(package_name)
 
-    for module_name, _ in pairs(package.loaded) do
-        if string.find(module_name, esc_package_name) then
-            package.loaded[module_name] = nil
-        end
-    end
+	for module_name, _ in pairs(package.loaded) do
+		if string.find(module_name, esc_package_name) then
+			package.loaded[module_name] = nil
+		end
+	end
 end
 
 -- executes the run method in the package
 local run_action = function()
-    require(package_name).setup()
-    print('you picked: ', require(package_name).pick_window())
+	require(package_name).setup()
+	local window = require(package_name).pick_window()
+
+	vim.pretty_print('>>>', window)
+
+	if not window then
+		return
+	end
+
+	vim.api.nvim_set_current_win(window)
 end
 
 -- unload and run the function from the package
 function Reload_and_run()
-    unload_packages()
-    run_action()
+	unload_packages()
+	run_action()
 end
 
 ---@diagnostic disable-next-line: undefined-global

lua/window-picker/builder.lua

@@ -0,0 +1,53 @@
+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-winbar-hint')
+local dconfigurer = require('window-picker.configurer')
+
+--- @class DefaultBuilder
+--- @field configurer Configurer
+local M = {}
+
+function M:new(configurer)
+	local o = { configurer = configurer }
+
+	setmetatable(o, self)
+	self.__index = self
+
+	return self
+end
+
+function M:set_config(config)
+	self.config = config
+	return self
+end
+
+function M:set_picker(picker)
+	self.picker = picker
+	return self
+end
+
+function M:set_hint(hint)
+	self.hint = hint
+	return self
+end
+
+function M:set_filter(filter)
+	self.filter = filter
+	return self
+end
+
+function M:build()
+	local configurer = self.configurer or dconfigurer:new(self.config)
+
+	local hint = configurer:config_hint(self.hint or dhint:new())
+	local filter = configurer:config_filter(self.filter or dfilter:new())
+	local picker = configurer:config_picker(self.picker or dpicker:new())
+
+	picker:set_filter(filter)
+	picker:set_hint(hint)
+
+	return picker
+end
+
+return M