Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Descriptions as strings #77

Closed
cjoudrey opened this issue Dec 4, 2017 · 5 comments
Closed

Descriptions as strings #77

cjoudrey opened this issue Dec 4, 2017 · 5 comments
Assignees

Comments

@cjoudrey
Copy link
Owner

cjoudrey commented Dec 4, 2017

As per graphql/graphql-js#927, descriptions are now strings instead of comments in the SDL.

In order to provide a graceful upgrade path, we could bump graphql-js and add a new configuration option called --comments-as-descriptions that would toggle buildASTSchema's {commentDescriptions: true}.

@adampash
Copy link

As a new user, this is a blocker for me (I'm using the latest graphql-js but can't write descriptions with strings if I'm using this linter). Looking into it, it looks like the latest release of graphql-js has removed the getDescription export, but it's been merged back into master. It seems like once graphql-js cuts a new release, graphql-schema-linter could be updated?

@cjoudrey
Copy link
Owner Author

@adampash thanks for the feedback. Now that the changes were shipped in graphql-js I think this becomes even more important.

I believe we could also temporarily run off graphql-js's master branch if a release doesn't come shortly.

@cjoudrey cjoudrey self-assigned this Feb 12, 2018
@cjoudrey
Copy link
Owner Author

@adampash just wanted to give you an update. I'm working on this at the moment and should be available in next release. 😁

@cjoudrey
Copy link
Owner Author

This has shipped in 0.1.0.

@adampash
Copy link

Thanks @cjoudrey!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants