vscode-apollo 2.0.0 → 2.1.0

package/src/language-server/__tests__/fixtures/documents/taggedTemplate.ts.snap

@@ -0,0 +1,353 @@
+>// hint for reading the snapshots generated by this file:
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>// it is important to check that a rule doesn't only enter `meta.embedded.block.graphql`
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>// but also leaves it again
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>
+>declare function gql<A = any, B = any>(strings: TemplateStringsArray): void;
+#^^^^^^^ source.ts meta.function.ts storage.modifier.ts
+#       ^ source.ts meta.function.ts
+#        ^^^^^^^^ source.ts meta.function.ts storage.type.function.ts
+#                ^ source.ts meta.function.ts
+#                 ^^^ source.ts meta.function.ts meta.definition.function.ts entity.name.function.ts
+#                    ^ source.ts meta.function.ts meta.type.parameters.ts punctuation.definition.typeparameters.begin.ts
+#                     ^ source.ts meta.function.ts meta.type.parameters.ts entity.name.type.ts
+#                      ^ source.ts meta.function.ts meta.type.parameters.ts
+#                       ^ source.ts meta.function.ts meta.type.parameters.ts keyword.operator.assignment.ts
+#                        ^ source.ts meta.function.ts meta.type.parameters.ts
+#                         ^^^ source.ts meta.function.ts meta.type.parameters.ts support.type.primitive.ts
+#                            ^ source.ts meta.function.ts meta.type.parameters.ts punctuation.separator.comma.ts
+#                             ^ source.ts meta.function.ts meta.type.parameters.ts
+#                              ^ source.ts meta.function.ts meta.type.parameters.ts entity.name.type.ts
+#                               ^ source.ts meta.function.ts meta.type.parameters.ts
+#                                ^ source.ts meta.function.ts meta.type.parameters.ts keyword.operator.assignment.ts
+#                                 ^ source.ts meta.function.ts meta.type.parameters.ts
+#                                  ^^^ source.ts meta.function.ts meta.type.parameters.ts support.type.primitive.ts
+#                                     ^ source.ts meta.function.ts meta.type.parameters.ts punctuation.definition.typeparameters.end.ts
+#                                      ^ source.ts meta.function.ts meta.parameters.ts punctuation.definition.parameters.begin.ts
+#                                       ^^^^^^^ source.ts meta.function.ts meta.parameters.ts variable.parameter.ts
+#                                              ^ source.ts meta.function.ts meta.parameters.ts meta.type.annotation.ts keyword.operator.type.annotation.ts
+#                                               ^ source.ts meta.function.ts meta.parameters.ts meta.type.annotation.ts
+#                                                ^^^^^^^^^^^^^^^^^^^^ source.ts meta.function.ts meta.parameters.ts meta.type.annotation.ts entity.name.type.ts
+#                                                                    ^ source.ts meta.function.ts meta.parameters.ts punctuation.definition.parameters.end.ts
+#                                                                     ^ source.ts meta.function.ts meta.return.type.ts keyword.operator.type.annotation.ts
+#                                                                      ^ source.ts meta.function.ts meta.return.type.ts
+#                                                                       ^^^^ source.ts meta.function.ts meta.return.type.ts support.type.primitive.ts
+#                                                                           ^ source.ts punctuation.terminator.statement.ts
+>declare function foo<A = any, B = any>(strings: TemplateStringsArray): void;
+#^^^^^^^ source.ts meta.function.ts storage.modifier.ts
+#       ^ source.ts meta.function.ts
+#        ^^^^^^^^ source.ts meta.function.ts storage.type.function.ts
+#                ^ source.ts meta.function.ts
+#                 ^^^ source.ts meta.function.ts meta.definition.function.ts entity.name.function.ts
+#                    ^ source.ts meta.function.ts meta.type.parameters.ts punctuation.definition.typeparameters.begin.ts
+#                     ^ source.ts meta.function.ts meta.type.parameters.ts entity.name.type.ts
+#                      ^ source.ts meta.function.ts meta.type.parameters.ts
+#                       ^ source.ts meta.function.ts meta.type.parameters.ts keyword.operator.assignment.ts
+#                        ^ source.ts meta.function.ts meta.type.parameters.ts
+#                         ^^^ source.ts meta.function.ts meta.type.parameters.ts support.type.primitive.ts
+#                            ^ source.ts meta.function.ts meta.type.parameters.ts punctuation.separator.comma.ts
+#                             ^ source.ts meta.function.ts meta.type.parameters.ts
+#                              ^ source.ts meta.function.ts meta.type.parameters.ts entity.name.type.ts
+#                               ^ source.ts meta.function.ts meta.type.parameters.ts
+#                                ^ source.ts meta.function.ts meta.type.parameters.ts keyword.operator.assignment.ts
+#                                 ^ source.ts meta.function.ts meta.type.parameters.ts
+#                                  ^^^ source.ts meta.function.ts meta.type.parameters.ts support.type.primitive.ts
+#                                     ^ source.ts meta.function.ts meta.type.parameters.ts punctuation.definition.typeparameters.end.ts
+#                                      ^ source.ts meta.function.ts meta.parameters.ts punctuation.definition.parameters.begin.ts
+#                                       ^^^^^^^ source.ts meta.function.ts meta.parameters.ts variable.parameter.ts
+#                                              ^ source.ts meta.function.ts meta.parameters.ts meta.type.annotation.ts keyword.operator.type.annotation.ts
+#                                               ^ source.ts meta.function.ts meta.parameters.ts meta.type.annotation.ts
+#                                                ^^^^^^^^^^^^^^^^^^^^ source.ts meta.function.ts meta.parameters.ts meta.type.annotation.ts entity.name.type.ts
+#                                                                    ^ source.ts meta.function.ts meta.parameters.ts punctuation.definition.parameters.end.ts
+#                                                                     ^ source.ts meta.function.ts meta.return.type.ts keyword.operator.type.annotation.ts
+#                                                                      ^ source.ts meta.function.ts meta.return.type.ts
+#                                                                       ^^^^ source.ts meta.function.ts meta.return.type.ts support.type.primitive.ts
+#                                                                           ^ source.ts punctuation.terminator.statement.ts
+>declare type SomeResult = any;
+#^^^^^^^ source.ts meta.type.declaration.ts storage.modifier.ts
+#       ^ source.ts meta.type.declaration.ts
+#        ^^^^ source.ts meta.type.declaration.ts storage.type.type.ts
+#            ^ source.ts meta.type.declaration.ts
+#             ^^^^^^^^^^ source.ts meta.type.declaration.ts entity.name.type.alias.ts
+#                       ^ source.ts meta.type.declaration.ts
+#                        ^ source.ts meta.type.declaration.ts keyword.operator.assignment.ts
+#                         ^ source.ts meta.type.declaration.ts
+#                          ^^^ source.ts meta.type.declaration.ts support.type.primitive.ts
+#                             ^ source.ts punctuation.terminator.statement.ts
+>declare type SomeVariables = any;
+#^^^^^^^ source.ts meta.type.declaration.ts storage.modifier.ts
+#       ^ source.ts meta.type.declaration.ts
+#        ^^^^ source.ts meta.type.declaration.ts storage.type.type.ts
+#            ^ source.ts meta.type.declaration.ts
+#             ^^^^^^^^^^^^^ source.ts meta.type.declaration.ts entity.name.type.alias.ts
+#                          ^ source.ts meta.type.declaration.ts
+#                           ^ source.ts meta.type.declaration.ts keyword.operator.assignment.ts
+#                            ^ source.ts meta.type.declaration.ts
+#                             ^^^ source.ts meta.type.declaration.ts support.type.primitive.ts
+#                                ^ source.ts punctuation.terminator.statement.ts
+>
+>// for comparison - this is what a normal function all is colored
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>foo`query Foo { test }`;
+#^^^ source.ts entity.name.function.tagged-template.ts
+#   ^ source.ts string.template.ts punctuation.definition.string.template.begin.ts
+#    ^^^^^^^^^^^^^^^^^^ source.ts string.template.ts
+#                      ^ source.ts string.template.ts punctuation.definition.string.template.end.ts
+#                       ^ source.ts punctuation.terminator.statement.ts
+>foo<SomeResult, SomeVariables>`query Foo { test }`;
+#^^^ source.ts entity.name.function.tagged-template.ts
+#   ^ source.ts meta.type.parameters.ts punctuation.definition.typeparameters.begin.ts
+#    ^^^^^^^^^^ source.ts meta.type.parameters.ts entity.name.type.ts
+#              ^ source.ts meta.type.parameters.ts punctuation.separator.comma.ts
+#               ^ source.ts meta.type.parameters.ts
+#                ^^^^^^^^^^^^^ source.ts meta.type.parameters.ts entity.name.type.ts
+#                             ^ source.ts meta.type.parameters.ts punctuation.definition.typeparameters.end.ts
+#                              ^ source.ts string.template.ts punctuation.definition.string.template.begin.ts
+#                               ^^^^^^^^^^^^^^^^^^ source.ts string.template.ts
+#                                                 ^ source.ts string.template.ts punctuation.definition.string.template.end.ts
+#                                                  ^ source.ts punctuation.terminator.statement.ts
+>
+>// prettier-ignore
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>gql`query Q1 { test }`
+#^^^^ source.ts
+#    ^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#         ^ source.ts meta.embedded.block.graphql
+#          ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#            ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#             ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#              ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#               ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+#                   ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#                    ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#                     ^ source.ts
+>
+>// prettier-ignore
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>gql<SomeResult, SomeVariables>`query Q2 { test }`
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts
+#                               ^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#                                    ^ source.ts meta.embedded.block.graphql
+#                                     ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#                                       ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#                                        ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#                                         ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#                                          ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+#                                              ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#                                               ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#                                                ^ source.ts
+>
+>// prettier-ignore
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>gql  <SomeResult, SomeVariables>  `
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts
+>query Q3 { test }`
+#^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#     ^ source.ts meta.embedded.block.graphql
+#      ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#        ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#         ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#          ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#           ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+#               ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#                ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#                 ^ source.ts
+>
+>// prettier-ignore
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>gql    `query Q4 { test }`
+#^^^^^^^^ source.ts
+#        ^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#             ^ source.ts meta.embedded.block.graphql
+#              ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#                ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#                 ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#                  ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#                   ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+#                       ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#                        ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#                         ^ source.ts
+>
+>gql`
+#^^^^ source.ts
+>  query Q5 {
+#^^ source.ts meta.embedded.block.graphql
+#  ^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#       ^ source.ts meta.embedded.block.graphql
+#        ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#          ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#           ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>    test
+#^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#    ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+>  }
+#^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#  ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>`;
+#^ source.ts
+# ^ source.ts punctuation.terminator.statement.ts
+>
+>gql<SomeResult, SomeVariables>`
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts
+>  query Q6 {
+#^^ source.ts meta.embedded.block.graphql
+#  ^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#       ^ source.ts meta.embedded.block.graphql
+#        ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#          ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#           ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>    test
+#^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#    ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+>  }
+#^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#  ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>`;
+#^ source.ts
+# ^ source.ts punctuation.terminator.statement.ts
+>
+>// prettier-ignore
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>gql   `
+#^^^^^^^ source.ts
+>  query Q7 {
+#^^ source.ts meta.embedded.block.graphql
+#  ^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#       ^ source.ts meta.embedded.block.graphql
+#        ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#          ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#           ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>    test
+#^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#    ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+>  }
+#^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#  ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>`;
+#^ source.ts
+# ^ source.ts punctuation.terminator.statement.ts
+>
+>// syntax highlighting cannot work in all examples after this - textmate grammars don't work over multiple lines like this
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>
+>// prettier-ignore
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>gql
+#^^^ source.ts variable.other.readwrite.ts
+>`query Q8 { test }`
+#^ source.ts string.template.ts punctuation.definition.string.template.begin.ts
+# ^^^^^^^^^^^^^^^^^ source.ts string.template.ts
+#                  ^ source.ts string.template.ts punctuation.definition.string.template.end.ts
+>
+>// prettier-ignore
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>gql<{
+#^^^ source.ts meta.function-call.ts entity.name.function.ts
+#   ^ source.ts meta.type.parameters.ts punctuation.definition.typeparameters.begin.ts
+#    ^ source.ts meta.type.parameters.ts meta.object.type.ts punctuation.definition.block.ts
+>  test: string;
+#^^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts
+#  ^^^^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts meta.definition.property.ts variable.object.property.ts
+#      ^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts meta.type.annotation.ts keyword.operator.type.annotation.ts
+#       ^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts meta.type.annotation.ts
+#        ^^^^^^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts meta.type.annotation.ts support.type.primitive.ts
+#              ^ source.ts meta.type.parameters.ts meta.object.type.ts punctuation.terminator.statement.ts
+>},{
+#^ source.ts meta.type.parameters.ts meta.object.type.ts punctuation.definition.block.ts
+# ^ source.ts meta.type.parameters.ts punctuation.separator.comma.ts
+#  ^ source.ts meta.type.parameters.ts meta.object.type.ts punctuation.definition.block.ts
+>  test: string;
+#^^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts
+#  ^^^^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts meta.definition.property.ts variable.object.property.ts
+#      ^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts meta.type.annotation.ts keyword.operator.type.annotation.ts
+#       ^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts meta.type.annotation.ts
+#        ^^^^^^ source.ts meta.type.parameters.ts meta.object.type.ts meta.field.declaration.ts meta.type.annotation.ts support.type.primitive.ts
+#              ^ source.ts meta.type.parameters.ts meta.object.type.ts punctuation.terminator.statement.ts
+>}>`query Q9 { test }`
+#^ source.ts meta.type.parameters.ts meta.object.type.ts punctuation.definition.block.ts
+# ^ source.ts meta.type.parameters.ts punctuation.definition.typeparameters.end.ts
+#  ^ source.ts string.template.ts punctuation.definition.string.template.begin.ts
+#   ^^^^^^^^^^^^^^^^^ source.ts string.template.ts
+#                    ^ source.ts string.template.ts punctuation.definition.string.template.end.ts
+>
+>gql<
+#^^^ source.ts variable.other.readwrite.ts
+#   ^ source.ts keyword.operator.relational.ts
+>  {
+#^^ source.ts
+#  ^ source.ts meta.block.ts punctuation.definition.block.ts
+>    test: string;
+#^^^^ source.ts meta.block.ts
+#    ^^^^ source.ts meta.block.ts entity.name.label.ts
+#        ^ source.ts meta.block.ts punctuation.separator.label.ts
+#         ^ source.ts meta.block.ts
+#          ^^^^^^ source.ts meta.block.ts variable.other.readwrite.ts
+#                ^ source.ts meta.block.ts punctuation.terminator.statement.ts
+>  },
+#^^ source.ts meta.block.ts
+#  ^ source.ts meta.block.ts punctuation.definition.block.ts
+#   ^ source.ts punctuation.separator.comma.ts
+>  {
+#^^ source.ts
+#  ^ source.ts meta.block.ts punctuation.definition.block.ts
+>    test: string;
+#^^^^ source.ts meta.block.ts
+#    ^^^^ source.ts meta.block.ts entity.name.label.ts
+#        ^ source.ts meta.block.ts punctuation.separator.label.ts
+#         ^ source.ts meta.block.ts
+#          ^^^^^^ source.ts meta.block.ts variable.other.readwrite.ts
+#                ^ source.ts meta.block.ts punctuation.terminator.statement.ts
+>  }
+#^^ source.ts meta.block.ts
+#  ^ source.ts meta.block.ts punctuation.definition.block.ts
+>>`
+#^ source.ts keyword.operator.relational.ts
+# ^ source.ts string.template.ts punctuation.definition.string.template.begin.ts
+>  query Q10 {
+#^^^^^^^^^^^^^^ source.ts string.template.ts
+>    test
+#^^^^^^^^^ source.ts string.template.ts
+>  }
+#^^^^ source.ts string.template.ts
+>`;
+#^ source.ts string.template.ts punctuation.definition.string.template.end.ts
+# ^ source.ts punctuation.terminator.statement.ts
+>
+>// prettier-ignore
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>gql
+#^^^ source.ts variable.other.readwrite.ts
+>`
+#^ source.ts string.template.ts punctuation.definition.string.template.begin.ts
+>  query Q11 {
+#^^^^^^^^^^^^^^ source.ts string.template.ts
+>    test
+#^^^^^^^^^ source.ts string.template.ts
+>  }
+#^^^^ source.ts string.template.ts
+>`;
+#^ source.ts string.template.ts punctuation.definition.string.template.end.ts
+# ^ source.ts punctuation.terminator.statement.ts
+>
+>export {};
+#^^^^^^ source.ts meta.export.ts keyword.control.export.ts
+#      ^ source.ts meta.export.ts
+#       ^ source.ts meta.export.ts meta.block.ts punctuation.definition.block.ts
+#        ^ source.ts meta.export.ts meta.block.ts punctuation.definition.block.ts
+#         ^ source.ts punctuation.terminator.statement.ts
+>

package/src/language-server/__tests__/fixtures/documents/templateWithComment.ts

@@ -0,0 +1,38 @@
+// hint for reading the snapshots generated by this file:
+// it is important to check that a rule doesn't only enter `meta.embedded.block.graphql`
+// but also leaves it again
+
+`#NormalComment
+query Foo {test}`;
+
+`#graphql
+query Q1 {test}`;
+
+` # graphql
+query Q2 {test}`;
+
+`# GraphQL
+query Q3 {
+  test
+}`;
+
+`#gql
+# normal comment
+query Q4 {
+  test
+}`;
+
+`#graphql
+query Q5 {
+  test
+}`;
+
+// syntax highlighting cannot work in all examples after this - textmate grammars don't work over multiple lines like this
+`
+
+# graphql
+
+query Q6 {
+  test
+}
+`;

package/src/language-server/__tests__/fixtures/documents/templateWithComment.ts.snap

@@ -0,0 +1,123 @@
+>// hint for reading the snapshots generated by this file:
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>// it is important to check that a rule doesn't only enter `meta.embedded.block.graphql`
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>// but also leaves it again
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>
+>`#NormalComment
+#^ source.ts string.template.ts punctuation.definition.string.template.begin.ts
+# ^^^^^^^^^^^^^^^ source.ts string.template.ts
+>query Foo {test}`;
+#^^^^^^^^^^^^^^^^ source.ts string.template.ts
+#                ^ source.ts string.template.ts punctuation.definition.string.template.end.ts
+#                 ^ source.ts punctuation.terminator.statement.ts
+>
+>`#graphql
+#^ source.ts
+# ^ source.ts meta.embedded.block.graphql comment.line.graphql.js
+#  ^^^^^^^ source.ts meta.embedded.block.graphql comment.line.graphql.js markup.italic
+>query Q1 {test}`;
+#^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#     ^ source.ts meta.embedded.block.graphql
+#      ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#        ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#         ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#          ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+#              ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#               ^ source.ts
+#                ^ source.ts punctuation.terminator.statement.ts
+>
+>` # graphql
+#^ source.ts
+# ^^^ source.ts meta.embedded.block.graphql comment.line.graphql.js
+#    ^^^^^^^ source.ts meta.embedded.block.graphql comment.line.graphql.js markup.italic
+>query Q2 {test}`;
+#^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#     ^ source.ts meta.embedded.block.graphql
+#      ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#        ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#         ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#          ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+#              ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+#               ^ source.ts
+#                ^ source.ts punctuation.terminator.statement.ts
+>
+>`# GraphQL
+#^ source.ts
+# ^^ source.ts meta.embedded.block.graphql comment.line.graphql.js
+#   ^^^^^^^ source.ts meta.embedded.block.graphql comment.line.graphql.js markup.italic
+>query Q3 {
+#^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#     ^ source.ts meta.embedded.block.graphql
+#      ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#        ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#         ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>  test
+#^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#  ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+>}`;
+#^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+# ^ source.ts
+#  ^ source.ts punctuation.terminator.statement.ts
+>
+>`#gql
+#^ source.ts
+# ^ source.ts meta.embedded.block.graphql comment.line.graphql.js
+#  ^^^ source.ts meta.embedded.block.graphql comment.line.graphql.js markup.italic
+># normal comment
+#^^^^^^^^^^^^^^^^ source.ts meta.embedded.block.graphql comment.line.graphql.js
+>query Q4 {
+#^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#     ^ source.ts meta.embedded.block.graphql
+#      ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#        ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#         ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>  test
+#^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#  ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+>}`;
+#^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+# ^ source.ts
+#  ^ source.ts punctuation.terminator.statement.ts
+>
+>`#graphql
+#^ source.ts
+# ^ source.ts meta.embedded.block.graphql comment.line.graphql.js
+#  ^^^^^^^ source.ts meta.embedded.block.graphql comment.line.graphql.js markup.italic
+>query Q5 {
+#^^^^^ source.ts meta.embedded.block.graphql keyword.operation.graphql
+#     ^ source.ts meta.embedded.block.graphql
+#      ^^ source.ts meta.embedded.block.graphql entity.name.function.graphql
+#        ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#         ^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+>  test
+#^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql
+#  ^^^^ source.ts meta.embedded.block.graphql meta.selectionset.graphql variable.graphql
+>}`;
+#^ source.ts meta.embedded.block.graphql meta.selectionset.graphql punctuation.operation.graphql
+# ^ source.ts
+#  ^ source.ts punctuation.terminator.statement.ts
+>
+>// syntax highlighting cannot work in all examples after this - textmate grammars don't work over multiple lines like this
+#^^ source.ts comment.line.double-slash.ts punctuation.definition.comment.ts
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.ts comment.line.double-slash.ts
+>`
+#^ source.ts string.template.ts punctuation.definition.string.template.begin.ts
+>
+># graphql
+#^^^^^^^^^^ source.ts string.template.ts
+>
+>query Q6 {
+#^^^^^^^^^^^ source.ts string.template.ts
+>  test
+#^^^^^^^ source.ts string.template.ts
+>}
+#^^ source.ts string.template.ts
+>`;
+#^ source.ts string.template.ts punctuation.definition.string.template.end.ts
+# ^ source.ts punctuation.terminator.statement.ts
+>

package/src/language-server/config/__tests__/loadConfig.ts

@@ -122,18 +122,27 @@ Object {
           }
         `,
         });
-
-        const config = await loadConfig({
-          configPath: dirPath,
-        });
-        expect(config?.rawConfig).toMatchInlineSnapshot(`
+        fs.mkdirSync(`${dir}/bin`);
+        fs.writeFileSync(`${dir}/bin/rover`, "", { mode: 0o755 });
+        let oldPath = process.env.PATH;
+        process.env.PATH = `${dir}/bin:${oldPath}`;
+        try {
+          const config = await loadConfig({
+            configPath: dirPath,
+          });
+          expect(config?.rawConfig).toMatchInlineSnapshot(`
 Object {
   "engine": Object {
     "endpoint": "https://graphql.api.apollographql.com/api/graphql",
   },
-  "rover": Object {},
+  "rover": Object {
+    "bin": "${dir}/bin/rover",
+  },
 }
 `);
+        } finally {
+          process.env.PATH = oldPath;
+        }
       }));
 
     it("[deprecated] loads config from package.json", async () => {
@@ -158,6 +167,30 @@ Object {
       const config = await loadConfig({ configPath: dirPath });
       expect(config?.client?.service).toEqual("hello");
     });
+
+    it("loads config from a ts file with CommonJs", async () => {
+      writeFilesToDir(dir, {
+        "apollo.config.ts": `module.exports = {"client": {"service": "hello"} }`,
+      });
+      const config = await loadConfig({ configPath: dirPath });
+      expect(config?.client?.service).toEqual("hello");
+    });
+
+    it("loads config from a cjs file", async () => {
+      writeFilesToDir(dir, {
+        "apollo.config.cjs": `module.exports = {"client": {"service": "hello"} }`,
+      });
+      const config = await loadConfig({ configPath: dirPath });
+      expect(config?.client?.service).toEqual("hello");
+    });
+
+    it("loads config from a mjs file", async () => {
+      writeFilesToDir(dir, {
+        "apollo.config.mjs": `export default {"client": {"service": "hello"} }`,
+      });
+      const config = await loadConfig({ configPath: dirPath });
+      expect(config?.client?.service).toEqual("hello");
+    });
   });
 
   describe("errors", () => {
@@ -243,7 +276,7 @@ Object {
   describe("env loading", () => {
     it("finds .env in config path & parses for key", async () => {
       writeFilesToDir(dir, {
-        "apollo.config.js": `module.exports = { client: { name: 'hello' } }`,
+        "apollo.config.js": `module.exports = { client: { } }`,
         ".env": `APOLLO_KEY=service:harambe:54378950jn`,
       });
 
@@ -256,7 +289,7 @@ Object {
 
     it("finds .env.local in config path & parses for key", async () => {
       writeFilesToDir(dir, {
-        "apollo.config.js": `module.exports = { client: { name: 'hello' } }`,
+        "apollo.config.js": `module.exports = { client: {  } }`,
         ".env.local": `APOLLO_KEY=service:harambe:54378950jn`,
       });
 
@@ -269,7 +302,7 @@ Object {
 
     it("finds .env and .env.local in config path & parses for key, preferring .env.local", async () => {
       writeFilesToDir(dir, {
-        "apollo.config.js": `module.exports = { client: { name: 'hello' } }`,
+        "apollo.config.js": `module.exports = { client: {  } }`,
         ".env": `APOLLO_KEY=service:hamato:54378950jn`,
         ".env.local": `APOLLO_KEY=service:yoshi:65489061ko`,
       });
@@ -313,7 +346,7 @@ Object {
     it("infers rover projects from config", () =>
       withFeatureFlags("rover", async () => {
         writeFilesToDir(dir, {
-          "apollo.config.js": `module.exports = { rover: {} }`,
+          "apollo.config.js": `module.exports = { rover: { bin: "/usr/bin/env" } }`,
         });
 
         const config = await loadConfig({

package/src/language-server/config/config.ts

@@ -6,6 +6,8 @@ import z, { ZodError } from "zod";
 import { ValidationRule } from "graphql/validation/ValidationContext";
 import { Slot } from "@wry/context";
 import { fromZodError } from "zod-validation-error";
+import which from "which";
+import { accessSync, constants as fsConstants, statSync } from "node:fs";
 
 const ROVER_AVAILABLE = (process.env.APOLLO_FEATURE_FLAGS || "")
   .split(",")
@@ -79,7 +81,30 @@ const clientConfig = z.object({
 export type ClientConfigFormat = z.infer<typeof clientConfig>;
 
 const roverConfig = z.object({
-  bin: z.string().optional(),
+  bin: z
+    .preprocess(
+      (val) => val || which.sync("rover", { nothrow: true }) || undefined,
+      z.string({
+        message:
+          "Rover binary not found. Please either install it system-wide in PATH, or provide the `bin` option. Also ensure that the binary is executable.",
+      }),
+    )
+    .refine(
+      (bin) => {
+        try {
+          // is executable?
+          accessSync(bin, fsConstants.X_OK);
+          // is a file and not a directory?
+          return statSync(bin).isFile();
+        } catch {
+          return false;
+        }
+      },
+      {
+        message:
+          "Rover binary is not marked as an executable. If you are using OS X or Linux, ensure to set the executable bit.",
+      },
+    ),
   profile: z.string().optional(),
 });
 type RoverConfigFormat = z.infer<typeof roverConfig>;