graphql/graphiql

Wrap auto-completed list input values with square brackets if required

Open

#587 opened on Sep 2, 2017

View on GitHub
 (11 comments) (8 reactions) (0 assignees)TypeScript (15,473 stars) (1,785 forks)batch import
buggood first issuegraphql-language-service

Description

In Gatsby's connections, you can add a sort input like the following:

allMarkdownRemark(sort: { fields: [frontmatter___title], order: DESC}) {
  edges {
    node {
      id
    }
  }
}

But in graphiql, it doesn't enforce that fields must be an array so people regularly complain sorting is broken as they just add a field in the UI and then when they try to copy that into a project it won't work.

Is there a reason graphiql is like this? It seems to be casting the single values to an array which is why it seems to work.

Contributor guide

Tech stack
typescriptreact
Domain
frontenddeveloper experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GraphQLReactGraphiQL codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the auto complete logic in GraphiQL's query editor to determine where list input values are being suggested without brackets. Look for the component responsible for rendering or inserting auto completed values. Consider adding logic to wrap single values in an array when the field expects a list type. Check the GraphQL schema introspection to identify list types. Review comments in the issue for prior discussion and potential solutions.