[BUG] Neorg plugin lacks norg-meta treesitter parser

[Ladas552]

Field	Description
Plugin	neorg
Nixpkgs	unstable
Home Manager	unstable

• I have read the FAQ and my bug is not listed there.

Description

There are several issues that might be related to not having norg-meta treesitter parser packaged or included with neorg on Nixvim.

Syntax highlighting for metadata field in norg files doesn't work. Here are screenshots, the one without highlights is norg file opened in nixvim with option configured Neorg, and the other is nixvim with Neorg-overlay

no norg-meta	norg-meta from overlay

The auto command for norg buffers that executes after writing a buffer trows an error:

Error detected while processing BufWritePost Autocommands for "*.norg":                                   
Error executing Lua callback: ....10.1/share/nvim/runtime/lua/vim/treesitter/language.lua:107: no parser f
or 'norg_meta' language, see :help treesitter-parsers                                                     
stack traceback:                                                                                          
        [C]: in function 'error'                                                                          
        ....10.1/share/nvim/runtime/lua/vim/treesitter/language.lua:107: in function 'add'                
        ...d-0.10.1/share/nvim/runtime/lua/vim/treesitter/query.lua:250: in function 'fn'                 
        ...pped-0.10.1/share/nvim/runtime/lua/vim/func/_memoize.lua:58: in function 'ts_parse_query'      
        ...ua/neorg/modules/core/integrations/treesitter/module.lua:808: in function 'get_document_metadat
a'                                                                                                        
        ...ges/start/neorg/lua/neorg/modules/core/tangle/module.lua:226: in function 'tangle'             
        ...ges/start/neorg/lua/neorg/modules/core/tangle/module.lua:466: in function 'on_event'           
        .../myNeovimPackages/start/neorg/lua/neorg/core/modules.lua:781: in function 'broadcast_event'    
        ...s/start/neorg/lua/neorg/modules/core/neorgcmd/module.lua:298: in function <...s/start/neorg/lua
/neorg/modules/core/neorgcmd/module.lua:205>    

And it seems that it also breaks the core.tangle module. Because when core.tangle is enabled as a module in neorg the :Neorg journal today trows an error:

Minimal, Reproducible Example (MRE)

programs.nixvim = {
      enable = true;
      defaultEditor = true;
      plugins = {
        treesitter = {
          enable = true;
        };
        neorg = {
          enable = true;
          modules = {
            "core.defaults" = {
              __empty = null;
            };
            "core.dirman" = {
              config = {
                workspaces = {
                  general = "~/Norg";
                };
              };
            };
            "core.esupports.metagen" = {
              config = {
                timezone = "implicit-local";
                type = "empty";
                undojoin_updates = "false";
              };
            };
            "core.concealer" = {
              config = {
                __empty = null;
              };
            };
              "core.journal" = {
                config = {
                  workspace = "general";
                  journal_folder = "/./";
                };
              };
              "core.tangle" = {
                config = {
                  report_on_empty = false;
                  tangle_on_write = true;
                };
              };
            };
          };
        };
}

[khaneliman]

We don't do packaging itself in nixvim, that is handled upstream in nixpkgs. The neorg plugin doesn't include treesitter grammars and the packages treesitter doesn't contain https://github.com/nvim-neorg/tree-sitter-norg-meta. If you'd like to include that grammar you would have to follow the treesitter instructions for installing a custom grammar. https://nix-community.github.io/nixvim/plugins/treesitter/index.html?highlight=tree#installing-your-own-grammars-with-nixvim.

I implemented it myself if you want to see an example:
Grammar implementation: khaneliman/khanelivim@ae3d016
Installing Grammar: khaneliman/khanelivim@8aeb4a4

[teto]

eventually thanks to https://github.com/nvim-neorocks/rocks-treesitter.nvim/ we should be able to have the grammar as dependencies of the plugin when installed via luarocks (with Rocks.nvim), which is then picked up automatically by nixpkgs. Can't say when it will happen though but neorg author is a rocks.nvim maintainer

[Ladas552]

Tried the khaneliman's method. Works well. Hope that one day it could be bundled by default to make the experience more seamless. Thanks for support.