feat(filetype): vim.filetype.inspect() returns copy of registry #38831

Problem: No way of inspecting the (user-added) filetype detection rules.

Solution: Add `vim.filetype.inspect()` returning copies of the internal
`extension`, `filename`, `pattern` tables. Due to the dynamic nature of
filetype detection, this will in general not allow getting the list of
known filetypes, but at least one can see if a given extension is known.
This commit is contained in:
Christian Clason
2026-04-06 18:48:42 +02:00
committed by GitHub
parent 889572a358
commit bdc72a0843
3 changed files with 32 additions and 1 deletions

View File

@@ -3296,4 +3296,20 @@ function M.get_option(filetype, option)
return require('vim.filetype.options').get_option(filetype, option)
end
--- Inspect the current state of the filetype registry.
---
--- Returns a copy of the internal tables used for filetype detection by extension, filename, or
--- pattern. Note: Due to the dynamic nature of filetype detection, this is only useful for checking
--- whether a certain extension, filename, or pattern has been registered so far. In addition, the
--- `pattern` table is in an internal format optimized for fast lookup. Prefer |vim.filetype.match()|
--- for checking the detected filetype for a given pattern.
---@return table<string, table<string, vim.filetype.mapping|table<string, vim.filetype.mapping>>>
function M.inspect()
return {
extension = vim.deepcopy(extension),
filename = vim.deepcopy(filename),
pattern = vim.deepcopy(pattern),
}
end
return M