nvim-treesitter: declarative install of parsers causes errors #189838

NickHu · 2022-09-05T11:12:31Z

Describe the bug

If I install my treesitter parsers declaratively, e.g. as in https://nixos.wiki/wiki/Tree_sitters with nvim-treesitter.withPlugins, starting neovim spawns the following error:

               Error detected while processing /home/nick/.config/nvim/init.vim:                                               
line  136:                                                                                                                     
Parser dir ' /nix/store/zr7p6wy4v4nwigi8ryx8cqhmyf2i1wq3-vim-pack-dir/pack/myNeovimPackages/start/nvim-treesitter/parser ' shou
ld be read/write (see README on how to configure an alternative install location) /nix/store/zr7p6wy4v4nwigi8ryx8cqhmyf2i1wq3-v
im-pack-dir/pack/myNeovimPackages/start/nvim-treesitter/parser '

Expected behavior

No errors

Additional context

I think this was changed recently upstream in nvim-treesitter. Indeed, the README now stipulates that the parser directory must be RW (although I'm not really sure why, so long as one doesn't use the :TSInstall/Update/Remove stuff). Not sure if this error is merely cosmetic or functional (I don't know how to test if treesitter is working properly).

Notify maintainers

@teto

Metadata

Please run nix-shell -p nix-info --run "nix-info -m" and paste the result.

[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"
 - system: `"x86_64-linux"`
 - host os: `Linux 5.15.63, NixOS, 22.11 (Raccoon), 22.11.20220901.2da64a8`
 - multi-user?: `yes`
 - sandbox: `yes`
 - version: `nix-env (Nix) 2.11.0`
 - channels(root): `"home-manager, nixos"`
 - nixpkgs: `/nix/var/nix/profiles/per-user/root/channels/nixos`

The text was updated successfully, but these errors were encountered:

teto · 2022-09-05T11:23:24Z

I've commented on nvim-treesitter/nvim-treesitter#3250, meanwhile revert nvim-treesitter to a previous version.

mdarocha · 2022-09-07T08:52:54Z

This is fixed for me by adding ensure_installed = {} to nvim-treesitter configuration.

teto · 2022-09-07T08:56:06Z

This seems more like a workaround than a proper fix though.

jack-michaud · 2022-09-19T13:05:16Z

Following the instructions in the readme to specify an alternate treesitter plugin installation path worked for me.

In init.vim,

-- Defines a read-write directory for treesitters in nvim's cache dir
local parser_install_dir = vim.fn.stdpath("cache") .. "/treesitters"
vim.fn.mkdir(parser_install_dir, "p")
-- Prevents reinstall of treesitter plugins every boot
vim.opt.runtimepath:append(parser_install_dir)

-- In your treesitter config,
require('nvim-treesitter.configs').setup {
  -- ...
  parser_install_dir = parser_install_dir
}

Updated with @vasyharan's fix to add parser_install_dir to vim's runtimepath, which fixes the reinstall issue.

portothree · 2022-09-19T19:19:16Z

Following the instructions in the readme to specify an alternate treesitter plugin installation path worked for me.

In init.vim,

-- Defines a read-write directory for treesitters in nvim's cache dir
local parser_install_dir = vim.fn.stdpath("cache") .. "/treesitters"
vim.fn.mkdir(parser_install_dir, "p")

-- In your treesitter config,
require('nvim-treesitter.configs').setup {
  -- ...
  parser_install_dir = parser_install_dir
}

Thanks, this worked for me as well.

NickHu · 2022-09-20T00:51:14Z

Does that solution still pick up your declaratively installed tree sitters?

jack-michaud · 2022-09-20T13:01:54Z

Does that solution still pick up your declaratively installed tree sitters?

Unfortunately no -- I specify my treesitter plugins via ensure_installed in the treesitter config.

Another drawback to this approach is that the treesitter parsers seem to re-install every time I open nvim (not sure if @portothree is seeing this too?) - but this may be a separate treesitter bug.

portothree · 2022-09-20T13:03:36Z

Another drawback to this approach is that the treesitter parsers seem to re-install every time I open nvim (not sure if @portothree is seeing this too?) - but this may be a separate treesitter bug.

I haven't encoutered this, no. Unless this is being done in the background, do you get a message of parsers being downloaded everytime you open nvim?

This is a workaround for an issue where treesitter expects the install dir to be readable and writable -- it's not happy with now nix is installing it. Unless there's a patch, the fix will be to manually set the install dir to a good location: NixOS/nixpkgs#189838 (comment)

The nvim change is to workaround this: NixOS/nixpkgs#189838

NixOS/nixpkgs#189838 (comment)

vasyharan · 2022-11-03T03:49:53Z

Another drawback to this approach is that the treesitter parsers seem to re-install every time I open nvim (not sure if @portothree is seeing this too?) - but this may be a separate treesitter bug.

I saw this happen when I didn't append the parser_install_dir to the runtime path. fixed with:

local parser_install_dir = vim.fn.stdpath("cache") .. "/treesitters"
vim.fn.mkdir(parser_install_dir, "p")
vim.opt.runtimepath:append(parser_install_dir)

NixOS/nixpkgs#189838 (comment)

NickHu · 2022-11-21T12:01:54Z

I think this no longer happens now, and one can use pkgs.nvim-treesitter.withAllGrammars without issue (thanks @figsoda!)

jocelynthode · 2022-11-21T12:07:39Z

I can confirm that using withAllGrammars completely fixed the issue on my end.

samhh · 2022-11-21T13:40:40Z

Removing the Lua workarounds and changing from nvim-treesitter to nvim-treesitter.withAllGrammars as of 52b2ac8 causes this on launch for me:

Error detected while processing /home/sam/.config/nvim/plugin/treesitter.lua:
Parser dir ' /nix/store/52lh6vpwsbmghgz6z1hgmh408n675jzh-vim-pack-dir/pack/myNeovimPackages/start/nvim
-treesitter/parser ' should be read/write (see README on how to configure an alternative install locat
ion) /nix/store/52lh6vpwsbmghgz6z1hgmh408n675jzh-vim-pack-dir/pack/myNeovimPackages/start/nvim-treesit
ter/parser '

mdarocha · 2022-11-21T13:50:40Z

Removing the Lua workarounds and changing from nvim-treesitter to nvim-treesitter.withAllGrammars as of 52b2ac8 causes this on launch for me:

Error detected while processing /home/sam/.config/nvim/plugin/treesitter.lua:
Parser dir ' /nix/store/52lh6vpwsbmghgz6z1hgmh408n675jzh-vim-pack-dir/pack/myNeovimPackages/start/nvim
-treesitter/parser ' should be read/write (see README on how to configure an alternative install locat
ion) /nix/store/52lh6vpwsbmghgz6z1hgmh408n675jzh-vim-pack-dir/pack/myNeovimPackages/start/nvim-treesit
ter/parser '

