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

feat(languages): update just grammar and queries #11306

Merged
merged 2 commits into from
Jul 28, 2024
Merged
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
7 changes: 4 additions & 3 deletions helix-core/src/syntax.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1025,9 +1025,10 @@ impl Loader {
match capture {
InjectionLanguageMarker::Name(string) => self.language_config_for_name(string),
InjectionLanguageMarker::Filename(file) => self.language_config_for_file_name(file),
InjectionLanguageMarker::Shebang(shebang) => {
self.language_config_for_language_id(shebang)
}
InjectionLanguageMarker::Shebang(shebang) => self
.language_config_ids_by_shebang
.get(shebang)
.and_then(|&id| self.language_configs.get(id).cloned()),
}
}

Expand Down
2 changes: 1 addition & 1 deletion languages.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3082,7 +3082,7 @@ indent = { tab-width = 4, unit = " " }

[[grammar]]
name = "just"
source = { git = "https://github.com/IndianBoy42/tree-sitter-just", rev = "8af0aab79854aaf25b620a52c39485849922f766" }
source = { git = "https://github.com/IndianBoy42/tree-sitter-just", rev = "379fbe36d1e441bc9414ea050ad0c85c9d6935ea" }

[[language]]
name = "gn"
Expand Down
14 changes: 10 additions & 4 deletions runtime/queries/just/folds.scm
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
(body) @fold
(recipe) @fold
(interpolation) @fold
(item (_) @fold)
; From <https://github.com/IndianBoy42/tree-sitter-just/blob/6c2f018ab1d90946c0ce029bb2f7d57f56895dff/queries-flavored/helix/folds.scm>

; Define collapse points

