graphiql README

The project's README from github.com/graphql/graphiql. As one markdown file: README.md.

GraphQL IDE Monorepo

Security Notice: All versions of graphiql < 1.4.7 are vulnerable to an XSS attack in cases where the GraphQL server to which the GraphiQL web app connects is not trusted. Learn more in the graphiql security docs directory

Looking for the GraphiQL Docs?: This is the root of the monorepo! The full GraphiQL docs are located at packages/graphiql

Build Status pkg.pr.new Discord Code Coverage GitHub top language GitHub language count Snyk Vulnerabilities for GitHub Repo CII Best Practices

Overview

GraphiQL (pronounced like "graphical") is the reference implementation of this monorepo, GraphQL IDE, an official project under the GraphQL Foundation. The code uses the permissive MIT license.

Whether you want a simple GraphiQL IDE instance for your server, or a more advanced web or desktop GraphQL IDE experience for your framework or plugin, or you want to build an IDE extension or plugin, you've come to the right place!

The purpose of this monorepo is to give the GraphQL Community:

graphiql

NPM jsDelivr hits (npm) npm downloads Snyk Vulnerabilities for npm package npm bundle size (version) npm bundle size (version)

Screenshot of GraphiQL with Doc Explorer Open

/ˈɡrafək(ə)l/ A graphical interactive in-browser GraphQL IDE. Try the live demo. We also have a demo using our latest netlify build for the main branch.

The GraphiQL IDE, implemented in React, currently using GraphQL mode for CodeMirror & GraphQL Language Service.

Learn more about GraphiQL in packages/graphiql/README.md

monaco-graphql

NPM jsDelivr hits (npm) npm downloads Snyk Vulnerabilities for npm package

Provides monaco editor with a powerful, schema-driven graphql language mode. Uses the graphql-language-servicedirectly.

See the webpack example for a plain javascript demo using GitHub API

codemirror-graphql

NPM jsDelivr hits (npm) npm downloads Snyk Vulnerabilities for npm package

Animated Codemirror GraphQL Completion Example

Provides CodeMirror 5 with a parser mode for GraphQL along with a live linter and typeahead hinter powered by your GraphQL Schema. Uses the graphql-language-service.

cm6-graphql

NPM jsDelivr hits (npm) npm downloads Snyk Vulnerabilities for npm package

Provides CodeMirror 6 with a full-featured language mode for GraphQL. Uses the graphql-language-service.

graphql-language-service

NPM npm downloads Snyk Vulnerabilities for npm package

Provides language services for graphql-language-service-server codemirror-graphql and monaco-graphql. Previously published separately as the now-retired graphql-language-service-interface, graphql-language-service-parser, graphql-language-service-utils and graphql-language-service-types.

graphql-language-service-server

NPM npm downloads Snyk Vulnerabilities for npm package

Provides language services for LSP-based IDE extensions using the graphql-language-service

graphql.vscode-graphql

An example implementation of graphql-language-service-server for Visual Studio Code. Available on the marketplace. OVSX fix is pending.

graphql.vscode-graphql-syntax

A new syntax highlighting-only extension for vscode to be used by other vscode extensions.

graphql.vscode-graphql-execution

An extension for vscode-graphql that allows inline query execution.

graphql-language-service-cli

NPM npm downloads Snyk Vulnerabilities for npm package

Provides a CLI for the language service server.

Browser & Runtime Support

Many of these packages need to work in multiple environments.

By default, all typescript packages target es6.

graphql-language-service-server and graphql-language-service-cli are made for the node runtime, so they target es2017

codemirror-graphql and the graphiql browser bundle use the .browserslistrc, which targets modern browsers to keep bundle size small and keep the language services performant where async/await is used, and especially to avoid the requirement of regenerator-runtime or special babel configuration.

.browserslistrc:

last 2 versions
Firefox ESR
not dead
not IE 11
not ios 10
maintained node versions

To be clear, we do not support Internet Explorer or older versions of evergreen browsers.

Development

To get setup for local development of this monorepo, refer to DEVELOPMENT.md