Does not happen in 690ffff026b4e635b46f69002c0f4e81c65dfc2e

figsoda · 2022-11-21T14:20:18Z

@samhh were you trying to run TSInstall? that might have been caused by #201548, does #202196 fix the issue for you?

samhh · 2022-11-21T22:34:01Z

Possibly? I had that error on launch earlier. Just now I tried your PR, and now it works even without the PR in my overlay. Not sure what to make of that. 😅 Thank you in any case!

figsoda · 2022-11-21T22:53:36Z

No problem! I will go ahead and merge that anyways in case it caused the problem

It never really worked, and always seemed to break. Trying some new things. the biggest functional change seems to be changing `nvim-treesitter.withPlugins (plugins: pkgs.tree-sitter.allGrammars)` to `nvim-treesitter.withAllGrammars`. This was foind burried in a github issue [1]. I did not do any research beyond copy and paste. [1]: NixOS/nixpkgs#189838 (comment)

p3t33 · 2022-12-28T20:35:46Z

I stumbled on the same issue as OP and tried to solve by doing the two paths that worked here.

The first is by using withAllGrammars
programs.neovim.plugins = [ pkgs.vimPlugins.nvim-treesitter.withAllGrammars ];
I took the settings from @jocelynthode
And after executing TSModuleInfo I can see that all(most of them) are installed.

The second path was by providing an alternative path and using pkgs.vimPlugins.nvim-treesitter. I was able to provide the languages I wanted and they were installed on the first time I started neovim. And executing TSModuleInfo showed them installed.

The issue is that I see zero efficient on neovim. I made sure that as part of the settings for the plugin highlight = {enable = true, }. As I said I copied the settings from @jocelynthode

I am now not sure if there is some kind of a bug or It is me doing something wrong.

teto · 2022-12-28T21:01:09Z

with @figsoda's guidance, we can now specify the treesitter plugin dependencies 025d862 in case that helps.

p3t33 · 2023-01-04T07:11:14Z

So deciding if treesitter is active only based of shine colors isn't the best approach, especially when there are other settings/plugins that may effect the color scheme.

