graphql / graphql-js / 2330

98%

master: 98%

Pull #927

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.

3461 of 3814 branches covered (90.74%)

141 of 141 new or added lines in 10 files covered. (100.0%)

9002 of 9183 relevant lines covered (98.03%)

1280.44 hits per line