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.

Sign up for GitHub

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

Jump to bottom

feat: add tree-sitter-make #1433

Merged

archseer merged 2 commits into helix-editor:master from EricCrosson:add-tree-sitter-make

Jan 8, 2022

Contributor

EricCrosson commented Jan 4, 2022

This commit adds syntax highlighting for GNU Make¹ makefiles
via tree-sitter-make².

Contributor Author

EricCrosson commented Jan 4, 2022

Hey guys! Helix is an awesome project, I've only found it in the last few days but I love what I've seen so far. Thanks so much for your hard work! What a great idea to build an editor from the ground up with LSP and tree-sitter in mind.

I've used GNU Emacs for 10 years with some thousands of lines of configuration. Lately I've been using neovim, where I have ~100 lines of config. I'm happy with helix with all of 5 lines of config, and LSP works better and faster with helix than any of my other editors. This team is on to something!

I tried editing a GNU Makefile today and found there is no syntax highlighting. This PR imports the preexisting highlights.scm file from tree-sitter-make, as well as the tree-sitter-make submodule. I am also pretty new to tree-sitter so I didn't try my hand at writing the indents.toml, injections.scm, or the textobjects.scm files. Hopefully those are optional or we can iterate to flush out the functionality over time.

I'm not sure if you have any conventions for tracking existing scm files that are preferred over copy/paste, so just let me know if there are any changes requested. Cheers!

dead10ck reviewed

View reviewed changes

Member

dead10ck left a comment

Awesome, thank you!

languages.toml Outdated

+              [[language]]
+              name = "make"
+              scope = "source.make"
+              file-types = ["Makefile"]

Member

dead10ck Jan 4, 2022 •

edited

Loading

Could we also add the other variants, makefile and GNUmakefile? And also could we throw in justfile and .justfile?

Contributor Author

EricCrosson Jan 4, 2022

Good thinking!

Contributor

pickfire Jan 4, 2022

Wait, I thought there is tree-sitter-just? https://github.com/IndianBoy42/tree-sitter-just

Member

dead10ck Jan 4, 2022

Oh interesting. Is it good to use? It mentions it's a work in progress and doesn't have tests yet.

archseer requested changes

View reviewed changes

Member

archseer left a comment

Thank you for the kind words!

The PR looks good but highlights.scm needs some changes to follow the list of scopes we use: https://docs.helix-editor.com/themes.html#syntax-highlighting

runtime/queries/make/highlights.scm Outdated

+               "if"
+               "or"  ; boolean functions are conditional in make grammar
+               "and"
+              ] @conditional

Member

archseer Jan 4, 2022

@keyword.control.conditional

runtime/queries/make/highlights.scm Outdated

+               "and"
+              ] @conditional
+              "foreach" @repeat

Member

archseer Jan 4, 2022

@keyword.control.repeat

runtime/queries/make/highlights.scm Outdated

+               "include"
+               "sinclude"
+               "-include"
+              ] @include

Member

archseer Jan 4, 2022

@keyword.control.import

runtime/queries/make/highlights.scm Outdated

+               "error"
+               "warning"
+               "info"
+              ] @exception

Member

archseer Jan 4, 2022

@keyword.control.exception

Hmm, that one looks like it's missing from the list, can you add it here?

helix/book/src/themes.md

Line 146 in 5b1a628

- `conditional` - `if`, `else`

runtime/queries/make/highlights.scm Outdated

Comment on lines 121 to 125

+              (variable_assignment
+                name: (word) @constant)
+              (variable_reference
+                (word) @constant)

Member

archseer Jan 4, 2022

Seems to me that these should be @variable?

runtime/queries/make/highlights.scm Outdated


		(comment) @comment

		((word) @clean @string.regex

Member

archseer Jan 4, 2022

@string.regexp

runtime/queries/make/highlights.scm Outdated

+              (function_call
+                function: "error"
+                (arguments (text) @text.danger))

Member

archseer Jan 4, 2022

@error

Contributor Author

EricCrosson Jan 4, 2022 •

edited

Loading

~~I don't see @error on this list -- is this a scope that should also be added to themes.md?~~

Oh I see it, under the Interface heading 👍

runtime/queries/make/highlights.scm Outdated

+              (function_call
+                function: "warning"
+                (arguments (text) @text.warning))

Member

archseer Jan 4, 2022

@warning

runtime/queries/make/highlights.scm Outdated

+              (function_call
+                function: "info"
+                (arguments (text) @text.note))

Member

archseer Jan 4, 2022

@info

EricCrosson added a commit to EricCrosson/helix that referenced this pull request


          docs: document @keyword.control.exception scope

4cc7fb1

As identified in [this GitHub comment](helix-editor#1433 (comment))

EricCrosson force-pushed the add-tree-sitter-make branch from a4f8782 to 4cc7fb1 Compare

January 4, 2022 02:32

Contributor Author

EricCrosson commented Jan 4, 2022

The PR looks good but highlights.scm needs some changes to follow the list of scopes we use: https://docs.helix-editor.com/themes.html#syntax-highlighting

Thanks for the pointer, and the complete review! I've updated the scopes and added exception to the themes documentation

Omnikar reviewed

View reviewed changes

languages.toml

+              [[language]]
+              name = "make"
+              scope = "source.make"
+              file-types = ["Makefile", "makefile", "justfile", ".justfile"]

Contributor

Omnikar Jan 4, 2022

"justfile" will cover files with justfile as their name or as their extension.

Suggested change

      
            file-types = ["Makefile", "makefile", "justfile", ".justfile"]
          
            file-types = ["Makefile", "makefile", "justfile"]

Member

dead10ck Jan 4, 2022

Does that include .justfile by itself?

Contributor

Omnikar Jan 4, 2022

Ah, that is what this is meant to cover, my mistake.

Contributor

pickfire Jan 4, 2022

I think we should remove just, there is https://github.com/IndianBoy42/tree-sitter-just

EricCrosson added a commit to EricCrosson/helix that referenced this pull request


          docs: document @keyword.control.exception scope

9fe8e0b

As identified in [this GitHub comment](helix-editor#1433 (comment))

EricCrosson force-pushed the add-tree-sitter-make branch from 4cc7fb1 to 9fe8e0b Compare

January 4, 2022 12:53

EricCrosson requested a review from archseer

January 4, 2022 12:59

EricCrosson added a commit to EricCrosson/helix that referenced this pull request


          docs: document @keyword.control.exception scope

1f3120a

As identified in [this GitHub comment](helix-editor#1433 (comment))

EricCrosson force-pushed the add-tree-sitter-make branch from 9fe8e0b to 1f3120a Compare

January 6, 2022 13:43

EricCrosson added 2 commits

January 6, 2022 10:57


          feat: add tree-sitter-make

df61df2

This commit adds syntax highlighting for GNU Make[^1] makefiles
via tree-sitter-make[^2].

[^1]: https://www.gnu.org/software/make/
[^2]: https://github.com/alemuller/tree-sitter-make


          docs: document @keyword.control.exception scope

a462716

As identified in [this GitHub comment](helix-editor#1433 (comment))

EricCrosson force-pushed the add-tree-sitter-make branch from 1f3120a to a462716 Compare

January 6, 2022 16:57

archseer approved these changes

View reviewed changes

Member

archseer commented Jan 8, 2022

Thanks! 🎉

archseer merged commit 5b45bdd into helix-editor:master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet