summaryrefslogtreecommitdiffstats
path: root/doc/graphql.txt
blob: 868c74d85b0d6df1c5de16ae5b4ce4bbb9a98c86 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
if !exists('g:polyglot_disabled') || index(g:polyglot_disabled, 'graphql') == -1

*graphql.txt* GraphQL plug-in for Vim                                *graphql*

CONTENTS                                                    *graphql-contents*

1. Introduction         |graphql-intro|
2. JavaScript Support   |graphql-javascript|
3. TypeScript Support   |graphql-typescript|


INTRODUCTION                                                   *graphql-intro*

This plugin provides GraphQL (http://graphql.org/) file detection, syntax
highlighting, and indentation.


JAVASCRIPT                                                *graphql-javascript*

GraphQL syntax support in ES2015 template literals is provided. It works "out
of the box" with Vim 8.2's JavaScript support. The extended syntax provided by
the vim-javascript (https://github.com/pangloss/vim-javascript) plugin is also
supported.

                                                  *graphql-javascript-options*

                                                   *g:graphql_javascript_tags*
|g:graphql_javascript_tags|                                    list of strings

  Default: `["gql", "graphql", "Relay.QL"]`

  This variable lists the ES2015 template tag names that will be recognized as
  containing GraphQL template literal strings.


TYPESCRIPT                                                *graphql-typescript*

Like |graphql-javascript|, GraphQL syntax support in ES2015 template literals
is provided. It also works "out of the box" with Vim 8.2's TypeScript support,
which is based on the yats (https://github.com/HerringtonDarkholme/yats.vim)
plugin. For older versions, you can install yats directly.

TypeScript syntax support also uses |graphql-javascript-options| to customize
the list of recognized template tag names.

REASONML                                                    *graphql-reasonml*

GraphQL syntax support inside of ReasonML template strings using graphql-ppx
is available.

------------------------------------------------------------------------------
vim:tw=78:ft=help:norl:

endif