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

Merge pull request #20097 from clason/ts-syntax-off

Browse Source 
fix(treesitter): don't support legacy syntax in start()
This commit is contained in:
bfredl 2022-09-06 19:57:07 +02:00 committed by GitHub
commit aaa54a8b3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
runtime/doc/treesitter.txt
View File

@ -446,20 +446,21 @@ node_contains({node}, {range}) *node_contains()*
Return: ~
(boolean) True if the node contains the range
start({bufnr}, {lang}, {opts}) *start()*
start({bufnr}, {lang}) *start()*
Start treesitter highlighting for a buffer
Can be used in an ftplugin or FileType autocommand
Note: By default, disables regex syntax highlighting, which may be
required for some plugins. In this case, add `{ syntax = true }`.
required for some plugins. In this case, add vim.bo.syntax = 'on `after the call to` start`.
Example:
>
vim.api.nvim_create_autocmd( 'FileType', { pattern = 'tex',
callback = function(args)
vim.treesitter.start(args.buf, 'latex', { syntax = true })
vim.treesitter.start(args.buf, 'latex')
vim.bo[args.buf].syntax = 'on' -- only if additional legacy syntax is needed
end
})
<
@ -469,9 +470,6 @@ start({bufnr}, {lang}, {opts}) *start()*
buffer)
{lang} (string|nil) Language of the parser (default: buffer
filetype)
{opts} (table|nil) Optional keyword arguments:
• `syntax` boolean Run regex syntax highlighting (default
false)
stop({bufnr}) *stop()*
Stop treesitter highlighting for a buffer

13
runtime/lua/vim/treesitter.lua
View File

@ -250,23 +250,22 @@ end
--- Can be used in an ftplugin or FileType autocommand
---
--- Note: By default, disables regex syntax highlighting, which may be required for some plugins.
--- In this case, add `{ syntax = true }`.
--- In this case, add `vim.bo.syntax = 'on'` after the call to `start`.
---
--- Example:
---
--- <pre>
--- vim.api.nvim_create_autocmd( 'FileType', { pattern = 'tex',
--- callback = function(args)
--- vim.treesitter.start(args.buf, 'latex', { syntax = true })
--- vim.treesitter.start(args.buf, 'latex')
--- vim.bo[args.buf].syntax = 'on' -- only if additional legacy syntax is needed
--- end
--- })
--- </pre>
---
---@param bufnr number|nil Buffer to be highlighted (default: current buffer)
---@param lang string|nil Language of the parser (default: buffer filetype)
---@param opts table|nil Optional keyword arguments:
--- - `syntax` boolean Run regex syntax highlighting (default false)
function M.start(bufnr, lang, opts)
function M.start(bufnr, lang)
bufnr = bufnr or a.nvim_get_current_buf()
local parser = M.get_parser(bufnr, lang)
@ -274,10 +273,6 @@ function M.start(bufnr, lang, opts)
M.highlighter.new(parser)
vim.b[bufnr].ts_highlight = true
if opts and opts.syntax then
vim.bo[bufnr].syntax = 'on'
end
end
---Stop treesitter highlighting for a buffer