GraphQL: Add support for Block Strings (stkb#261)

Co-authored-by: Steve Baker <scsavtnk@gmail.com>
GProulx · Mar 25, 2021 · c62907d · c62907d
1 parent d9d2e17
commit c62907d
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,9 @@ See also [https://github.com/stkb/vscode-rewrap/releases](https://github.com/stk
 ## Unreleased
 
 - Add ERB (HTML) `.html.erb` (#265).
+- Add support for [Block
+  Strings](https://github.com/graphql/graphql-spec/pull/327)
+  in GraphQL files. (#261)
 - Add XAML type (#263).
 
 

diff --git a/core/Parsing.Documents.fs b/core/Parsing.Documents.fs
@@ -129,7 +129,11 @@ let mutable languages = [
     lang "Git commit" "git-commit" "tag_editmsg"
         Markdown.markdown
     lang "GraphQL" "" ".graphql|.gql"
-        configFile
+        ( sourceCode
+            [ line "#"
+              block ( @".*?""""""", "\"\"\"" )
+            ]
+        )
     lang "Groovy" "" ".groovy"
         java
     lang "Handlebars" "" ".handlebars|.hbs"

diff --git a/specs/DocTypes/Graphql.md b/specs/DocTypes/Graphql.md
@@ -0,0 +1,34 @@
+> language: "graphql"
+
+GraphQL supports comments (`#`) and Block Strings (`"""`). Comments are always
+single-line, while Block Strings are inherently multi-line. Block Strings are
+typically used to provide descriptions (documentation) for GraphQL types and
+operations.
+
+## Comments
+
+    # a b c d e f g h i     ->      # a b c d¦
+             ¦                      # e f g h¦
+             ¦                      # i      ¦
+
+## Block Strings
+
+    """      ¦              ->     """      ¦
+    a b c d e f g h i              a b c d e¦
+    """      ¦                     f g h i  ¦
+             ¦                     """      ¦
+
+    type Mutation {  ¦                    type Mutation {  ¦
+        """          ¦                        """          ¦
+        This is a long line.      ->          This is a    ¦
+        """          ¦                        long line.   ¦
+        loginUser() String                    """          ¦
+    }                ¦                        loginUser() String
+                     ¦                    }                ¦
+
+    foo {        ¦               foo {        ¦
+      bar(baz: """                 bar(baz: """
+        a b c d e f      ->          a b c d e¦
+        g h      ¦                   f g h    ¦
+      """)       ¦                 """)       ¦
+    }            ¦               }            ¦