diff options
| author | Thomas Vanbesien <tvanbesi@proton.me> | 2026-06-11 20:21:03 +0200 |
|---|---|---|
| committer | Thomas Vanbesien <tvanbesi@proton.me> | 2026-06-11 21:19:10 +0200 |
| commit | 5f860d807cf6f5045848ce3d7b667ae8d1b906eb (patch) | |
| tree | 2d6c62b432da85e34a1bcb10bd77c4c90d98aa60 /plugin | |
| parent | b202753390bb7f9e37e289cad0cec2341781de83 (diff) | |
| download | nvim-config-5f860d807cf6f5045848ce3d7b667ae8d1b906eb.tar.gz nvim-config-5f860d807cf6f5045848ce3d7b667ae8d1b906eb.zip | |
docs(nvim): edit comments
Diffstat (limited to 'plugin')
| -rw-r--r-- | plugin/10-treesitter.lua | 18 | ||||
| -rw-r--r-- | plugin/50-format.lua | 5 |
2 files changed, 14 insertions, 9 deletions
diff --git a/plugin/10-treesitter.lua b/plugin/10-treesitter.lua index 8bb9be1..c0879b6 100644 --- a/plugin/10-treesitter.lua +++ b/plugin/10-treesitter.lua @@ -1,5 +1,10 @@ -- --- Treesitter parsers +-- 10-treesitter.lua +-- +-- * Installs treesitter parsers. +-- * Sets up an autocommand to parse the tree synchronously on 'FileType'. +-- This file should sort early (alphabetically) in plugin/ so that this autcommand triggers before other autcommands +-- that use the tree. -- require("nvim-treesitter").install({ @@ -16,11 +21,10 @@ require("nvim-treesitter").install({ "vimdoc", }) --- Parse the tree as early as possible, which is as soon as we know the filetype --- --- Event handlers for the same event are triggered in the order they were created. This must be the first FileType --- handler created so that the tree is parsed for other FileType handlers (which often need the parsed tree). To create --- it first put this in a file that comes before alphabetically in the `plugin/` directory. +-- Parse the tree synchronously as early as possible (which is as soon as we know the filetype) +-- This can be useful for example so that the tree is ready before any other code calls vim.treesitter.get_node(), which +-- returns nil when the tree is not parsed. +-- TODO actually test it vim.api.nvim_create_autocmd("FileType", { desc = "Start treesitter", group = vim.g.dotfiles.augroup, @@ -29,7 +33,7 @@ vim.api.nvim_create_autocmd("FileType", { if parser == nil then return end - parser:parse() -- Parse once asynchronously; used by logic that needs the parsed tree (like extmarks) + parser:parse() vim.treesitter.start() end, }) diff --git a/plugin/50-format.lua b/plugin/50-format.lua index 46a245c..b471e1b 100644 --- a/plugin/50-format.lua +++ b/plugin/50-format.lua @@ -1,10 +1,11 @@ -- -- 50-format.lua -- --- Specifies the formatters to use for different file types and sets up a global autocommand to trigger them. +-- * Specifies the formatters to use for different file types. +-- * Sets up an autocommand to format on 'BufWritePre'. -- -- User commands: --- FormatToggle: toggle formatting on save on/off for the current buffer +-- FormatToggle: toggle formatting on write for the current buffer local function toggle_format() vim.b.format = not vim.b.format |