summaryrefslogtreecommitdiffstatshomepage
path: root/test/functional/lua/filetype_spec.lua
blob: ab124028a6935c59762e7ee5bf9a55c35fe3b914 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
local t = require('test.testutil')
local n = require('test.functional.testnvim')()

local exec_lua = n.exec_lua
local eq = t.eq
local api = n.api
local clear = n.clear
local pathroot = n.pathroot
local command = n.command
local mkdir = t.mkdir
local rmdir = n.rmdir
local write_file = t.write_file
local uv = vim.uv

local root = pathroot()

describe('vim.filetype', function()
  before_each(function()
    clear()

    exec_lua(function()
      local bufnr = vim.api.nvim_create_buf(true, false)
      vim.api.nvim_set_current_buf(bufnr)
    end)
  end)

  it('works with extensions', function()
    eq(
      'radicalscript',
      exec_lua(function()
        vim.filetype.add({
          extension = {
            rs = 'radicalscript',
          },
        })
        return vim.filetype.match({ filename = 'main.rs' })
      end)
    )
  end)

  it('prioritizes filenames over extensions', function()
    eq(
      'somethingelse',
      exec_lua(function()
        vim.filetype.add({
          extension = {
            rs = 'radicalscript',
          },
          filename = {
            ['main.rs'] = 'somethingelse',
          },
        })
        return vim.filetype.match({ filename = 'main.rs' })
      end)
    )
  end)

  it('works with filenames that call _getlines() internally #36272', function()
    eq(
      'sh',
      exec_lua(function()
        return vim.filetype.match({ filename = 'main.sh' })
      end)
    )
  end)

  it('works with filenames that call _getline() internally #36272', function()
    eq(
      'text',
      exec_lua(function()
        return vim.filetype.match({ filename = 'main.txt' })
      end)
    )
  end)

  it('works without defined g:ft_ignore_pat', function()
    local match_opts = { filename = 'unknown-ft', buf = api.nvim_create_buf(false, true) }
    eq(
      nil,
      exec_lua(function()
        vim.g.ft_ignore_pat = nil
        return vim.filetype.match(match_opts)
      end)
    )
  end)

  it('works with filenames', function()
    eq(
      'nim',
      exec_lua(function()
        vim.filetype.add({
          filename = {
            ['s_O_m_e_F_i_l_e'] = 'nim',
          },
        })
        return vim.filetype.match({ filename = 's_O_m_e_F_i_l_e' })
      end)
    )

    eq(
      'dosini',
      exec_lua(function()
        vim.filetype.add({
          filename = {
            ['config'] = 'toml',
            [root .. '/.config/fun/config'] = 'dosini',
          },
        })
        return vim.filetype.match({ filename = root .. '/.config/fun/config' })
      end)
    )
  end)

  it('works with patterns', function()
    eq(
      'markdown',
      exec_lua(function()
        vim.env.HOME = '/a-funky+home%dir'
        vim.filetype.add({
          pattern = {
            ['~/blog/.*%.txt'] = 'markdown',
          },
        })
        return vim.filetype.match({ filename = '~/blog/why_neovim_is_awesome.txt' })
      end)
    )
  end)

  it('works with functions', function()
    command('new')
    command('file relevant_to_me')
    eq(
      'foss',
      exec_lua(function()
        vim.filetype.add({
          pattern = {
            ['relevant_to_(%a+)'] = function(_, _, capture)
              if capture == 'me' then
                return 'foss'
              end
            end,
          },
        })
        return vim.filetype.match({ buf = 0 })
      end)
    )
  end)

  it('works with contents #22180', function()
    eq(
      'sh',
      exec_lua(function()
        return (vim.filetype.match({ contents = { '#!/usr/bin/env bash' } }))
      end)
    )
  end)

  it('considers extension mappings when matching from hashbang', function()
    eq(
      'fooscript',
      exec_lua(function()
        vim.filetype.add({
          extension = {
            foo = 'fooscript',
          },
        })
        return vim.filetype.match({ contents = { '#!/usr/bin/env foo' } })
      end)
    )
  end)

  it('can get default option values for filetypes via vim.filetype.get_option()', function()
    command('filetype plugin on')

    for ft, opts in pairs {
      lua = { commentstring = '-- %s' },
      vim = { commentstring = '"%s' },
      man = { tagfunc = "v:lua.require'man'.goto_tag" },
      xml = { formatexpr = 'xmlformat#Format()' },
    } do
      for option, value in pairs(opts) do
        eq(
          value,
          exec_lua(function()
            return vim.filetype.get_option(ft, option)
          end)
        )
      end
    end
  end)

  it('.get_option() cleans up buffer on error', function()
    api.nvim_create_autocmd('FileType', { pattern = 'foo', command = 'lua error()' })

    local buf = api.nvim_get_current_buf()

    exec_lua(function()
      pcall(vim.filetype.get_option, 'foo', 'lisp')
    end)

    eq(buf, api.nvim_get_current_buf())
  end)

  it('matches full paths', function()
    mkdir('Xfiletype')
    command('lcd Xfiletype')
    eq(
      'Xfiletype',
      exec_lua(function()
        vim.filetype.add({
          pattern = {
            ['.*/Xfiletype/Xfilename'] = 'Xfiletype',
          },
        })
        return vim.filetype.match({ filename = 'Xfilename' })
      end)
    )
    rmdir('Xfiletype')
  end)

  it('fallback to conf if any of the first five lines start with a #', function()
    eq(
      { 'conf', true },
      exec_lua(function()
        local bufnr = vim.api.nvim_create_buf(true, false)
        local lines = {
          '# foo',
        }
        vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)

        local ft, _, fallback = vim.filetype.match({ buf = bufnr })
        return { ft, fallback }
      end)
    )
  end)
end)

describe('filetype.lua', function()
  before_each(function()
    mkdir('Xfiletype')
  end)

  after_each(function()
    rmdir('Xfiletype')
  end)

  it('does not override user autocommands that set filetype #20333', function()
    clear({
      args = { '--clean', '--cmd', 'autocmd BufRead *.md set filetype=notmarkdown', 'README.md' },
    })
    eq('notmarkdown', api.nvim_get_option_value('filetype', {}))
  end)

  it('uses unexpanded path for matching when editing a symlink #27914', function()
    mkdir('Xfiletype/.config')
    mkdir('Xfiletype/actual')
    write_file('Xfiletype/actual/config', '')
    uv.fs_symlink(assert(uv.fs_realpath('Xfiletype/actual')), 'Xfiletype/.config/git')
    finally(function()
      uv.fs_unlink('Xfiletype/.config/git')
    end)
    local args = { '--clean', 'Xfiletype/.config/git/config' }
    clear({ args = args })
    eq('gitconfig', api.nvim_get_option_value('filetype', {}))
    table.insert(args, 2, '--cmd')
    table.insert(args, 3, "autocmd BufRead * call expand('<afile>')")
    clear({ args = args })
    eq('gitconfig', api.nvim_get_option_value('filetype', {}))
  end)

  it('works with :doautocmd BufRead #31306', function()
    clear({ args = { '--clean' } })
    eq('', api.nvim_get_option_value('filetype', {}))
    command('doautocmd BufRead README.md')
    eq('markdown', api.nvim_get_option_value('filetype', {}))
  end)
end)