From 38faf74febf3332fb119302324bfd21229d39e14 Mon Sep 17 00:00:00 2001 From: Elliot Fontaine <92150839+elliotfontaine@users.noreply.github.com> Date: Wed, 30 Oct 2024 19:39:24 +0100 Subject: [PATCH] feat: Add support for cylc configuration files (#11830) Co-authored-by: Michael Davis --- book/src/generated/lang-support.md | 1 + languages.toml | 13 +++- runtime/queries/cylc/highlights.scm | 100 +++++++++++++++++++++++++++ runtime/queries/cylc/indents.scm | 19 +++++ runtime/queries/cylc/injections.scm | 20 ++++++ runtime/queries/cylc/textobjects.scm | 23 ++++++ 6 files changed, 175 insertions(+), 1 deletion(-) create mode 100644 runtime/queries/cylc/highlights.scm create mode 100644 runtime/queries/cylc/indents.scm create mode 100644 runtime/queries/cylc/injections.scm create mode 100644 runtime/queries/cylc/textobjects.scm diff --git a/book/src/generated/lang-support.md b/book/src/generated/lang-support.md index 4f9b64de0..09f15b374 100644 --- a/book/src/generated/lang-support.md +++ b/book/src/generated/lang-support.md @@ -29,6 +29,7 @@ | crystal | ✓ | ✓ | | `crystalline` | | css | ✓ | | ✓ | `vscode-css-language-server` | | cue | ✓ | | | `cuelsp` | +| cylc | ✓ | ✓ | ✓ | | | d | ✓ | ✓ | ✓ | `serve-d` | | dart | ✓ | ✓ | ✓ | `dart` | | dbml | ✓ | | | | diff --git a/languages.toml b/languages.toml index 57d220b61..3d4d1f908 100644 --- a/languages.toml +++ b/languages.toml @@ -3845,7 +3845,18 @@ comment-tokens = ["#", "##"] indent = { tab-width = 2, unit = " " } language-servers = ["pylsp" ] - [[grammar]] name = "snakemake" source = { git = "https://github.com/osthomas/tree-sitter-snakemake", rev = "e909815acdbe37e69440261ebb1091ed52e1dec6" } + +[[language]] +name = "cylc" +scope = "source.cylc" +injection-regex = "cylc" +file-types = ["cylc", { glob = "suite.rc" }] +comment-tokens = "#" +indent = { tab-width = 4, unit = " " } + +[[grammar]] +name = "cylc" +source = { git = "https://github.com/elliotfontaine/tree-sitter-cylc", rev = "30dd40d9bf23912e4aefa93eeb4c7090bda3d0f6" } \ No newline at end of file diff --git a/runtime/queries/cylc/highlights.scm b/runtime/queries/cylc/highlights.scm new file mode 100644 index 000000000..e9e1194f1 --- /dev/null +++ b/runtime/queries/cylc/highlights.scm @@ -0,0 +1,100 @@ +(ERROR) @markup.bold + +[ + (jinja2_expression) + (jinja2_statement) + (jinja2_comment) + (jinja2_shebang) +] @special + +(include_statement + directive: _ @keyword.directive + path: _ @string.special.path) + +(comment) @comment.line + +(graph_section + name: _? @label) + +(task_section + name: (_ + (task_name) @namespace)) + +(top_section + brackets_open: _ @punctuation.bracket + name: _? @label + brackets_close: _ @punctuation.bracket) + +(sub_section_1 + brackets_open: _ @punctuation.bracket + name: _? @label + brackets_close: _ @punctuation.bracket) + +(sub_section_2 + brackets_open: _ @punctuation.bracket + name: _? @label + brackets_close: _ @punctuation.bracket) + +(runtime_section + brackets_open: _ @punctuation.bracket + name: _? @label + brackets_close: _ @punctuation.bracket) + +(graph_setting + key: (_) @constant.numeric.integer + operator: (_)? @operator) + +(quoted_graph_string + quotes_open: _ @string + quotes_close: _ @string) + +(multiline_graph_string + quotes_open: _ @string + quotes_close: _ @string) + +[ + (graph_logical) + (graph_arrow) + (graph_parenthesis) +] @operator + +(intercycle_annotation + (recurrence) @constant.numeric.integer) + +(graph_task + xtrigger: _? @operator + suicide: _? @operator + name: _ @namespace) + +(task_parameter + "<" @tag + name: (_)? @special + ","? @tag + "="? @tag + selection: (_)? @special + ">" @tag) + +(intercycle_annotation + "[" @tag + (recurrence)? @constant.numeric.integer + "]" @tag) + +(task_output + ":" @tag + (nametag) @variable.other) + +(task_output + "?"? @tag) + +(setting + key: (key) @variable + operator: (_)? @operator + value: [ + (unquoted_string) @string + (quoted_string) @string + (multiline_string) @string + (boolean) @constant.builtin.boolean + (integer) @constant.numeric.integer + ]?) + +(datetime) @constant.numeric.float diff --git a/runtime/queries/cylc/indents.scm b/runtime/queries/cylc/indents.scm new file mode 100644 index 000000000..865386c78 --- /dev/null +++ b/runtime/queries/cylc/indents.scm @@ -0,0 +1,19 @@ +[ + (top_section) + (sub_section_1) + (sub_section_2) + (graph_section) + (runtime_section) + (task_section) +] @indent + +[ + (top_section) + (sub_section_1) + (sub_section_2) + (graph_section) + (runtime_section) + (task_section) +] @extend + +(line_continuation) @indent.always diff --git a/runtime/queries/cylc/injections.scm b/runtime/queries/cylc/injections.scm new file mode 100644 index 000000000..d10931f45 --- /dev/null +++ b/runtime/queries/cylc/injections.scm @@ -0,0 +1,20 @@ +((setting + key: (key) @key + (#match? @key "^script$|-script$|^script-") + value: (_ + (string_content) @injection.content)) + (#set! "injection.language" "bash")) + +; Requires no spacing around "=" in environment settings for proper highlighting. +; Could be improved if Tree-sitter allowed to specify the target node of the injected +; language, instead of always using the root node. +; See this proposal: +; https://github.com/tree-sitter/tree-sitter/issues/3625 +((task_section + (sub_section_2 + name: (_) @section_name + (#eq? @section_name "environment") + (setting) @injection.content)) + (#set! "injection.language" "bash") + (#set! injection.combined) + (#set! injection.include-children)) diff --git a/runtime/queries/cylc/textobjects.scm b/runtime/queries/cylc/textobjects.scm new file mode 100644 index 000000000..00ed52ff8 --- /dev/null +++ b/runtime/queries/cylc/textobjects.scm @@ -0,0 +1,23 @@ +(comment) @comment.inside + +(comment)+ @comment.around + +(_ + brackets_open: _ + name: _? + brackets_close: _ + _* @class.inside) @class.around + +(setting + value: _? @function.inside) @function.around + +(graph_setting + value: _? @function.inside) @function.around + +(graph_string_content + (graph_task) @entry.inside) + +(task_parameter + ((_) @parameter.inside + . + ","? @parameter.around) @parameter.around)