A better "test" for if treesitter "is working" is to look into something like textobjects(nvim-treesitter-textobjects). A basic test for me(After configuring textobjects) was to try and do visual select a function/inside function and that it is working.

mdarocha · 2023-01-04T16:31:17Z

So deciding if treesitter is active only based of shine colors isn't the best approach, especially when there are other settings/plugins that may effect the color scheme.

A better "test" for if treesitter "is working" is to look into something like textobjects(nvim-treesitter-textobjects). A basic test for me(After configuring textobjects) was to try and do visual select a function/inside function and that it is working.

If you mean manually checking if treesitter is working, there is also :checkhealth

figsoda · 2023-01-04T16:33:09Z

We already check the queries for nvim-treesitter (not textobjects) which is pretty much equivalent to the table in :checkhealth

gshpychka · 2023-01-06T19:37:08Z

Just to confirm - is nvim-treesitter.withPlugins expected to work now?

figsoda · 2023-01-06T19:39:25Z

yes, it can be used like this:

nvim-treesitter.withPlugins (p: [ p.c p.python ])

ghostbuster91 · 2023-01-12T17:57:08Z

It seems to work for all grammars apart from the tree-sitter one itself - tree-sitter-query.
Both checkhealth and TSInstallInfo show that it is installed but once I open *.scm file I get an error message that it cannot be found.

figsoda · 2023-01-12T18:01:26Z

@ghostbuster91 Can you post the error meesages and the relevant parts of your setup?

ghostbuster91 · 2023-01-12T18:19:25Z

It seems to me that there is nothing specific there but yes, here you go:
nix:

 (nvim-treesitter.withPlugins (
        plugins:
          with plugins; [
            tree-sitter-query # for the tree-sitter itself
            tree-sitter-python
            ...and many others
          ]
      ))

full file: https://github.com/ghostbuster91/dot-files/blob/c058ed66f23b85725e96f2dfc35d84e7bd30c48b/programs/neovim/default.nix#L111

lua:

require("nvim-treesitter.configs").setup({
    ensure_installed = {},
    highlight = {
        enable = true, 
        additional_vim_regex_highlighting = false,
        disable = {}, -- treesitter interferes with VimTex
    },
})

full file: https://github.com/ghostbuster91/dot-files/blob/c058ed66f23b85725e96f2dfc35d84e7bd30c48b/programs/neovim/init.lua#L279

The error message:

figsoda · 2023-01-12T18:30:19Z

@ghostbuster91 this seems like it might be an upstream issue, disabling query_linter or renaming the directory to scala could be a temporary solution

ghostbuster91 · 2023-01-12T18:43:21Z

Interesting, disabling query_linter helps indeed. Do you know if there is already an issue for that?

figsoda · 2023-01-12T18:54:18Z

Having taken a brief look at https://github.com/nvim-treesitter/playground, I'm not aware of any issues for this

ghostbuster91 · 2023-01-12T18:56:30Z

Thanks @figsoda, I will then create one.

figsoda · 2023-01-12T19:05:42Z

I opened nvim-treesitter/playground#111 to fix this

ghostbuster91 · 2023-01-12T19:42:42Z

@figsoda Thanks, I appreciate it :)

It never really worked, and always seemed to break. Trying some new things. the biggest functional change seems to be changing `nvim-treesitter.withPlugins (plugins: pkgs.tree-sitter.allGrammars)` to `nvim-treesitter.withAllGrammars`. This was foind burried in a github issue [1]. I did not do any research beyond copy and paste. [1]: NixOS/nixpkgs#189838 (comment)

NickHu added the 0.kind: bug Something is broken label Sep 5, 2022

teto mentioned this issue Sep 5, 2022

No fallback install location nvim-treesitter/nvim-treesitter#3250

Merged

teto added the 6.topic: vim label Sep 7, 2022

pta2002 mentioned this issue Sep 11, 2022

Error with treesitter plugin nix-community/nixvim#39

Closed

linear bot mentioned this issue Sep 19, 2022

fix: define treesitter parser install dir (DOT-79) portothree/dotfiles#145

Merged

samhh added a commit to samhh/dotfiles that referenced this issue Sep 26, 2022

Update inputs

14e0db8

The nvim change is to workaround this: NixOS/nixpkgs#189838

soupglasses mentioned this issue Oct 8, 2022

tree-sitter: Parser dir should be read/write DieracDelta/vimconfig#5

Closed

mandu added a commit to mandu/nixos-config that referenced this issue Oct 11, 2022

fix nvim-treesitter

