https://github.com/nvim-neorocks/luarocks-build-treesitter-parser

A luarocks build backend for tree-sitter parsers.
https://github.com/nvim-neorocks/luarocks-build-treesitter-parser

neovim tree-sitter

Last synced: about 1 month ago
JSON representation

A luarocks build backend for tree-sitter parsers.

• Host: GitHub
• URL: https://github.com/nvim-neorocks/luarocks-build-treesitter-parser
• Owner: nvim-neorocks
• License: mit
• Created: 2024-03-10T17:16:56.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-26T19:01:10.000Z (3 months ago)
• Last Synced: 2024-10-09T01:18:05.780Z (about 1 month ago)
• Topics: neovim, tree-sitter
• Language: Lua
• Homepage:
• Size: 91.8 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# luarocks-build-treesitter-parser

> [!WARNING]

>

> This is early WIP!

A luarocks build backend for tree-sitter parsers. 

Used by the [Neovim User Rock Repository (NURR)](https://github.com/nvim-neorocks/nurr).

The resulting parser libraries are installed to

`/lib/lua//parser`.

> [!IMPORTANT]

>

> The installed parsers are *not* lua modules, but they

> can be added to the `package.cpath`.

## Example rockspec

```lua

package = "tree-sitter-LANG"

version = "scm-1"

source = {

  url = "https://github.com/tree-sitter/tree-sitter-LANG/archive/.zip",

  dir = 'tree-sitter-LANG-',

}

source = {

  url = "git://github.com/tree-sitter/tree-sitter-LANG",

}

description = {

  summary = "tree-sitter parser for LANG",

  homepage = "https://github.com/tree-sitter/tree-sitter-LANG",

  license = "MIT"

}

dependencies = {

  "lua >= 5.1",

  "luarocks-build-treesitter-parser",

}

build = {

  type = "treesitter-parser",

 

  ---@type string (required) Name of the language, e.g. "haskell".

  lang = "LANG",

  ---@type boolean? (optional) Won't build the parser if `false`.

  parser = true,

  -- For C++ sources, this build backend automatically sets "-lstdc++"

  -- You can override the default by passing in a list of flags.

  -- libflags = ...

  platforms = {

    macosx = {

      ---@type strin[]? (optional) Ignored if `sources` is unset or empty

      libflags = {

        "-bundle",

        "-undefined",

        "dynamic_lookup",

        "-all_load",

        "-std=c++11",

      },

    },

  },

  ---@type boolean? (optional) Must the sources be generated using the tree-sitter CLI?

  generate = true,

  --- Ignored if `generate` is false.

  ---@type boolean? (optional) Generate the sources from src/grammar.json?

  generate_from_json = false,

  ---@type string? (optional) tree-sitter grammar's location (relative to the source root).

  location = "libs/tree-sitter-LANG",

  --- Overwrites any existing queries with the embedded queries.

  --- Will add 'queries' to the rockspec's 'copy_directories' if set.

  ---@type table? (optional)

  queries = {

        -- Will create a `queries//highlights.scm`

        -- Note that the content should not be indented.

        ["highlights.scm"] = [==[

(signature

  name: (variable) @function)

(function

  name: (variable) @function)

]==],

  },

}

```

> [!TIP]

>

> You can find more examples in the [fixtures](./fixtures) directory.

## Usage with Neovim

Neovim searches for tree-sitter parsers in a `parser` directory

on the runtimepath (`:h rtp`).

Parsers installed with luarocks-build-treesitter-parser can be found

by creating a symlink to the `parser` directory in the install location

on the Neovim runtimepath.