graphql / graphql-js / 2640

98%

push

travis-ci

RFC: Descriptions as strings. (#927)

As discussed in https://github.com/facebook/graphql/pull/90

This proposes replacing leading comment blocks as descriptions in the schema definition language with leading strings (typically block strings).

While I think there is some reduced ergonomics of using a string literal instead of a comment to write descriptions (unless perhaps you are accustomed to Python or Clojure), there are some compelling advantages:

* Descriptions are first-class in the AST of the schema definition language.
* Comments can remain "ignored" characters.
* No ambiguity between commented out regions and descriptions.

Specific to this reference implementation, since this is a breaking change and comment descriptions in the experimental SDL have fairly wide usage, I've left the comment description implementation intact and allow it to be enabled via an option. This should help with allowing upgrading with minimal impact on existing codebases and aid in automated transforms.

3860 of 4342 branches covered (88.9%)

9385 of 9581 relevant lines covered (97.95%)

1230.2 hits per line