From 654b11aa08e54255a55625e6bca514b9659b7896 Mon Sep 17 00:00:00 2001 From: Ben Smith <37027883+smithbm2316@users.noreply.github.com> Date: Mon, 31 May 2021 02:12:18 +0000 Subject: [PATCH] Change the `show_all_buffers` option to true by default for `buffers` picker (#858) * show_all_buffers true by default, added docs * [docgen] Update doc/telescope.txt skip-checks: true * fix for docs, used param instead of field oops * [docgen] Update doc/telescope.txt skip-checks: true Co-authored-by: Github Actions --- doc/telescope.txt | 9 +++++++++ lua/telescope/builtin/init.lua | 3 +++ lua/telescope/builtin/internal.lua | 3 ++- 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/doc/telescope.txt b/doc/telescope.txt index dfe5a65..ee0aa6a 100644 --- a/doc/telescope.txt +++ b/doc/telescope.txt @@ -672,6 +672,15 @@ builtin.buffers({opts}) *builtin.buffers()* Parameters: ~ {opts} (table) options to pass to the picker + Fields: ~ + {show_all_buffers} (boolean) if true, show all buffers, including + unloaded buffers (default true) + {ignore_current_buffer} (boolean) if true, don't show the current + buffer in the list (default false) + {only_cwd} (boolean) if true, only show buffers in the + current working directory (default + false) + builtin.colorscheme({opts}) *builtin.colorscheme()* Lists available colorschemes and applies them on `` diff --git a/lua/telescope/builtin/init.lua b/lua/telescope/builtin/init.lua index 2dd384a..9958919 100644 --- a/lua/telescope/builtin/init.lua +++ b/lua/telescope/builtin/init.lua @@ -207,6 +207,9 @@ builtin.reloader = require('telescope.builtin.internal').reloader --- Lists open buffers in current neovim instance, opens selected buffer on `` ---@param opts table: options to pass to the picker +---@field show_all_buffers boolean: if true, show all buffers, including unloaded buffers (default true) +---@field ignore_current_buffer boolean: if true, don't show the current buffer in the list (default false) +---@field only_cwd boolean: if true, only show buffers in the current working directory (default false) builtin.buffers = require('telescope.builtin.internal').buffers --- Lists available colorschemes and applies them on `` diff --git a/lua/telescope/builtin/internal.lua b/lua/telescope/builtin/internal.lua index 2c4695f..6235ddf 100644 --- a/lua/telescope/builtin/internal.lua +++ b/lua/telescope/builtin/internal.lua @@ -563,7 +563,8 @@ internal.buffers = function(opts) if 1 ~= vim.fn.buflisted(b) then return false end - if not opts.show_all_buffers and not vim.api.nvim_buf_is_loaded(b) then + -- only hide unloaded buffers if opts.show_all_buffers is false, keep them listed if true or nil + if opts.show_all_buffers == false and not vim.api.nvim_buf_is_loaded(b) then return false end if opts.ignore_current_buffer and b == vim.api.nvim_get_current_buf() then