Skip to content
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

Is there anything I can do to help? #10

Open
jetjinser opened this issue Aug 19, 2024 · 2 comments
Open

Is there anything I can do to help? #10

jetjinser opened this issue Aug 19, 2024 · 2 comments

Comments

@jetjinser
Copy link

I've been using this parser for a while.
There are some ERROR nodes in the parsed tree, and highlights query are also insufficient for me.

So I made a fork myself, mainly reorganizing the grammar.js rules and some highlighting query updates.

There is the highlight I'm using now.

I think this should be better, so I want to contribute here! But the updates I make are so haphazard that I don't know which parts can be pushed upstream.

So I'd like to ask for your advice, is there anything I can do to help?

@kentookura
Copy link
Owner

Sure!

I would appreciate contributions both to the grammar itself, and generally anything that improves the maintainability of this repo such as CI, testing, adding contributor guidelines/PR templates etc.

I have not worked on the grammar for a while, so I think I was going to do a major review/rewrite anyway.
I briefly looked at your fork and definitely agree that things need to be cleaned up. I would definitely like to incorporate any improvements you made.

Since diffs can be so large when working with treesitter I think we should proceed in the following way:

You can create PRs with specific intent (say, the way that the xml is handled), only including the changes to the test and the grammar. The commit adding all the generated code can then be added after review.

Another area where I appreciate help is with the editor integration. If you can contribute a testing setup (an example init.lua or something) for testing, that would be great.

Of course, reporting errors is always welcome.

@kentookura
Copy link
Owner

@jetjinser It occurs to me that it would be really great to have a comprehensive test suite that can also be used for testing the OCaml parser. A set of trees that make use of every syntactic construct that, when compiled, contain every output structure. That way it is much easier to keep our parser up to date.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants