kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

fix(filetype): call on_detect before setting buffer filetype

Browse Source 
The on_detect functions returned by filetype.lua set buffer local
variables which are often used by filetype plugins. For example, the
on_detect function for shell buffers sets variables such as b:is_bash or
b:is_sh, which are used by the sh ftplugin.

When called after setting the buffer's filetype, these variables cannot
be used by the ftplugin (because they are not yet defined). Instead,
call on_detect before setting the buffer filetype so that any buffer
variables set by on_detect can be used in the ftplugin.
This commit is contained in:
Gregory Anders 2023-08-24 12:48:21 -05:00
parent daf7abbc42
commit 020d1f626a
3 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
runtime/doc/lua.txt
View File

@ -2600,7 +2600,8 @@ vim.filetype.add({filetypes}) *vim.filetype.add()*
matched pattern, if any) and should return a string that will be used as matched pattern, if any) and should return a string that will be used as
the buffer's filetype. Optionally, the function can return a second the buffer's filetype. Optionally, the function can return a second
function value which, when called, modifies the state of the buffer. This function value which, when called, modifies the state of the buffer. This
can be used to, for example, set filetype-specific buffer variables. can be used to, for example, set filetype-specific buffer variables. This
function will be called by Nvim before setting the buffer's filetype.
Filename patterns can specify an optional priority to resolve cases when a Filename patterns can specify an optional priority to resolve cases when a
file path matches multiple patterns. Higher priorities are matched first. file path matches multiple patterns. Higher priorities are matched first.

9
runtime/filetype.lua
View File

@ -18,12 +18,15 @@ vim.api.nvim_create_autocmd({ 'BufRead', 'BufNewFile', 'StdinReadPost' }, {
end) end)
end end
else else
vim.api.nvim_buf_call(args.buf, function() -- on_detect is called before setting the filetype so that it can set any buffer local
vim.api.nvim_cmd({ cmd = 'setf', args = { ft } }, {}) -- variables that may be used the filetype's ftplugin
end)
if on_detect then if on_detect then
on_detect(args.buf) on_detect(args.buf)
end end
vim.api.nvim_buf_call(args.buf, function()
vim.api.nvim_cmd({ cmd = 'setf', args = { ft } }, {})
end)
end end
end, end,
}) })

3
runtime/lua/vim/filetype.lua
View File

@ -2061,7 +2061,8 @@ end
--- pattern, if any) and should return a string that will be used as the --- pattern, if any) and should return a string that will be used as the
--- buffer's filetype. Optionally, the function can return a second function --- buffer's filetype. Optionally, the function can return a second function
--- value which, when called, modifies the state of the buffer. This can be used --- value which, when called, modifies the state of the buffer. This can be used
--- to, for example, set filetype-specific buffer variables. --- to, for example, set filetype-specific buffer variables. This function will
--- be called by Nvim before setting the buffer's filetype.
--- ---
--- Filename patterns can specify an optional priority to resolve cases when a --- Filename patterns can specify an optional priority to resolve cases when a
--- file path matches multiple patterns. Higher priorities are matched first. --- file path matches multiple patterns. Higher priorities are matched first.