fix: support compound file-types #3145

baodrate · 2024-05-09T15:25:43Z

Vim supports compound filetypes (see |'filetype'|):

When a dot appears in the value then this separates two filetype names.
This works both for filetype plugins and for syntax files. More than one dot may appear.

nvim-lspconfig currently always compares the full 'filetype' option against the configured filetypes. So buffers set to multiple filetypes will not match at all.

Fix utility functions to match against each individual filetype

glepnir · 2024-05-10T05:55:57Z

lua/lspconfig/util.lua

+---@param filetype string the filetype to check (can be a compound, dot-separated filetype; see |'filetype'|)
+---@param expected string|string[] the filetype(s) to match against
+---@return boolean
+function M.ft_matches(filetype, expected)


there has vim.fs module.

sorry, can you explain? I don't see anything in vim.fs that does this. vim.fs seems to deal mostly with filesystem operations. I'm not actually reading files here, I am only splitting and comparing filetype strings

okay see vim.filetype moudle. vim.filetype.match will return the filetype if it already in default detect table or register by vim.filetype.add . we don't want add more utils function now

vim.filetype.match takes an existing buffer and returns the filetype (using the rules defined in filetype.lua). the result of that might be (for example) c.doxygen. see |'filetype'|:

*'filetype'* *'ft'* 'filetype' 'ft' string (default "") local to buffer |local-noglobal| ... Setting this option to a different value is most useful in a modeline, for a file for which the file type is not automatically recognized. Example, for in an IDL file: >c /* vim: set filetype=idl : */ < |FileType| |filetypes| When a dot appears in the value then this separates two filetype names. Example: >c /* vim: set filetype=c.doxygen : */ < This will use the "c" filetype first, then the "doxygen" filetype. This works both for filetype plugins and for syntax files. More than one dot may appear. This option is not copied to another buffer, independent of the 's' or 'S' flag in 'cpoptions'. Only normal file name characters can be used, `/\*?[|<>` are illegal.

In other words:

local ft = vim.filetype.match({buf=0}) ft == "c.doxygen" util.ft_matches(ft, 'idl') == false util.ft_matches(ft, 'c') == true util.ft_matches(ft, 'doxygen') == true

you can also pass filename into match

-- Using a filename without a buffer vim.filetype.match({ filename = 'main.lua' }) -- Using file contents vim.filetype.match({ contents = {'#!/usr/bin/env bash'} })

yes, vim.filetype.match can take a filename and give us a filetype. but what we want is to take that filetype and check it against a list of filetypes (e.g. the ones supported by a particular lsp server).

i.e.

local ft = vim.filetype.match({ filename = 'main.lua' }) ft == "lua" local filetypes_supported_by_current_client = { "lua", "sh", "c" } util.ft_matches(ft, filetypes_supported_by_current_client) == true

Usually this would just be a == comparison but because a filetype can contain multiple filetypes (e.g. c.doxygen), we have to split it first.

local ft = vim.bo.filetype ft == "yaml.ansible" -- this is not a filename! it is a _compound_ filetype util.ft_matches(ft, "ansible") == true util.ft_matches(ft, "yaml") == true

notice that vim.filetype.match doesn't help us do this comparison! it takes a buffer/file/filepath and gives us a filetype. but we don't need that. we have a filetype, it is provided by the caller. We are trying to match that against a list of acceptable filetypes, also provided by the caller.

thanks for your kind reply . does register a filetype by using vim.filetype.add for a special file not make sense in user side ?

A completely unique type is not desirable because we want to use the existing behaviors defined for the primary filetype. see mfussenegger/nvim-ansible or pearofducks/ansible-vim. They both set ft=yaml.ansible.

You want ansible scripts to have the yaml filetype because that's what they are; we want (neo)vim to keep recognizing them as yaml files. if we set ft=ansible only, we lose the syntax highlighting/match_words/etc defined for yaml files.

But the plugin additionally sets various useful options like keywordprg/path/iskeyword/isfname for ansible file types. Hence the reason for multiple file types.

The problem is that right now, nvim-lspconfig diverges from standard vim behavior because filetype matching operates on the entire vim.bo.filetype as a whole, rather than splitting it into individual file types. And every server has to be configured for every possible combination of multiple filetypes. see:

nvim-lspconfig/lua/lspconfig/server_configurations/yamlls.lua

Lines 4 to 6 in a3d9395

