graphql / graphql-js / 2348

98%

master: 98%

push

travis-ci

RFC: Descriptions as strings.

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.

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.

3472 of 3824 branches covered (90.79%)

138 of 138 new or added lines in 9 files covered. (100.0%)

9015 of 9194 relevant lines covered (98.05%)

1278.92 hits per line