Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Improve grammar installation #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
TheFedaikin wants to merge 1 commit into rescript-lang:main from TheFedaikin:main
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 53 additions & 1 deletion README.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,59 @@ Queries for text objects are also included which help you to navigate, select, a

## Installation

- If you want ReScript Tree-sitter in NeoVim, refer to [`nvim-treesitter-rescript`](https://github.com/nkrkv/nvim-tree-sitter-rescript/) installation notes;
### Neovim

If you want ReScript Tree-sitter in NeoVim, you will first need to register a new parser for it like so:

```lua
local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
parser_config.rescript = {
install_info = {
url = "https://github.com/nkrkv/tree-sitter-rescript",
branch = "main",
files = { "src/scanner.c" },
Copy link
Collaborator

@aspeddro aspeddro Aug 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think parser.c should be added?

Suggested change
files = { "src/scanner.c" },
files = { 'src/parser.c', 'src/scanner.c' },

Copy link
Contributor Author

@TheFedaikin TheFedaikin Aug 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's needed explicitly when this file is present, since it's not I don't think so. To support this I have my forked branch installed basically like this

 {
 "nvim-treesitter/nvim-treesitter",
 dependencies = {
 {
 "TheFedaikin/tree-sitter-rescript",
 },
 },
 opts = function(_, opts)
 vim.list_extend(opts.ensure_installed, {
 "rescript",
 })
 local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
 parser_config.rescript = {
 install_info = {
 url = "https://github.com/TheFedaikin/tree-sitter-rescript",
 branch = "main",
 files = { "src/scanner.c" },
 generate_requires_npm = false,
 requires_generate_from_grammar = true,
 use_makefile = true, -- macOS specific instruction
 },
 }
 end,
 },

And it works wonders

aspeddro reacted with thumbs up emoji
generate_requires_npm = false,
requires_generate_from_grammar = true,
use_makefile = true, -- macOS specific instruction
},
}
```

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

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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Neovim 0.9 the command :InspectTree is available to inspect the tree.

TheFedaikin reacted with thumbs up emoji
Copy link
Contributor Author

@TheFedaikin TheFedaikin Aug 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will update it!


- 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.

If you are using `lazy.nvim` example configuration will look like so:

```lua
{
"nvim-treesitter/nvim-treesitter",
dependencies = {
"nkrkv/tree-sitter-rescript"
},
opts = function(_, opts) -- this is needed so you won't override your default nvim-treesitter configuration
vim.list_extend(opts.ensure_installed, {
"rescript",
})

local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
parser_config.rescript = {
install_info = {
url = "https://github.com/nkrkv/tree-sitter-rescript",
branch = "main",
files = { "src/scanner.c" },
generate_requires_npm = false,
requires_generate_from_grammar = true,
use_makefile = true, -- macOS specific instruction
},
}
end,
}
```

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

## Contributing
Expand Down
14 changes: 13 additions & 1 deletion package.json
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,19 @@
"res",
"resi"
],
"injection-regex": "rescript"
"injection-regex": "rescript",
"highlights": [
"queries/rescript/highlights.scm"
],
"locals": [
"queries/rescript/locals.scm"
],
"injections": [
"queries/rescript/injections.scm"
],
"textobjects": [
"queries/rescript/textobjects.scm"
]
}
]
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

AltStyle によって変換されたページ (->オリジナル) /