default_config = {

cmd = { 'yaml-language-server', '--stdio' },

filetypes = { 'yaml', 'yaml.docker-compose', 'yaml.gitlab' },

(notice that yaml.ansible is not included.

With this change, you can instead just specify yaml, and we'll match as long as one of your filetypes matches yaml

justinmk · 2024-05-11T14:00:34Z

lua/lspconfig/util.lua

@@ -21,6 +21,21 @@ M.default_config = {
 -- global on_setup hook
 M.on_setup = nil

+---@param filetype string the filetype to check (can be a compound, dot-separated filetype; see |'filetype'|)


this new function has no docstring explaining its purpose. and this PR has a wall of text discussing it.

how in the world is anyone supposed know when to use this

apologies, I didn't realize that it was unclear. I've added documentation. let me know if it's unclear

doesn't look like there is a summary docstring. also a couple input => output examples would go a long way.

filetype "foo.bar" matches expected "..."

Vim supports compound filetypes (see |'filetype'|): > When a dot appears in the value then this separates two filetype names. > This works both for filetype plugins and for syntax files. More than one dot may appear. nvim-lspconfig currently always compares the full 'filetype' option against the configured filetypes. So buffers set to multiple filetypes will not match at all. Fix utility functions to match against each individual filetype

justinmk · 2024-10-01T13:13:16Z

lua/lspconfig/server_configurations/elmls.lua

@@ -10,7 +10,7 @@ return {
    filetypes = { 'elm' },
    root_dir = function(fname)
      local filetype = api.nvim_buf_get_option(0, 'filetype')
-      if filetype == 'elm' or (filetype == 'json' and fname:match 'elm%.json$') then
+      if util.ft_matches(filetype, 'elm') or (util.ft_matches(filetype, 'json') and fname:match 'elm%.json$') then


why can't we use vim.filetype.match with the fname, here? (note: the parens in the code below are important because match() has multi-value return)

if 'elm' == (vim.filetype.match({filename=name}))

Been a while since I looked at this code, but I think that should work. I just didn't want to change the semantics of the existing code. e.g. your suggested check wouldn't match files with a manually set filetype; although I'm not sure if that is a negligible difference or not. Would lspconfig even spawn a server for e.g. foobar.txt where the user calls :set filetype=elm?

In any case, and in retrospect, I think this check could have be simplified down to:

if util.ft_matches(filetype, 'elm') then

since util.ft_matches(filetype, 'elm') should match both elm and elm.json

upon further thinking, I think vim.filetype.match will also fail when filetype is set via autocmd rather than filetype.lua. e.g. if we follow the suggestion from the sixtyfps server config:

nvim-lspconfig/lua/lspconfig/configs/sixtyfps.lua

Lines 17 to 23 in aa615f6

Vim does not have built-in syntax for the `sixtyfps` filetype currently.

This can be added via an autocmd:

```lua

vim.cmd [[ autocmd BufRead,BufNewFile *.60 set filetype=sixtyfps ]]

```

opening foo.60 will set filetype to sixtyfps but vim.filetype.match({filename=fname}) will return nil

see #3145 (comment)

justinmk · 2024-10-01T13:14:50Z

lua/lspconfig/util.lua

-          table.insert(other_matching_configs, config)
-        end
+      if M.ft_matches(filetype, filetypes) then
+        table.insert(other_matching_configs, config)


these changes seem like they might be useful, but ft_matches could stay private, it doesn't need to be a new public function.

configs themselves can use vim.filetype.match() as shown in #3145 (comment)

See: concerns raised in #3145 (comment)

Even so, it's not acceptable to introduce another public API to lspconfig, we are trying to shrink it and upstream its API to Nvim core so that lspconfig is mostly "data-only".

I also strongly suspect that configs themselves don't need this new API.

justinmk · 2024-10-01T13:15:45Z

needs a rebase since #3330

baodrate · 2024-10-01T16:42:49Z

rebase is ready, pending answers to questions raised in #3145 (comment)

justinmk · 2024-10-03T20:46:29Z

I think vim.filetype.match will also fail when filetype is set via autocmd rather than filetype.lu

vim.filetype.get_option() is designed to handle that situation.

So, to be clear:

it looks like your internal changes to util.lua in this PR could make sense
but configs themselves should find another way to meet this use-case (and if you can find an satisfactory answer to that, we can document it in lspconfig's help/CONTRIBUTING.md/etc).
- please take a close look at the functions on vim.filetype.*

baodrate requested a review from glepnir as a code owner May 9, 2024 15:25

glepnir reviewed May 10, 2024

View reviewed changes

justinmk reviewed May 11, 2024

View reviewed changes

baodrate force-pushed the compound-filetypes branch from 9eafc28 to f19c7a0 Compare May 11, 2024 15:16

baodrate force-pushed the compound-filetypes branch from f19c7a0 to 9302785 Compare June 12, 2024 07:44

baodrate force-pushed the compound-filetypes branch from 9302785 to a9430e9 Compare September 10, 2024 14:57

justinmk reviewed Oct 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: support compound file-types #3145

fix: support compound file-types #3145

baodrate commented May 9, 2024

glepnir May 10, 2024

baodrate May 10, 2024

glepnir May 10, 2024

baodrate May 10, 2024

glepnir May 10, 2024 •

edited

Loading

baodrate May 10, 2024 •

edited

Loading

glepnir May 10, 2024 •

edited

Loading

baodrate May 10, 2024

justinmk May 11, 2024

baodrate May 11, 2024

justinmk Oct 1, 2024

justinmk Oct 1, 2024

baodrate Oct 1, 2024

baodrate Oct 1, 2024

baodrate Oct 1, 2024

justinmk Oct 3, 2024

justinmk Oct 1, 2024 •

edited

Loading

baodrate Oct 1, 2024

justinmk Oct 3, 2024

justinmk commented Oct 1, 2024

baodrate commented Oct 1, 2024

justinmk commented Oct 3, 2024

	default_config = {
	cmd = { 'yaml-language-server', '--stdio' },
	filetypes = { 'yaml', 'yaml.docker-compose', 'yaml.gitlab' },

	Vim does not have built-in syntax for the `sixtyfps` filetype currently.

	This can be added via an autocmd:

	```lua
	vim.cmd [[ autocmd BufRead,BufNewFile *.60 set filetype=sixtyfps ]]
	```

fix: support compound file-types #3145

Are you sure you want to change the base?

fix: support compound file-types #3145

Conversation

baodrate commented May 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glepnir May 10, 2024 • edited Loading

Choose a reason for hiding this comment

baodrate May 10, 2024 • edited Loading

Choose a reason for hiding this comment

glepnir May 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinmk Oct 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinmk commented Oct 1, 2024

baodrate commented Oct 1, 2024

justinmk commented Oct 3, 2024

glepnir May 10, 2024 •

edited

Loading

baodrate May 10, 2024 •

edited

Loading

glepnir May 10, 2024 •

edited

Loading

justinmk Oct 1, 2024 •

edited

Loading