nvim-orgmode / nvim-orgmode/orgmode

rocks.nvim install:

Open
#946 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
3.9k
Forks
190
Avg merge
2d 13h
Merged PRs (30d)
7

Description

I had treesitter errors for orgmode (installed via nix) but I noticed that orgmode had both its plugin and the grammar on luarocks.org so I thought I would install it via Rocks instead.

I take notes here before adding rocks command to https://github.com/nvim-orgmode/orgmode/blob/master/docs/installation.org

I've got those 2 installed in :Rocks edit

tree-sitter-orgmode = "2.0.0"
orgmode = "0.5.2"

Apparently I would not need to use tree-sitter-orgmode since it's already a dependency:
https://luarocks.org/manifests/kristijanhusak/orgmode-0.5.2-1.rockspec

checkhealth rocks-config complained about

Checking for errors while loading configs ~
- ERROR Error while loading config 'orgmode.lua' for 'orgmode'.
  - ADVICE:
    - Error was: ...rocks/rocks_rtp/lua/orgmode/utils/treesitter/install.lua:18: [orgmode] Failed to copy generated tree-sitter parser to runtime folder: ENOENT: no such file or directory: /home/teto/.cache/nvim/tree-sitter-org/parser.so -> /home/teto/.local/share/nvim/rocks/rocks_rtp/parser/org.so

So in this case orgmode wrongly tries to install tree-sitter-org instead of tree-sitter-orgmode ?

Fixed by adding vim.opt.runtimepath:append(vim.fs.joinpath(vim.fn.stdpath("data"), "rocks", "lib", "luarocks", "rocks-5.1", "tree-sitter-", "")) in init.lua.

I stumbled upon this message https://github.com/nvim-orgmode/orgmode/issues/804#issuecomment-2317509588 . is it sill valid ?

The advantage of rocks.nvim is that it should install all dependencies including the parser but in this cade I also had orgmode trying to compile the grammar while it should already be available ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the checkhealth rocks-config error, then inspect lua/orgmode/utils/treesitter/install.lua and the installation notes in docs/installation.org; the issue also mentions the init.lua runtimepath workaround. Determine how the Rocks-installed parser should be discovered and update the relevant behavior or documentation so the Rocks installation works without an extra workaround.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, vim
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.