Skip to content

Commit c03220f

Browse files
committed
Update instructions
1 parent c379199 commit c03220f

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
This repository contains a parser definition of the [ReScript](https://rescript-lang.org/) language for the [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) parser generator tool.
44

5-
Athough Tree-sitter has many applications, the main intent of this parser is powering the [`nvim-treesitter-rescript`](https://github.com/nkrkv/nvim-tree-sitter-rescript/) NeoVim plugin which may be used to improve development experience in the NeoVim + ReScript combo.
6-
75
Queries for text objects are also included which help you to navigate, select, and modify ReScript code syntactically. For NeoVim, the [`nvim-treesitter-textobjects`](https://github.com/nvim-treesitter/nvim-treesitter-textobjects) plugin is required to use Tree-sitter text objects.
86

97
## Installation
@@ -16,7 +14,7 @@ If you want ReScript Tree-sitter in NeoVim, you will first need to register a ne
1614
local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
1715
parser_config.rescript = {
1816
install_info = {
19-
url = "https://github.com/nkrkv/tree-sitter-rescript",
17+
url = "https://github.com/rescript-lang/tree-sitter-rescript",
2018
branch = "main",
2119
files = { "src/scanner.c" },
2220
generate_requires_npm = false,
@@ -28,7 +26,7 @@ parser_config.rescript = {
2826

2927
This will make `TSInstall rescript` globally available. For more persistent approach you should add this parser to your Lua configuration.
3028

31-
Default configuration detects `.res` and `.resi` files. You can confirm that it's correctly installed by using [`nvim-treesitter/playground`](https://github.com/nvim-treesitter/playground) and invoking `TSPlaygroundToggle` when you are in the ReScript file.
29+
Default configuration detects `.res` and `.resi` files. You can confirm that it's correctly installed by invoking `:InspectTree` when you are in the ReScript file.
3230

3331
- Notice that by default you will not see the highlighting! To enable highlighting, you will need to install this package either as a dependency or directly.
3432

@@ -38,7 +36,7 @@ If you are using `lazy.nvim` example configuration will look like so:
3836
{
3937
"nvim-treesitter/nvim-treesitter",
4038
dependencies = {
41-
"nkrkv/tree-sitter-rescript"
39+
"rescript-lang/tree-sitter-rescript"
4240
},
4341
opts = function(_, opts) -- this is needed so you won't override your default nvim-treesitter configuration
4442
vim.list_extend(opts.ensure_installed, {
@@ -48,7 +46,7 @@ If you are using `lazy.nvim` example configuration will look like so:
4846
local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
4947
parser_config.rescript = {
5048
install_info = {
51-
url = "https://github.com/nkrkv/tree-sitter-rescript",
49+
url = "https://github.com/rescript-lang/tree-sitter-rescript",
5250
branch = "main",
5351
files = { "src/scanner.c" },
5452
generate_requires_npm = false,
@@ -60,7 +58,6 @@ If you are using `lazy.nvim` example configuration will look like so:
6058
}
6159
```
6260

63-
- Legacy way of installing the parser is available via [`nvim-treesitter-rescript`](https://github.com/nkrkv/nvim-tree-sitter-rescript/)
6461
- If you want it for other purposes, you probably know what to do.
6562

6663
## Contributing

0 commit comments

Comments
 (0)