From f7d2023b69e0c243160414addee5e8561bbba523 Mon Sep 17 00:00:00 2001 From: Marc Jakobi Date: Tue, 12 Mar 2024 19:15:42 +0100 Subject: [PATCH] docs(readme): update tree-sitter parser section --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ae2d5f0..83b83ef 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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.