Skip to content

Commit

Permalink
docs(readme): update tree-sitter parser section
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcjkb committed Mar 12, 2024
1 parent f05befa commit f7d2023
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Neovim User Rock Repository (NURR)

The NURR hosts and automatically packages Neovim Luarocks releases for many plugins
whose developers do not want to maintain a Luarocks CI workflow.
and tree-sitter parsers whose developers do not want to maintain a Luarocks CI workflow.

This repository contains a CI which runs every 4 hours, enumerating a set of curated Neovim plugins
This repository contains a CI which runs periodically, enumerating a set of curated Neovim plugins
and publishing them to the `neovim` manifest on `luarocks.org` - this keeps the root manifest clean
and allows the original authors to publish their own plugins if they so choose.

Expand All @@ -21,9 +21,23 @@ chunks the plugins into sets of 256 (the max number of outputs per job).
Each chunk is dispatched to an update workflow,
which uses the chunk it receives as the input for a matrix build.

> [!NOTE]
>
> Neovim plugins are published every 4 hours.
### Tree-sitter parsers [WIP]

- One workflow periodically generates the [tree-sitter-parsers.json](./tree-sitter-parsers.json)
file, using nvim-treesitter as a source.
- Another workflow uses that file as a matrix input, to generate
rockspecs (that use [`luarocks-build-tree-sitter-parser`](https://github.com/nvim-neorocks/luarocks-build-treesitter-parser))
and publishes them to luarocks.org.

> [!NOTE]
>
> Tree-sitter parsers are published every 7 hours.
> [!IMPORTANT]
>
> The [tree-sitter-parsers.json](./tree-sitter-parsers.json) file is
> generated by [a github workflow](./.github/workflows/update-ts-parsers.yml).
> Any tree-sitter parser rockspecs that cannot be built and installed by the workflow
> are not uploaded to luarocks.org.

0 comments on commit f7d2023

Please sign in to comment.