Add a GraphQL schema linter, fix found issues #5112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
for alpha input fields Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
focusaurus
suggested changes
Apr 10, 2019
.reaction/graphql-linter-rules/type_fields_sorted_alphabetically.js
Outdated
Show resolved
Hide resolved
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
focusaurus
reviewed
Apr 10, 2019
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
focusaurus
approved these changes
Apr 10, 2019
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Causes errors from Apollo since it was removed from the schema Signed-off-by: Eric Dobbertin <eric@dairystatedesigns.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Impact: minor
Type: feature
Issue
People often forget or don't know about our conventions for the GraphQL schema files, such as always including field descriptions, alphabetizing fields, and more.
Solution
I've added graphql-schema-linter as a dev dependency, configured it, and defined a few additional custom rules for it.
It found 300+ style issues with the
.graphqlfiles, which I've also fixed in this PR. Mostly missing descriptions and fields not alphabetized.I also added this linting as a CI task.
Breaking changes
None
Testing
npm run lint:gql