Skip to content

Add block strings to GraphQL grammar #282

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

Merged
merged 1 commit into from
Mar 6, 2025
Merged

Add block strings to GraphQL grammar #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/kind-dodos-repair.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"vscode-apollo": patch
---

Improve syntax highlighting for GraphQL block strings
14 changes: 14 additions & 0 deletions syntaxes/graphql.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,19 @@
"1": { "name": "constant.language.null.graphql" }
}
},
"graphql-block-string-value": {
"contentName": "string.quoted.triple.block.graphql",
"begin": "\\s*+((\"\"\"))",
"end": "\\s*+((\"\"\"))",
Comment on lines +490 to +491
Copy link

@nicholascioli nicholascioli Mar 6, 2025

Choose a reason for hiding this comment

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

Do we really want to capture the optional whitespace before the """ in both the start and end of the block string? Would just capturing """ be enough?

Copy link

@nicholascioli nicholascioli Mar 6, 2025

Choose a reason for hiding this comment

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

Also, this might be a dumb question but what does \s*+ mean?

Copy link
Author

@pubmodmatt pubmodmatt Mar 6, 2025

Choose a reason for hiding this comment

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

\s*+ is just possessive matching of whitespace. Since the existing string.quoted.double.graphql is using possessive whitespace matching already, we need to use it here as well, or it ends up matching the other pattern since possessive whitespace followed by one " also matches whitespace followed by """.

"beginCaptures": {
"1": { "name": "string.quoted.triple.block.graphql" },
"2": { "name": "punctuation.definition.string.begin.graphql" }
},
"endCaptures": {
"1": { "name": "string.quoted.triple.block.graphql" },
"2": { "name": "punctuation.definition.string.end.graphql" }
}
},
"graphql-string-value": {
"contentName": "string.quoted.double.graphql",
"begin": "\\s*+((\"))",
Expand Down Expand Up @@ -553,6 +566,7 @@
"patterns": [
{ "include": "#graphql-variable-name" },
{ "include": "#graphql-float-value" },
{ "include": "#graphql-block-string-value" },
{ "include": "#graphql-string-value" },
{ "include": "#graphql-boolean-value" },
{ "include": "#graphql-null-value" },
Expand Down