Neovim + ddu.vim で自動的にフィルタを開く方法

1$ nvim --version
2NVIM v0.10.1
3Build type: Release
4LuaJIT 2.1.1713773202

1ddu.vim: commit f6480d2
2ddu-ui-ff: commit c1a8644

 1-- バグがあったため修正（2024/11/26）
 2
 3-- オートコマンドを削除する時の目印となるグループを設定
 4-- グループ名は任意の値に設定できる
 5local ddu_vim_autocmd_group = vim.api.nvim_create_augroup('ddu_vim', {})
 6
 7-- 自動的に絞り込みを開始するソースは、ヘルプとファイルとする。
 8vim.keymap.set('n', ';h', function() Ddu_start_with_filter_window('help') end)
 9vim.keymap.set('n', ';f', function() Ddu_start_with_filter_window('file_recursive') end)
10
11-- リスト表示とリストにアイテムが表示されたら絞り込みを開始する設定を行う関数
12function Ddu_start_with_filter_window(source_name)
13  -- 引数で指示されたソースのアイテムリストを表示
14  vim.fn['ddu#start']({name = source_name})
15  -- リストにアイテムが表示されたら絞り込みを開始するというオートコマンドを設定
16  return vim.api.nvim_create_autocmd("User",
17    {
18      -- リストにアイテムが表示された時点をオートコマンドのタイミングに設定
19      pattern = 'Ddu:uiDone',
20      -- 後でオートコマンドを削除するための目印としてグループを設定
21      group = ddu_vim_autocmd_group,
22      nested = true,
23      callback = function()
24        -- 絞り込みを開始する
25        vim.fn['ddu#ui#async_action']('openFilterWindow')
26      end,
27    }
28  )
29end
30
31-- 絞り込み終了時点で `Ddu_start_with_filter_window()` 関数で設定したオートコマンドを
32-- 削除するというオートコマンドを設定する
33vim.api.nvim_create_autocmd({'User'},
34  {
35    -- 絞り込みウィンドウを抜けた時点を自動コマンド実行のタイミングに設定
36    pattern = 'Ddu:ui:ff:closeFilterWindow',
37    callback = function()
38      -- `Ddu_start_with_filter_window()` 関数で設定したオートコマンドの ID を取得
39      -- 引数を Table で渡すと名前付き引数のように扱える
40      local autocmd_id = Get_autocmd_id({group = ddu_vim_autocmd_group, pattern = 'Ddu:uiDone'})
41      
42      if autocmd_id ~= 0 then
43        -- `Ddu_start_with_filter_window()` 関数で設定したオートコマンドを削除
44        -- これを忘れるとリストを表示するたびに絞り込みが始まってしまう
45        vim.api.nvim_del_autocmd(autocmd_id)
46      end
47    end
48  }
49)
50
51-- 引数に対応するオートコマンドの ID を返す関数
52-- 引数は Table で渡されているので `args.xx` の形で取り出す
53function Get_autocmd_id(args)
54  local pcall_result, function_return = pcall(
55    vim.api.nvim_get_autocmds, { group = args.group, pattern = { args.pattern } }
56  )
57  if pcall_result then
58    return function_return[1].id -- lua の配列の添字は 1 から始まる
59  else
60    return 0
61  end
62end