6a785c3

NixOS/nixpkgs#189838 (comment)

teto mentioned this issue Oct 15, 2022

packDir still can't build with 2 variations of the same plugin #196145

Closed

jack-michaud added a commit to jack-michaud/nix that referenced this issue Nov 6, 2022

fix(nvim): treesitter plugins no longer reinstalled at every boot

e922bd2

NixOS/nixpkgs#189838 (comment)

NickHu closed this as completed Nov 21, 2022

figsoda mentioned this issue Nov 24, 2022

vimPlugins.nvim-treesitter: remove parser directory #202196

Merged

13 tasks

samhh mentioned this issue Jan 12, 2023

Declarative Treesitter parsers samhh/dotfiles#382

Closed

figsoda mentioned this issue Jan 12, 2023

fix: peacefully ignore query files without a valid language nvim-treesitter/playground#111

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nvim-treesitter: declarative install of parsers causes errors #189838

nvim-treesitter: declarative install of parsers causes errors #189838

NickHu commented Sep 5, 2022

teto commented Sep 5, 2022

mdarocha commented Sep 7, 2022

teto commented Sep 7, 2022

jack-michaud commented Sep 19, 2022 •

edited

Loading

portothree commented Sep 19, 2022

NickHu commented Sep 20, 2022

jack-michaud commented Sep 20, 2022

portothree commented Sep 20, 2022

vasyharan commented Nov 3, 2022

NickHu commented Nov 21, 2022

jocelynthode commented Nov 21, 2022

samhh commented Nov 21, 2022

mdarocha commented Nov 21, 2022

figsoda commented Nov 21, 2022

samhh commented Nov 21, 2022

figsoda commented Nov 21, 2022

p3t33 commented Dec 28, 2022

teto commented Dec 28, 2022

p3t33 commented Jan 4, 2023

mdarocha commented Jan 4, 2023

figsoda commented Jan 4, 2023

gshpychka commented Jan 6, 2023

figsoda commented Jan 6, 2023

ghostbuster91 commented Jan 12, 2023 •

edited

Loading

figsoda commented Jan 12, 2023

ghostbuster91 commented Jan 12, 2023

figsoda commented Jan 12, 2023 •

edited

Loading

ghostbuster91 commented Jan 12, 2023 •

edited

Loading

figsoda commented Jan 12, 2023

ghostbuster91 commented Jan 12, 2023 •

edited

Loading

figsoda commented Jan 12, 2023

ghostbuster91 commented Jan 12, 2023

nvim-treesitter: declarative install of parsers causes errors #189838

nvim-treesitter: declarative install of parsers causes errors #189838

Comments

NickHu commented Sep 5, 2022

Describe the bug

Expected behavior

Additional context

Notify maintainers

Metadata

teto commented Sep 5, 2022

mdarocha commented Sep 7, 2022

teto commented Sep 7, 2022

jack-michaud commented Sep 19, 2022 • edited Loading

portothree commented Sep 19, 2022

NickHu commented Sep 20, 2022

jack-michaud commented Sep 20, 2022

portothree commented Sep 20, 2022

vasyharan commented Nov 3, 2022

NickHu commented Nov 21, 2022

jocelynthode commented Nov 21, 2022

samhh commented Nov 21, 2022

mdarocha commented Nov 21, 2022

figsoda commented Nov 21, 2022

samhh commented Nov 21, 2022

figsoda commented Nov 21, 2022

p3t33 commented Dec 28, 2022

teto commented Dec 28, 2022

p3t33 commented Jan 4, 2023

mdarocha commented Jan 4, 2023

figsoda commented Jan 4, 2023

gshpychka commented Jan 6, 2023

figsoda commented Jan 6, 2023

ghostbuster91 commented Jan 12, 2023 • edited Loading

figsoda commented Jan 12, 2023

ghostbuster91 commented Jan 12, 2023

figsoda commented Jan 12, 2023 • edited Loading

ghostbuster91 commented Jan 12, 2023 • edited Loading

figsoda commented Jan 12, 2023

ghostbuster91 commented Jan 12, 2023 • edited Loading

figsoda commented Jan 12, 2023

ghostbuster91 commented Jan 12, 2023

jack-michaud commented Sep 19, 2022 •

edited

Loading

ghostbuster91 commented Jan 12, 2023 •

edited

Loading

figsoda commented Jan 12, 2023 •

edited

Loading

ghostbuster91 commented Jan 12, 2023 •

edited

Loading

ghostbuster91 commented Jan 12, 2023 •

edited

Loading