Awesome

telescope-menufacture

telescope-menufacture is an extension for telescope.nvim. It extends built-in pickers (find_files, live_grep, grep_string and git_files) with the menu that allows to toggle/change such picker options as include hidden dirs, include ignored files, search in particular folders etc.

Demo

Installation

-- install as usual e.g. with packer
use { 'molecule-man/telescope-menufacture' }

-- To get telescope-menufacture loaded and working with telescope,
-- you need to call load_extension:
require('telescope').load_extension 'menufacture'

Usage

replace your standard find_files grep_string live_grep and git_files mappings

vim.keymap.set('n', '<leader>sf', require('telescope.builtin').find_files)
vim.keymap.set('n', '<leader>sw', require('telescope.builtin').grep_string)
vim.keymap.set('n', '<leader>sg', require('telescope.builtin').live_grep)
vim.keymap.set('n', '<leader>gf', require('telescope.builtin').git_files)
vim.keymap.set('n', '<leader>so', require('telescope.builtin').oldfiles)

with the ones provided by this extension:

vim.keymap.set('n', '<leader>sf', require('telescope').extensions.menufacture.find_files)
vim.keymap.set('n', '<leader>sg', require('telescope').extensions.menufacture.live_grep)
vim.keymap.set('n', '<leader>sw', require('telescope').extensions.menufacture.grep_string)
vim.keymap.set('n', '<leader>gf', require('telescope').extensions.menufacture.git_files)
vim.keymap.set('n', '<leader>so', require('telescope').extensions.menufacture.oldfiles)

then, while using this pickers, press ctrl-^ (ctrl-6) and this will open the menu.

Configuration

You can configure the telescope-menufacture like any other telescope.nvim extension. Here you can change the default mapping ctrl-^ to something else.

require('telescope').setup {
  extensions = {
    menufacture = {
      mappings = {
        main_menu = { [{ 'i', 'n' }] = '<C-^>' },
        -- it's possible to assign direct mappings to menu item actions here.
        -- List of available actions can be found in the table in the end of
        -- README
        -- toggle_hidden = { i = '<C-h>' },
      },
    },
  },
}

Customization

Add direct mapping to invoke menu actions

It's possible to specify mappings that can invoke menufacture menu actions directly (without telescope picker that allows you to select the menu item):

vim.keymap.set('n', '<leader>sg', function()
  telescope.extensions.menufacture.live_grep {
    menufacture = {
      mappings = {
        -- [{ 'i', 'n' }] = {
        i = {
          ['<c-d>'] = telescope.extensions.menufacture.menu_actions.search_in_directory.action,
        },
      },
    },
  }
end, { desc = '[S]earch using [G]rep (live_grep)' })

In this example ctrl-d should invoke search_in_directory action as if you selected it in menu picker. search_in_directory is only one of multiple actions that can be mapped. Full list of actions can be found in menu_action column in the tables in the next section.

Add your own menu item

It's possible to add your own menu items. To do that you have to extend (or create new one from scratch) the list of menu items with your additional menu entries and corresponding actions. The action takes picker's opts as the first argument and callback as the second argument. The callback must be called with opts in the end of the action. Let's add menu item that changes cwd to the parent of the current cwd:

vim.keymap.set(
  'n',
  '<leader>sf',
  require('telescope').extensions.menufacture.add_menu_with_default_mapping(
    require('telescope.builtin').find_files,
    vim.tbl_extend('force', require('telescope').extensions.menufacture.find_files_menu, {
      ['change cwd to parent'] = function(opts, callback)
        local cwd = opts.cwd and vim.fn.expand(opts.cwd) or vim.loop.cwd()
        opts.cwd = vim.fn.fnamemodify(cwd, ':p:h:h')
        callback(opts)
      end,
    })
  )
)

Menus available by default

find_files

live_grep

grep_string

git_files

oldfiles