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

✨ add a Contributing guide to parser and editor tools related stuff #1311

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

AucaCoyan
Copy link

@AucaCoyan AucaCoyan commented Mar 23, 2024

As said in discord, I would like to make an introductory document on everything that is related to the parser and other editor tools (tree-sitter, nufmt, both LSPs, etc).
I think there is a load of knowledge that it'd be cool to write it down to see where we are, and also to point out people who have questions.
Also, if new people want to join, there is some knowledge required to understand what is going on

link to markdown rendered document

@AucaCoyan AucaCoyan marked this pull request as ready for review March 24, 2024 18:33
@AucaCoyan
Copy link
Author

Good! Ready to run the CI and one final review

We have another grammar: [tree-sitter nushell](https://github.com/nushell/tree-sitter-nu) this is useful for terminal text editors (nvim, helix, etc). VS Code doesn't have support for tree-sitter and its grammar [is written in tmLanguage](https://github.com/nushell/vscode-nushell-lang/blob/main/syntaxes/nushell.tmLanguage.json)
It has the following goals:

- Ability to serve as a parser for a repl
Copy link
Member

Choose a reason for hiding this comment

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

I would strike that line as this is probably misleading as it is not used in our repl.

Copy link
Author

Choose a reason for hiding this comment

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

it's from the tree-sitter-nu's readme. Would you recommend deleting line 65 in both cases?

Copy link
Author

Choose a reason for hiding this comment

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

Hi! Did you have time to review this 😄 ? Thanks!

@AucaCoyan
Copy link
Author

fixed the typos CI 😄 , can I have a workflow approval? 👍🏼


- hover
- go to definition
- auto-completions
Copy link
Collaborator

Choose a reason for hiding this comment

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

There are a few things missing from this list.
It also helps locate nu and if it finds it allow nu to be used as a terminal shell.
It displays Inlays
It allows you to have separate IncludeDirs
It has diagnostics to show errors

Most of this is laid out in the extension readme

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

Successfully merging this pull request may close these issues.

None yet

3 participants