diff options
author | Adam Stankiewicz <sheerun@sher.pl> | 2020-08-25 14:03:03 +0200 |
---|---|---|
committer | Adam Stankiewicz <sheerun@sher.pl> | 2020-08-25 14:03:03 +0200 |
commit | e47af23f64e4c02ab85080e94c23e57b3f66ecda (patch) | |
tree | b02a2ea865faa46501da7480e11f38a2c0661b01 /doc/graphql.txt | |
parent | 8f5134aef8c4162235892d87407275f447e54e40 (diff) | |
download | vim-polyglot-e47af23f64e4c02ab85080e94c23e57b3f66ecda.tar.gz vim-polyglot-e47af23f64e4c02ab85080e94c23e57b3f66ecda.zip |
Cleanup ftdetect
Diffstat (limited to 'doc/graphql.txt')
-rw-r--r-- | doc/graphql.txt | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/graphql.txt b/doc/graphql.txt new file mode 100644 index 00000000..3f41deaa --- /dev/null +++ b/doc/graphql.txt @@ -0,0 +1,55 @@ +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 when vim-reasonml (https://github.com/jordwalke/vim-reasonml) is +also installed. + +------------------------------------------------------------------------------ +vim:tw=78:ft=help:norl: + +endif |