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
Что это такое?Эталонная IDE для GraphQL — графическая интерактивная среда в браузере для работы с GraphQL API, официальный проект фонда GraphQL Foundation. Этот монорепозиторий также содержит экосистему GraphQL LSP для создания браузерных и IDE-инструментов.
Это одно приложение или набор пакетов?Монорепозиторий: сама IDE GraphiQL, а также режимы редакторов для CodeMirror 5/6 и Monaco, общий пакет graphql-language-service, LSP-сервер с CLI и несколько расширений для VS Code.
Как мне это попробовать?Откройте живое демо в браузере — есть также сборка основной ветки на Netlify. Чтобы использовать его со своим API, разверните экземпляр GraphiQL, указывающий на ваш GraphQL-сервер; документация лежит в packages/graphiql.
Что мне нужно, чтобы встроить эту IDE в своё приложение?GraphiQL — это React-компонент: IDE реализована на React с режимом CodeMirror GraphQL и GraphQL Language Service. Сервер языкового сервиса и CLI — это программы для Node.
Есть ли подводные камни, о которых стоит знать заранее?Два: README предупреждает, что все версии GraphiQL уязвимы к XSS-атакам, если GraphQL-сервер, к которому они подключаются, не является доверенным, а браузерная сборка рассчитана только на современные браузеры — Internet Explorer не поддерживается.
Где всё это вообще работает?IDE работает в современных вечнозелёных браузерах, а сервер языкового сервиса и CLI собраны под рантайм Node — на нём же работают и расширения для VS Code.
Я живу в VS Code — есть для меня расширение?Да. graphql.vscode-graphql доступен в маркетплейсе VS Code и построен на сервере языкового сервиса. Есть также расширение только с подсветкой синтаксиса и одно, добавляющее выполнение запросов прямо в редакторе.
Я делаю свой инструмент для редактора — могу ли я переиспользовать части этого проекта?Ради этого экосистема и существует: codemirror-graphql предоставляет режим парсера на основе схемы с живым линтером и подсказками автодополнения, cm6-graphql покрывает CodeMirror 6, monaco-graphql — Monaco, а LSP-сервер подходит для любого IDE-расширения на базе LSP.
Можно ли расширять сам GraphiQL плагинами?Plugin API для GraphiQL сейчас в разработке — предложения открыты, и свою идею можно предложить, создав PR с документом в каталоге /proposals/.
Можно ли подключить его к любому GraphQL-серверу?Да, подойдёт любой GraphQL-эндпоинт — в репозитории даже есть простой демо-пример на чистом JavaScript с webpack, подключённый к GitHub API. Только убедитесь, что серверу можно доверять — см. предупреждение об XSS.
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