Skip to content

Script syntax highlighting #620

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

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

Script syntax highlighting #620

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c3df4d8
Configured workspace for linting JS scripts.
reduckted Jul 18, 2026
7a3a75e
Created scripts to generate grammars.
reduckted Aug 9, 2026
e5fcfb7
Created a grammar for syntax highlighting the JavaScript in `actions/…
reduckted Aug 9, 2026
af1d4cb
Created a grammar for syntax highlighting the scripts in `run` proper…
reduckted Aug 9, 2026
1c71e32
Added tests for the expression grammar.
reduckted Aug 9, 2026
0c5deef
Fixed bug in expressions grammar where `null`, `true` and `false` wer…
reduckted Aug 16, 2026
95ac773
Added tests for the `actions/github-script` grammar.
reduckted Aug 12, 2026
f4ef5d5
Added tests for the `run` grammar.
reduckted Aug 12, 2026
dba255f
Added diagnostics to advise on how to use `shell` properties.
reduckted Aug 16, 2026
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
Prev Previous commit
Next Next commit
Added tests for the run grammar.
  • Loading branch information
@reduckted
reduckted committed Aug 16, 2026
commit f4ef5d549c2a81cef1de5d8451e2d0101efce4a3
0 ...script/comments-after-properties.test.yml → ...pt/comments-after-property-names.test.yml
View file
Open in desktop
File renamed without changes.
0 ...t/comments-after-properties.test.yml.snap → ...mments-after-property-names.test.yml.snap
View file
Open in desktop
File renamed without changes.
2 changes: 2 additions & 0 deletions language/syntaxes/test/actions-github-script/composite-action.test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# SYNTAX TEST "source.github-actions-workflow" "`actions/github-script` used in a composite action"

name: Test

description: Test
Expand Down
5 changes: 5 additions & 0 deletions language/syntaxes/test/actions-github-script/composite-action.test.yml.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# SYNTAX TEST "source.github-actions-workflow" "autogenerated snapshot test"
># SYNTAX TEST "source.github-actions-workflow" "`actions/github-script` used in a composite action"
#^ source.github-actions-workflow comment.line.number-sign.yaml punctuation.definition.comment.yaml
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.github-actions-workflow comment.line.number-sign.yaml
>
#^ source.github-actions-workflow
>name: Test
#^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
Expand Down
16 changes: 16 additions & 0 deletions language/syntaxes/test/actions-github-script/invalid-content.test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# SYNTAX TEST "source.github-actions-workflow" "invalid content at the end of lines"

name: Test

on:
workflow_dispatch:

jobs:
test:
runs-on: ubuntu-latest

steps:
- uses: actions/github-script@v9 test
with: test
script: | test
console.log("Hello");
80 changes: 80 additions & 0 deletions language/syntaxes/test/actions-github-script/invalid-content.test.yml.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# SYNTAX TEST "source.github-actions-workflow" "autogenerated snapshot test"
># SYNTAX TEST "source.github-actions-workflow" "invalid content at the end of lines"
#^ source.github-actions-workflow comment.line.number-sign.yaml punctuation.definition.comment.yaml
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.github-actions-workflow comment.line.number-sign.yaml
>
#^ source.github-actions-workflow
>name: Test
#^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
>on:
#^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
> workflow_dispatch:
#^^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^^^^^^^^^^^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
>jobs:
#^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
> test:
#^^ source.github-actions-workflow
# ^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
> runs-on: ubuntu-latest
#^^^^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml
# ^^^^^^^^^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
> steps:
#^^^^ source.github-actions-workflow
# ^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
> - uses: actions/github-script@v9 test
#^^^^^^ source.github-actions-workflow
# ^ source.github-actions-workflow punctuation.definition.block.sequence.item.yaml
# ^ source.github-actions-workflow
# ^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^^^^^^^^^^^^^^^^^^^^^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
# ^^^^^ source.github-actions-workflow invalid.illegal.expected-comment-or-newline.yaml
> with: test
#^^^^^^^^ source.github-actions-workflow
# ^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^^^^^ source.github-actions-workflow invalid.illegal.expected-comment-or-newline.yaml
> script: | test
#^^^^^^^^^^ source.github-actions-workflow
# ^^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow keyword.control.flow.block-scalar.literal.yaml
# ^^^^^ source.github-actions-workflow invalid.illegal.expected-comment-or-newline.yaml
> console.log("Hello");
#^^^^^^^^^^^^ source.github-actions-workflow meta.embedded.inline.javascript
# ^^^^^^^ source.github-actions-workflow meta.embedded.inline.javascript meta.function-call.js variable.other.object.js
# ^ source.github-actions-workflow meta.embedded.inline.javascript meta.function-call.js punctuation.accessor.js
# ^^^ source.github-actions-workflow meta.embedded.inline.javascript meta.function-call.js entity.name.function.js
# ^ source.github-actions-workflow meta.embedded.inline.javascript meta.brace.round.js
# ^ source.github-actions-workflow meta.embedded.inline.javascript string.quoted.double.js punctuation.definition.string.begin.js
# ^^^^^ source.github-actions-workflow meta.embedded.inline.javascript string.quoted.double.js
# ^ source.github-actions-workflow meta.embedded.inline.javascript string.quoted.double.js punctuation.definition.string.end.js
# ^ source.github-actions-workflow meta.embedded.inline.javascript meta.brace.round.js
# ^ source.github-actions-workflow meta.embedded.inline.javascript punctuation.terminator.statement.js
>
#^ source.github-actions-workflow meta.embedded.inline.javascript
45 changes: 45 additions & 0 deletions language/syntaxes/test/run/blank-lines-between-properties.test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# SYNTAX TEST "source.github-actions-workflow" "blank lines between properties"

name: Test

on:
workflow_dispatch:

defaults:

run:

shell: pwsh

jobs:

a:

defaults:

run:

shell: python

steps:

- name: First

shell: cmd

run: |
echo "Hello"

- name: Second

run: |
print("Hello")

b:

steps:

- name: First

run: |
Write-Host "Hello"
184 changes: 184 additions & 0 deletions language/syntaxes/test/run/blank-lines-between-properties.test.yml.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
# SYNTAX TEST "source.github-actions-workflow" "autogenerated snapshot test"
># SYNTAX TEST "source.github-actions-workflow" "blank lines between properties"
#^ source.github-actions-workflow comment.line.number-sign.yaml punctuation.definition.comment.yaml
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.github-actions-workflow comment.line.number-sign.yaml
>
#^ source.github-actions-workflow
>name: Test
#^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
>on:
#^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
> workflow_dispatch:
#^^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^^^^^^^^^^^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
>defaults:
#^^^^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> run:
#^^ source.github-actions-workflow
# ^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> shell: pwsh
#^^^^ source.github-actions-workflow
# ^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
>jobs:
#^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> a:
#^^ source.github-actions-workflow
# ^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> defaults:
#^^^^ source.github-actions-workflow
# ^^^^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> run:
#^^^^^^ source.github-actions-workflow
# ^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> shell: python
#^^^^^^^^ source.github-actions-workflow
# ^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^^^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
> steps:
#^^^^ source.github-actions-workflow
# ^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> - name: First
#^^^^^^ source.github-actions-workflow
# ^ source.github-actions-workflow punctuation.definition.block.sequence.item.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml
# ^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
> shell: cmd
#^^^^^^^^ source.github-actions-workflow
# ^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
> run: |
#^^^^^^^^ source.github-actions-workflow
# ^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow keyword.control.flow.block-scalar.literal.yaml
> echo "Hello"
#^^^^^^^^^^ source.github-actions-workflow meta.embedded.inline.batchfile
# ^^^^ source.github-actions-workflow meta.embedded.inline.batchfile keyword.command.batchfile
# ^ source.github-actions-workflow meta.embedded.inline.batchfile
# ^ source.github-actions-workflow meta.embedded.inline.batchfile string.quoted.double.batchfile punctuation.definition.string.begin.batchfile
# ^^^^^ source.github-actions-workflow meta.embedded.inline.batchfile string.quoted.double.batchfile
# ^ source.github-actions-workflow meta.embedded.inline.batchfile string.quoted.double.batchfile punctuation.definition.string.end.batchfile
>
#^ source.github-actions-workflow meta.embedded.inline.batchfile
> - name: Second
#^^^^^^ source.github-actions-workflow
# ^ source.github-actions-workflow punctuation.definition.block.sequence.item.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml
# ^^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
> run: |
#^^^^^^^^ source.github-actions-workflow
# ^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow keyword.control.flow.block-scalar.literal.yaml
> print("Hello")
#^^^^^^^^^^ source.github-actions-workflow meta.embedded.inline.python
# ^^^^^ source.github-actions-workflow meta.embedded.inline.python meta.function-call.python support.function.builtin.python
# ^ source.github-actions-workflow meta.embedded.inline.python meta.function-call.python punctuation.definition.arguments.begin.python
# ^ source.github-actions-workflow meta.embedded.inline.python meta.function-call.python meta.function-call.arguments.python string.quoted.single.python punctuation.definition.string.begin.python
# ^^^^^ source.github-actions-workflow meta.embedded.inline.python meta.function-call.python meta.function-call.arguments.python string.quoted.single.python
# ^ source.github-actions-workflow meta.embedded.inline.python meta.function-call.python meta.function-call.arguments.python string.quoted.single.python punctuation.definition.string.end.python
# ^ source.github-actions-workflow meta.embedded.inline.python meta.function-call.python punctuation.definition.arguments.end.python
# ^^ source.github-actions-workflow meta.embedded.inline.python
>
#^ source.github-actions-workflow meta.embedded.inline.python
> b:
#^^ source.github-actions-workflow
# ^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> steps:
#^^^^ source.github-actions-workflow
# ^^^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
>
#^ source.github-actions-workflow
> - name: First
#^^^^^^ source.github-actions-workflow
# ^ source.github-actions-workflow punctuation.definition.block.sequence.item.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^^^ source.github-actions-workflow string.unquoted.plain.out.yaml entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow string.unquoted.plain.out.yaml
# ^^^^ source.github-actions-workflow string.unquoted.plain.out.yaml
>
#^ source.github-actions-workflow
> run: |
#^^^^^^^^ source.github-actions-workflow
# ^^^ source.github-actions-workflow entity.name.tag.yaml
# ^ source.github-actions-workflow punctuation.separator.key-value.mapping.yaml
# ^ source.github-actions-workflow
# ^ source.github-actions-workflow keyword.control.flow.block-scalar.literal.yaml
> Write-Host "Hello"
#^^^^^^^^^^ source.github-actions-workflow meta.embedded.inline.powershell
# ^^^^^^^^^^ source.github-actions-workflow meta.embedded.inline.powershell support.function.powershell
# ^ source.github-actions-workflow meta.embedded.inline.powershell
# ^ source.github-actions-workflow meta.embedded.inline.powershell string.quoted.double.powershell punctuation.definition.string.begin.powershell
# ^^^^^ source.github-actions-workflow meta.embedded.inline.powershell string.quoted.double.powershell
# ^ source.github-actions-workflow meta.embedded.inline.powershell string.quoted.double.powershell punctuation.definition.string.end.powershell
>
#^ source.github-actions-workflow meta.embedded.inline.powershell
18 changes: 18 additions & 0 deletions language/syntaxes/test/run/blank-lines-in-block.test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# SYNTAX TEST "source.github-actions-workflow" "blank lines in block"

name: Test

on:
workflow_dispatch:

jobs:
test:
steps:
- name: Test
shell: bash
run: |
one=1
two=2
three=2

echo "${one} + ${two} = ${three}"
Loading