([
(recipe)
(string)
(external_command)
] @fold
(#trim! @fold))
160 changes: 138 additions & 22 deletions runtime/queries/just/highlights.scm
Original file line number Diff line number Diff line change
@@ -1,33 +1,149 @@
(assignment (NAME) @variable)
(alias (NAME) @variable)
(value (NAME) @variable)
(parameter (NAME) @variable)
(setting (NAME) @keyword)
(setting "shell" @keyword)
; From <https://github.com/IndianBoy42/tree-sitter-just/blob/6c2f018ab1d90946c0ce029bb2f7d57f56895dff/queries-flavored/helix/highlights.scm>

(call (NAME) @function)
(dependency (NAME) @function)
(depcall (NAME) @function)
(recipeheader (NAME) @function)
; This file specifies how matched syntax patterns should be highlighted

(depcall (expression) @variable.parameter)
(parameter) @variable.parameter
(variadic_parameters) @variable.parameter
[
"export"
"import"
] @keyword.control.import

["if" "else"] @keyword.control.conditional
"mod" @keyword.directive

(string) @string
[
"alias"
"set"
"shell"
] @keyword

(boolean ["true" "false"]) @constant.builtin.boolean
[
"if"
"else"
] @keyword.control.conditional

(comment) @comment
; Variables

; (interpolation) @string
(value
(identifier) @variable)

(shebang interpreter:(TEXT) @keyword ) @comment
(alias
left: (identifier) @variable)

["export" "alias" "set"] @keyword
(assignment
left: (identifier) @variable)

["@" "==" "!=" "+" ":="] @operator
; Functions

[ "(" ")" "[" "]" "{{" "}}" "{" "}"] @punctuation.bracket
(recipe_header
name: (identifier) @function)

(dependency
name: (identifier) @function)

(dependency_expression
name: (identifier) @function)

(function_call
name: (identifier) @function)

; Parameters

(parameter
name: (identifier) @variable.parameter)

; Namespaces

(module
name: (identifier) @namespace)

; Operators

[
":="
"?"
"=="
"!="
"=~"
"@"
"="
"$"
"*"
"+"
"&&"
"@-"
"-@"
"-"
"/"
":"
] @operator

; Punctuation

"," @punctuation.delimiter

[
"{"
"}"
"["
"]"
"("
")"
"{{"
"}}"
] @punctuation.bracket

[ "`" "```" ] @punctuation.special

; Literals

(boolean) @constant.builtin.boolean

[
(string)
(external_command)
] @string

(escape_sequence) @constant.character.escape

; Comments

(comment) @comment.line

(shebang) @keyword.directive

; highlight known settings (filtering does not always work)
(setting
left: (identifier) @keyword
(#any-of? @keyword
"allow-duplicate-recipes"
"dotenv-filename"
"dotenv-load"
"dotenv-path"
"export"
"fallback"
"ignore-comments"
"positional-arguments"
"shell"
"tempdi"
"windows-powershell"
"windows-shell"))

; highlight known attributes (filtering does not always work)
(attribute
(identifier) @attribute
(#any-of? @attribute
"private"
"allow-duplicate-recipes"
"dotenv-filename"
"dotenv-load"
"dotenv-path"
"export"
"fallback"
"ignore-comments"
"positional-arguments"
"shell"
"tempdi"
"windows-powershell"
"windows-shell"))

; Numbers are part of the syntax tree, even if disallowed
(numeric_error) @error
12 changes: 10 additions & 2 deletions runtime/queries/just/indents.scm
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
; From <https://github.com/IndianBoy42/tree-sitter-just/blob/6c2f018ab1d90946c0ce029bb2f7d57f56895dff/queries-flavored/helix/indents.scm>
;
; This query specifies how to auto-indent logical blocks.
;
; Better documentation with diagrams is in https://docs.helix-editor.com/guides/indent.html

[
(recipe_body)
] @indent
(recipe)
(string)
(external_command)
] @indent @extend
92 changes: 80 additions & 12 deletions runtime/queries/just/injections.scm
Original file line number Diff line number Diff line change
@@ -1,16 +1,84 @@
; From <https://github.com/IndianBoy42/tree-sitter-just/blob/6c2f018ab1d90946c0ce029bb2f7d57f56895dff/queries-flavored/helix/injections.scm>
;
; Specify nested languages that live within a `justfile`

; ================ Always applicable ================

((comment) @injection.content
(#set! injection.language "comment"))
(#set! injection.language "comment"))

; Highlight the RHS of `=~` as regex
((regex_literal
(_) @injection.content)
(#set! injection.language "regex"))

; ================ Global defaults ================

; Default everything to be bash
(recipe_body
!shebang
(#set! injection.language "bash")
(#set! injection.include-children)) @injection.content

(external_command
(command_body) @injection.content
(#set! injection.language "bash"))

; ================ Global language specified ================
; Global language is set with something like one of the following:
;
; set shell := ["bash", "-c", ...]
; set shell := ["pwsh.exe"]
;
; We can extract the first item of the array, but we can't extract the language
; name from the string with something like regex. So instead we special case
; two things: powershell, which is likely to come with a `.exe` attachment that
; we need to strip, and everything else which hopefully has no extension. We
; separate this with a `#match?`.
;
; Unfortunately, there also isn't a way to allow arbitrary nesting or
; alternatively set "global" capture variables. So we can set this for item-
; level external commands, but not for e.g. external commands within an
; expression without getting _really_ annoying. Should at least look fine since
; they default to bash. Limitations...
; See https://github.com/tree-sitter/tree-sitter/issues/880 for more on that.

(source_file
(setting "shell" ":=" "[" (string) @_langstr
(#match? @_langstr ".*(powershell|pwsh|cmd).*")
(#set! injection.language "powershell"))
[
(recipe
(recipe_body
!shebang
(#set! injection.include-children)) @injection.content)

(assignment
(expression
(value
(external_command
(command_body) @injection.content))))
])

(source_file
(setting "shell" ":=" "[" (string) @injection.language
(#not-match? @injection.language ".*(powershell|pwsh|cmd).*"))
[
(recipe
(recipe_body
!shebang
(#set! injection.include-children)) @injection.content)

(shebang_recipe
(shebang
interpreter:(TEXT) @injection.language)
(shebang_body) @injection.content
)
(assignment
(expression
(value
(external_command
(command_body) @injection.content))))
])

(source_file
(item (setting lang:(NAME) @injection.language))
(item (recipe (body (recipe_body) @injection.content)))
)
; ================ Recipe language specified - Helix only ================

; ((interpolation (expression) @injection.content)
; (#set! injection.language "just"))
; Set highlighting for recipes that specify a language using builtin shebang matching
(recipe_body
(shebang) @injection.shebang
(#set! injection.include-children)) @injection.content
52 changes: 42 additions & 10 deletions runtime/queries/just/locals.scm
Original file line number Diff line number Diff line change
@@ -1,10 +1,42 @@
(assignment (NAME) @local.definition)
(alias left:(NAME) @local.definition)
(alias right:(NAME) @local.reference)
(value (NAME) @local.reference)
(parameter (NAME) @local.definition)

(call (NAME) @local.reference)
(dependency (NAME) @local.reference)
(depcall (NAME) @local.reference)
(recipeheader (NAME) @local.definition)
; From <https://github.com/IndianBoy42/tree-sitter-just/blob/6c2f018ab1d90946c0ce029bb2f7d57f56895dff/queries-flavored/helix/locals.scm>
;
; This file tells us about the scope of variables so e.g. local
; variables override global functions with the same name

; Scope

(recipe) @local.scope

; Definitions

(alias
left: (identifier) @local.definition)

(assignment
left: (identifier) @local.definition)

(module
name: (identifier) @local.definition)

(parameter
name: (identifier) @local.definition)

(recipe_header
name: (identifier) @local.definition)

; References

(alias
right: (identifier) @local.reference)

(function_call
name: (identifier) @local.reference)

(dependency
name: (identifier) @local.reference)

(dependency_expression
name: (identifier) @local.reference)

(value
(identifier) @local.reference)
Loading