GraphQL: Support for multiline strings

[dblessing]

Fixes #992 and fixes #993

Adds support for multiline strings for GraphQL and markdown descriptions.

Markdown descriptions are in the GraphQL spec at https://facebook.github.io/graphql/draft/#sec-Descriptions

[dblessing]

@langpavel What do you think of this? It adds support for regular multiline string values, plus markdown descriptions.

One note that differs from your example in #993. The first line is not made into a markdown header in this case. That's because the GraphQL lexer simply delegates the text to the Markdown lexer, which would only make the first line a header if it was preceded by some form of #.

Is this acceptable? If this is a surprise for GraphQL users we could potentially inject a preceding #. Although, that would be slightly unprecedented in Rouge, I think.

[langpavel]

@dblessing Hi, thank you for your effort!

I think that first line can be treated as you did, so it will not break reading so much.
<h1> is often too big and results may be horrible if you inject # implicitly.

It's perfectly fine to left first paragraph as is, you can see that other tooling like graphiql and prisma interprets first line as plain paragraph...

[dblessing]

@langpavel Perfect! I'll take this as-is, then.

If you're familiar with GraphQL and multiline strings, would you mind checking that my second example in the samples file is valid? From looking at the multiline spec, I believe it is but I have little real-world experience on GraphQL.

[langpavel]

If you're familiar with GraphQL and multiline strings, would you mind checking that my second example in the samples file is valid? From looking at the multiline spec, I believe it is but I have little real-world experience on GraphQL.

Yes, it is valid (only not recommended style)

[langpavel]

Only issue I can imagine is with de-indenting strategy in GraphQL parser tokenizer:

• see this code in reference implementation: graphql-js — src/language/blockStringValue.js
• spec for String Value
• spec for BlockStringCharacter

[langpavel]

Good first step! 🎉

[langpavel]

Thank you @dblessing! I will be very satisfied if this lands soon! :-)

[dblessing]

Thanks @langpavel

[langpavel]

Can I kindly ask you when you plan new release? @dblessing @jneen 🙏