Contributing to this repo

This is an open source project, and we welcome contributions. Please see CONTRIBUTING.md for details on how to contribute.

This repository is managed by EasyCLA. Project participants must sign the free GraphQL Specification Membership agreement before making a contribution. You only need to do this one time, and it can be signed by individual contributors or their employers.

To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.

Please note that EasyCLA is configured to accept commits from certain GitHub bots. These are approved on an exception basis once we are confident that any content they create is either unlikely to consist of copyrightable content or else was written by someone who has already signed the CLA (e.g., a project maintainer). The bots that have currently been approved as exceptions are:

You can find detailed information here. If you have issues, please email [email protected].

Maintainers

Maintainers of this repository regularly review PRs and issues and help advance the GraphiQL roadmap

Alumni

Without these amazing past maintainers, where would we be?!

Active

Maintainers who are currently active (to varying degrees, please contact us via our discord channels!):

Thank you graphql community for all the help & support! I did it all for you, and I couldn't have done it without you ❤️ - @acao

Fielding Proposals!

The door is open for proposals for the new GraphiQL Plugin API, and other ideas on how to make the rest of the IDE ecosystem more performant, scalable, interoperable and extensible. Feel free to open a PR to create a document in the /proposals/ directory. Eventually we hope to move these to a repo that serves this purpose.

Community

graphiql (graphql/graphiql)

Searching Database…

16.9K ·GitHub
Graphiql
What is this?The reference GraphQL IDE — a graphical, interactive in-browser IDE for exploring GraphQL APIs, run as an official project of the GraphQL Foundation. This monorepo also hosts the GraphQL LSP ecosystem for building browser and IDE tools.
Is this one app or a collection of packages?A monorepo: the GraphiQL IDE itself, plus editor modes for CodeMirror 5/6 and Monaco, the shared graphql-language-service, an LSP server and CLI, and several VS Code extensions.
How do I try it?Open the live demo in your browser — there is also a Netlify build of the main branch. To use it with your own API, host a GraphiQL instance pointed at your GraphQL server; the docs live in packages/graphiql.
What do I need if I want to embed the IDE in my own app?GraphiQL is a React component — the IDE is implemented in React with the CodeMirror GraphQL mode and the GraphQL Language Service. The language service server and CLI are Node programs.
Any gotchas I should know about before using it?Two: the README warns that all GraphiQL versions are open to XSS attacks when the GraphQL server they connect to is not trusted, and the browser bundle targets modern browsers only — no Internet Explorer.
Where does all of this actually run?The IDE runs in modern evergreen browsers, while the language service server and CLI are built for the Node runtime — which is also what powers the VS Code extensions.
I live in VS Code — is there an extension for me?Yes. graphql.vscode-graphql is on the VS Code marketplace, built on the language service server. There is also a syntax-highlighting-only extension and one that adds inline query execution.
I am building my own editor tooling — can I reuse parts of this?That is half the point of the ecosystem: codemirror-graphql ships a schema-powered parser mode with a live linter and typeahead hinter, cm6-graphql covers CodeMirror 6, monaco-graphql covers Monaco, and the LSP server backs any LSP-based IDE extension.
Can I extend GraphiQL itself with plugins?A GraphiQL Plugin API is being designed right now — proposals are open, and you can pitch ideas by opening a PR with a document in the /proposals/ directory.
Can I point it at any GraphQL server?Yes, any GraphQL endpoint works — the repo even ships a plain JavaScript webpack demo wired to the GitHub API. Just make sure it is a server you trust, per the XSS notice.
What are similar projects?theia, monaco-editor, rust-analyzer, pretty-ts-errors, awesome-vscode, vira-assets, vscode-extension-samples, void
Which topics is it in?monaco-editor, language-server-protocol, syntax-highlighting, vscode-extension, graphql, ide, vscode, monorepo, editor, react, frontend, nodejs
Creator
graphql
Size
36.7 MB
Stars
16.9K
Updated
CommitOct 15Release@graphiql/[email protected]Sep 30
Age
11y
Commits · 90 Days