[
{
"path": ".browserslistrc",
"content": "last 2 versions\nFirefox ESR\nnot dead\nnot IE 11\nnot ios 10\n"
},
{
"path": ".changeset/README.md",
"content": "# Changesets\n\nHello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works\nwith multi-package repos, or single-package repos to help you version and publish your code. You can\nfind the full documentation for it [in our repository](https://github.com/changesets/changesets)\n\nWe have a quick list of common questions to get you started engaging with this project in\n[our documentation](https://github.com/changesets/changesets/blob/master/docs/common-questions.md)\n"
},
{
"path": ".changeset/config.json",
"content": "{\n \"$schema\": \"https://unpkg.com/@changesets/config@2.0.1/schema.json\",\n \"changelog\": [\"@changesets/changelog-github\", { \"repo\": \"graphql/graphiql\" }],\n \"commit\": false,\n \"linked\": [],\n \"access\": \"public\",\n \"baseBranch\": \"main\",\n \"ignore\": [\n \"example-graphiql-vite\",\n \"example-graphiql-vite-react-router\",\n \"example-graphiql-webpack\",\n \"example-monaco-graphql-nextjs\",\n \"example-monaco-graphql-react-vite\",\n \"example-monaco-graphql-webpack\"\n ],\n \"updateInternalDependencies\": \"patch\",\n \"___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH\": {\n \"onlyUpdatePeerDependentsWhenOutOfRange\": true\n }\n}\n"
},
{
"path": ".codecov.yml",
"content": "codecov:\n notify:\n require_ci_to_pass: yes\n\ncoverage:\n precision: 2\n round: down\n range: '30...100'\n\n status:\n project:\n default:\n target: 50% # the minimum required coverage value\n threshold: .1% # the leniency in hitting the target, allows 1% drop\n patch:\n default:\n informational: true\n\ncomment: # this is a top-level key\n layout: 'reach, diff, flags, files'\n behavior: default\n require_changes: true # if true: only post the comment if coverage changes\n"
},
{
"path": ".editorconfig",
"content": "# EditorConfig is awesome: https://EditorConfig.org\n\n# top-most EditorConfig file\nroot = true\n\n# Unix-style newlines with a newline ending every file\n[*]\nend_of_line = lf\ninsert_final_newline = true\n"
},
{
"path": ".eslintignore",
"content": ".changeset/*.md\n\n# ignore working-group dir markdown so it's easier for people to edit from the UI\nworking-group/\npackages/codemirror-graphql/src/__tests__/schema-kitchen-sink.graphql\nCHANGELOG.md\n**/CHANGELOG.md\npackages/vscode-graphql-syntax/tests/__fixtures__/\npackages/graphql-language-service-server/src/__tests__/parseDocument.test.ts\n"
},
{
"path": ".eslintrc.js",
"content": "/**\n * Copyright (c) Facebook, Inc.\n * All rights reserved.\n *\n * This source code is licensed under the license found in the\n * LICENSE file in the root directory of this source tree.\n *\n */\n\nconst RESTRICTED_IMPORTS = [\n { name: 'graphql/type', message: 'use `graphql`' },\n { name: 'graphql/language', message: 'use `graphql`' },\n { name: 'graphql/type/introspection', message: 'use `graphql`' },\n { name: 'graphql/type/definition', message: 'use `graphql`' },\n { name: 'graphql/type/directives', message: 'use `graphql`' },\n { name: 'graphql/version', message: 'use `graphql`' },\n {\n name: 'monaco-editor',\n message:\n '`monaco-editor` imports all languages; use `monaco-graphql/esm/monaco-editor` instead to import only `json` and `graphql` languages',\n allowTypeImports: true,\n },\n];\n\nmodule.exports = {\n root: true,\n reportUnusedDisableDirectives: true,\n ignorePatterns: [\n 'react-app-env.d.ts',\n 'next-env.d.ts',\n 'changesets/**/*.md',\n '**/CHANGELOG.md',\n 'functions/*',\n 'packages/vscode-graphql-syntax/tests/__fixtures__/*',\n // symlinks\n 'packages/graphiql-react/__mocks__/monaco-editor.ts',\n 'packages/graphiql-plugin-doc-explorer/__mocks__/zustand.ts',\n 'packages/graphiql-plugin-doc-explorer/__mocks__/monaco-editor.ts',\n 'packages/graphiql-plugin-history/__mocks__/zustand.ts',\n 'packages/graphiql-plugin-history/__mocks__/monaco-editor.ts',\n ],\n overrides: [\n {\n // Rules for all code files\n files: ['**/*.{js,jsx,ts,tsx,mts,cts}'],\n parserOptions: {\n ecmaVersion: 6,\n },\n settings: {\n react: {\n version: 'detect',\n },\n },\n // https://github.com/sindresorhus/globals/blob/master/globals.json\n env: {\n atomtest: true,\n es6: true,\n node: true,\n browser: true,\n },\n extends: [\n 'eslint:recommended',\n 'plugin:@typescript-eslint/recommended',\n 'plugin:import-x/recommended',\n 'plugin:import-x/typescript',\n 'plugin:react/recommended',\n 'plugin:react-hooks/recommended-legacy',\n 'plugin:react/jsx-runtime',\n 'prettier',\n ],\n plugins: ['promise', 'sonarjs', 'unicorn', '@shopify'],\n globals: {\n atom: false,\n document: false,\n window: false,\n monaco: true,\n Map: true,\n Set: true,\n },\n rules: {\n '@shopify/prefer-early-return': ['error', { maximumStatements: 2 }],\n '@shopify/prefer-class-properties': 'off', // enable after https://github.com/Shopify/web-configs/issues/387 will be fixed\n 'sonarjs/no-inverted-boolean-check': 'error',\n // Possible Errors (http://eslint.org/docs/rules/#possible-errors)\n 'no-console': 'error',\n 'no-constant-binary-expression': 'error',\n 'no-empty': ['error', { allowEmptyCatch: true }],\n 'no-extra-parens': 'off',\n 'no-template-curly-in-string': 'off',\n 'valid-jsdoc': 'off',\n\n // Best Practices (http://eslint.org/docs/rules/#best-practices)\n 'accessor-pairs': 'error',\n 'array-callback-return': 'off',\n 'block-scoped-var': 'off',\n 'class-methods-use-this': 'off',\n complexity: 'off',\n 'consistent-return': 'off',\n curly: 'error',\n 'default-case': 'off',\n 'dot-notation': 'error',\n eqeqeq: ['error', 'allow-null'],\n 'guard-for-in': 'off',\n 'no-alert': 'error',\n 'no-await-in-loop': 'error',\n 'no-caller': 'error',\n 'no-case-declarations': 'off',\n 'no-div-regex': 'error',\n 'no-else-return': ['error', { allowElseIf: false }],\n 'no-eq-null': 'off',\n 'no-eval': 'error',\n 'no-extend-native': 'error',\n 'no-extra-bind': 'error',\n 'no-extra-label': 'error',\n 'no-floating-decimal': 'off', // prettier --list-different\n 'no-implicit-coercion': 'error',\n 'no-implicit-globals': 'off',\n 'no-implied-eval': 'error',\n 'no-invalid-this': 'off',\n 'no-iterator': 'error',\n 'no-labels': 'error',\n 'no-lone-blocks': 'error',\n 'no-loop-func': 'off',\n 'no-magic-numbers': 'off',\n 'no-multi-str': 'off',\n 'no-new-func': 'error',\n 'no-new-wrappers': 'error',\n 'no-new': 'error',\n 'no-octal-escape': 'error',\n 'no-param-reassign': 'error',\n 'no-proto': 'error',\n 'no-restricted-properties': [\n 'error',\n {\n object: 'window',\n property: 'localStorage',\n message: 'Use `localStorage` instead',\n },\n {\n object: 'window',\n property: 'location',\n message: 'Use `location` instead',\n },\n {\n object: 'window',\n property: 'navigator',\n message: 'Use `navigator` instead',\n },\n {\n object: 'window',\n property: 'getComputedStyle',\n message: 'Use `getComputedStyle` instead',\n },\n {\n object: 'self',\n message: 'Use `globalThis` instead',\n },\n ],\n 'no-return-assign': 'error',\n 'no-return-await': 'error',\n 'no-script-url': 'error',\n 'no-self-compare': 'error',\n 'no-sequences': 'error',\n 'no-throw-literal': 'error',\n 'no-unmodified-loop-condition': 'off',\n 'no-useless-call': 'error',\n 'no-useless-concat': 'error',\n 'no-useless-return': 'off',\n 'no-warning-comments': 'off',\n radix: 'error',\n 'require-await': 'off',\n 'vars-on-top': 'off',\n yoda: 'error',\n 'unicorn/prefer-string-slice': 'error',\n 'sonarjs/no-identical-functions': 'error',\n 'sonarjs/no-unused-collection': 'error',\n 'sonarjs/no-extra-arguments': 'error',\n 'unicorn/no-useless-undefined': 'error',\n 'no-var': 'error',\n // Strict Mode (http://eslint.org/docs/rules/#strict-mode)\n strict: 'off',\n\n // Variables (http://eslint.org/docs/rules/#variables)\n 'init-declarations': 'off',\n 'no-catch-shadow': 'error',\n 'no-label-var': 'error',\n 'no-restricted-globals': ['error', 'stop'],\n 'no-shadow': 'off',\n '@typescript-eslint/no-shadow': 'error',\n 'no-undef-init': 'off',\n 'no-undefined': 'off',\n\n '@typescript-eslint/no-unused-vars': [\n 'error',\n {\n varsIgnorePattern: '^(React|_)', // allow underscores in destructuring\n argsIgnorePattern: '^_',\n },\n ],\n\n 'no-use-before-define': 'off',\n\n 'unicorn/no-useless-switch-case': 'error',\n // Node.js and CommonJS (http://eslint.org/docs/rules/#nodejs-and-commonjs)\n 'callback-return': 'off',\n 'global-require': 'off',\n 'handle-callback-err': 'error',\n 'no-mixed-requires': 'error',\n 'no-new-require': 'error',\n 'no-path-concat': 'error',\n 'no-process-env': 'off',\n 'no-process-exit': 'off',\n 'no-restricted-modules': 'off',\n 'no-sync': 'off',\n\n // Stylistic Issues (http://eslint.org/docs/rules/#stylistic-issues)\n camelcase: 'off',\n 'capitalized-comments': 'off',\n 'consistent-this': 'off',\n 'func-name-matching': 'off',\n 'func-names': 'off',\n 'func-style': 'off',\n 'id-blacklist': 'off',\n 'id-length': 'off',\n 'id-match': 'off',\n indent: 'off',\n 'line-comment-position': 'off',\n 'linebreak-style': 'off', // prettier --list-different\n 'lines-around-comment': 'off',\n 'lines-around-directive': 'off',\n 'max-depth': 'off',\n 'max-lines': 'off',\n 'max-nested-callbacks': 'off',\n 'max-params': 'off',\n 'max-statements-per-line': 'off',\n 'max-statements': 'off',\n 'multiline-ternary': 'off',\n 'new-cap': 'off',\n 'newline-after-var': 'off',\n 'newline-before-return': 'off',\n 'newline-per-chained-call': 'off',\n 'no-bitwise': 'error',\n 'no-continue': 'off',\n 'no-inline-comments': 'off',\n 'no-mixed-operators': 'off',\n 'no-negated-condition': 'off',\n 'unicorn/no-negated-condition': 'error',\n 'no-nested-ternary': 'off',\n 'no-new-object': 'error',\n 'no-plusplus': 'off',\n 'no-restricted-syntax': [\n 'error',\n {\n // ❌ useMemo(…, [])\n selector:\n 'CallExpression[callee.name=useMemo][arguments.1.type=ArrayExpression][arguments.1.elements.length=0]',\n message:\n \"`useMemo` with an empty dependency array can't provide a stable reference, use `useRef` instead.\",\n },\n {\n // ❌ event.keyCode\n selector:\n 'MemberExpression > .property[type=Identifier][name=keyCode]',\n message: 'Use `.key` instead of `.keyCode`',\n },\n ],\n 'no-ternary': 'off',\n 'no-underscore-dangle': 'off',\n 'no-unneeded-ternary': 'off',\n 'object-curly-newline': 'off',\n 'object-property-newline': 'off',\n 'one-var-declaration-per-line': 'off',\n 'one-var': ['error', 'never'],\n 'operator-assignment': 'error',\n 'operator-linebreak': 'off',\n 'require-jsdoc': 'off',\n 'sort-keys': 'off',\n 'sort-vars': 'off',\n 'spaced-comment': ['error', 'always', { markers: ['/'] }],\n 'wrap-regex': 'off',\n 'unicorn/prefer-dom-node-remove': 'error',\n // ECMAScript 6 (http://eslint.org/docs/rules/#ecmascript-6)\n 'arrow-body-style': 'off',\n '@typescript-eslint/no-restricted-imports': [\n 'error',\n ...RESTRICTED_IMPORTS,\n ],\n 'no-useless-computed-key': 'error',\n 'no-useless-constructor': 'off',\n 'no-useless-rename': 'error',\n 'prefer-arrow-callback': ['error', { allowNamedFunctions: true }],\n 'object-shorthand': [\n 'error',\n 'always',\n { avoidExplicitReturnArrows: true },\n ],\n 'prefer-numeric-literals': 'off',\n 'prefer-template': 'off',\n 'sort-imports': 'off',\n 'symbol-description': 'error',\n\n 'sonarjs/no-ignored-return': 'error',\n 'unicorn/no-array-push-push': 'error',\n 'import-x/no-extraneous-dependencies': 'error',\n 'import-x/no-duplicates': 'error',\n 'import-x/no-named-as-default': 'error',\n 'prefer-object-spread': 'error',\n // React rules\n 'react/no-unused-state': 'error',\n 'react/jsx-curly-brace-presence': 'error',\n 'react/jsx-boolean-value': 'error',\n 'react/jsx-handler-names': 'error',\n 'react/jsx-pascal-case': 'error',\n 'react/no-did-mount-set-state': 'error',\n 'react/no-did-update-set-state': 'error',\n 'react/prop-types': 'off',\n 'react/prefer-es6-class': 'error',\n 'react/prefer-stateless-function': 'error',\n 'react/self-closing-comp': 'error',\n 'react/jsx-no-useless-fragment': 'error',\n 'react/jsx-filename-extension': [\n 'error',\n { extensions: ['.tsx', '.jsx'], allow: 'as-needed' },\n ],\n\n 'unicorn/no-typeof-undefined': 'error',\n 'unicorn/prefer-at': 'error',\n 'unicorn/consistent-destructuring': 'error',\n 'prefer-destructuring': [\n 'error',\n { VariableDeclarator: { object: true } },\n ],\n 'promise/no-multiple-resolved': 'error',\n 'unicorn/no-zero-fractions': 'error',\n 'sonarjs/no-redundant-jump': 'error',\n 'unicorn/prefer-logical-operator-over-ternary': 'error',\n 'logical-assignment-operators': [\n 'error',\n 'always',\n { enforceForIfStatements: true },\n ],\n 'unicorn/prefer-regexp-test': 'error',\n 'unicorn/prefer-export-from': ['error', { ignoreUsedVariables: true }],\n 'unicorn/throw-new-error': 'error',\n 'unicorn/prefer-includes': 'error',\n 'unicorn/no-array-for-each': 'error',\n 'unicorn/prefer-dom-node-append': 'error',\n 'no-lonely-if': 'error',\n 'unicorn/no-lonely-if': 'error',\n 'unicorn/prefer-optional-catch-binding': 'error',\n 'unicorn/prefer-array-flat-map': 'error',\n 'no-unused-expressions': 'off',\n '@typescript-eslint/no-unused-expressions': 'error',\n 'sonarjs/no-small-switch': 'error',\n 'sonarjs/no-duplicated-branches': 'error',\n 'sonarjs/prefer-promise-shorthand': 'error',\n 'sonarjs/no-dead-store': 'error',\n 'sonarjs/void-use': 'error',\n 'unicorn/prefer-node-protocol': 'error',\n 'import-x/no-unresolved': [\n 'error',\n {\n ignore: [\n '^node:',\n '\\\\.svg\\\\?react$',\n 'vitest/config',\n './vite.config.mjs',\n ],\n },\n ],\n 'no-extra-boolean-cast': [\n 'error',\n { enforceForInnerExpressions: true },\n ],\n 'unicorn/no-length-as-slice-end': 'error',\n 'unicorn/prefer-string-replace-all': 'error',\n 'unicorn/prefer-array-some': 'error',\n // '@typescript-eslint/prefer-for-of': 'error', TODO\n 'unicorn/no-hex-escape': 'off', // TODO: enable\n // doesn't catch a lot of cases; we use ESLint builtin `no-restricted-syntax` to forbid `.keyCode`\n 'unicorn/prefer-keyboard-event-key': 'off',\n\n 'unicorn/prefer-switch': 'error',\n 'unicorn/prefer-dom-node-text-content': 'error',\n quotes: ['error', 'single', { avoidEscape: true }], // Matches Prettier, but also replaces backticks with single quotes\n // TODO: Fix all errors for the following rules included in recommended config\n '@typescript-eslint/no-require-imports': 'off',\n 'import-x/no-named-as-default-member': 'off',\n },\n },\n {\n files: ['packages/{monaco-graphql,graphiql*}/**/*.{ts,tsx,mts,cts}'],\n excludedFiles: ['packages/graphiql-toolkit/**/*.{ts,tsx}'],\n rules: {\n '@typescript-eslint/no-unnecessary-condition': 'error',\n },\n },\n {\n // Rules that requires type information\n files: ['**/*.{ts,tsx,mts,cts}'],\n excludedFiles: ['**/*.{md,mdx}/*.{ts,tsx}'],\n // extends: ['plugin:@typescript-eslint/recommended-type-checked'],\n rules: {\n // '@typescript-eslint/no-redundant-type-constituents': 'error',\n '@typescript-eslint/prefer-optional-chain': 'error',\n '@typescript-eslint/no-unnecessary-type-assertion': 'error',\n '@typescript-eslint/no-floating-promises': 'error',\n '@typescript-eslint/non-nullable-type-assertion-style': 'error',\n '@typescript-eslint/consistent-type-assertions': 'error',\n '@typescript-eslint/no-duplicate-type-constituents': 'error',\n '@typescript-eslint/no-unnecessary-type-conversion': 'error',\n // '@typescript-eslint/await-thenable': 'error', // TODO\n // TODO: Fix all errors for the following rules included in recommended config\n '@typescript-eslint/no-deprecated': 'off',\n '@typescript-eslint/no-unsafe-function-type': 'off',\n\n '@typescript-eslint/no-explicit-any': 'off',\n '@typescript-eslint/no-non-null-assertion': 'off',\n '@typescript-eslint/ban-ts-comment': 'off',\n '@typescript-eslint/ban-types': 'off',\n '@typescript-eslint/no-empty-function': 'off',\n '@typescript-eslint/triple-slash-reference': 'off',\n '@typescript-eslint/no-namespace': 'off',\n },\n parserOptions: {\n projectService: {\n allowDefaultProject: [\n 'examples/monaco-graphql-react-vite/vite.config.ts',\n 'packages/{codemirror-graphql,graphiql-toolkit,graphql-language-service-cli,graphql-language-service,monaco-graphql,vscode-graphql-syntax}/vitest.config.mts',\n\n 'packages/cm6-graphql/__tests__/test.spec.ts',\n 'packages/graphiql/cypress.config.ts',\n 'packages/vscode-graphql-syntax/tests/*.spec.ts',\n 'packages/graphql-language-service-cli/src/__tests__/*.test.ts',\n 'packages/monaco-graphql/test/monaco-editor.test.ts',\n\n 'packages/codemirror-graphql/setup-files.ts',\n 'packages/codemirror-graphql/src/__tests__/testSchema.ts',\n 'packages/codemirror-graphql/src/__tests__/*.test.ts',\n 'packages/codemirror-graphql/src/{variables,utils,results}/__tests__/*.test.ts',\n\n 'packages/graphql-language-service/benchmark/index.ts',\n 'packages/graphql-language-service/src/{utils,parser,interface}/__tests__/*.test.ts',\n 'packages/graphql-language-service/src/parser/__tests__/OnlineParserUtils.ts',\n\n 'packages/graphql-language-service-server/src/__tests__/*.{spec,test}.ts',\n 'packages/graphql-language-service-server/src/__tests__/__utils__/utils.ts',\n 'packages/graphql-language-service-server/src/__tests__/__utils__/MockProject.ts',\n\n 'packages/vscode-graphql-syntax/tests/__utilities__/serializer.ts',\n 'packages/vscode-graphql-syntax/tests/__utilities__/utilities.ts',\n ],\n maximumDefaultProjectFileMatchCount_THIS_WILL_SLOW_DOWN_LINTING: 100,\n },\n },\n },\n // Cypress plugin, global, etc., only for cypress directory\n // https://github.com/cypress-io/eslint-plugin-cypress\n // cypress clashes with jest expect()\n {\n files: ['**/cypress/**'],\n extends: 'plugin:cypress/recommended',\n rules: {\n // Because innerText doesn't return hidden elements and returns new line (\\n) characters\n 'unicorn/prefer-dom-node-text-content': 'off',\n },\n },\n {\n // Rules for unit tests\n files: [\n '**/__{tests,mocks}__/*.{js,jsx,ts,tsx}',\n '**/*.spec.{ts,js.jsx.tsx}',\n ],\n extends: ['plugin:jest/recommended'],\n rules: {\n 'jest/no-conditional-expect': 'off',\n 'jest/expect-expect': ['error', { assertFunctionNames: ['expect*'] }],\n },\n },\n {\n // Resources are typically our helper scripts; make life easier there\n files: ['resources/**', '**/resources/**', 'scripts/**'],\n rules: {\n 'no-console': 'off',\n },\n },\n {\n // Disable rules for examples folder\n files: ['examples/**'],\n rules: {\n 'no-console': 'off',\n 'no-new': 'off',\n 'no-alert': 'off',\n 'import-x/no-unresolved': 'off',\n },\n },\n {\n // Rule for ignoring imported dependencies from tests files\n files: [\n '**/__tests__/**',\n 'webpack.config.js',\n '**/tests/**',\n 'test.config.js',\n 'vitest.config.mts',\n 'setup-files.ts',\n ],\n rules: {\n 'import-x/no-extraneous-dependencies': 'off',\n },\n },\n {\n // Rule for allowing import `vscode` package\n files: [\n 'packages/vscode-graphql/**',\n 'packages/vscode-graphql-execution/**',\n ],\n rules: {\n 'import-x/no-unresolved': ['error', { ignore: ['^node:', 'vscode'] }],\n },\n },\n {\n // Rule to prefer await to then without React packages because it's ugly to have `async IIFE` inside `useEffect`\n files: ['packages/**'],\n excludedFiles: ['packages/graphiql/**', 'packages/graphiql-react/**'],\n rules: {\n 'promise/prefer-await-to-then': 'error',\n },\n },\n {\n files: ['packages/{graphiql-react,graphiql}/**/*.{ts,tsx}'],\n rules: {\n '@typescript-eslint/no-restricted-imports': [\n 'error',\n ...RESTRICTED_IMPORTS,\n {\n name: 'react',\n importNames: ['memo', 'useCallback', 'useMemo'],\n },\n ],\n 'react-hooks/react-compiler': 'error',\n '@typescript-eslint/no-deprecated': 'error',\n },\n },\n {\n // Monaco-GraphQL rules\n files: ['packages/monaco-graphql/**'],\n rules: {\n '@typescript-eslint/no-restricted-imports': [\n 'error',\n ...RESTRICTED_IMPORTS.filter(({ name }) => name !== 'monaco-editor'),\n {\n name: 'monaco-editor',\n message:\n '`monaco-editor` imports all languages; use locale `monaco-editor.ts` instead to import only `json` and `graphql` languages',\n },\n ],\n },\n },\n {\n // Parsing Markdown/MDX\n files: ['**/*.{md,mdx}'],\n parser: 'eslint-mdx',\n plugins: ['mdx'],\n processor: 'mdx/remark',\n settings: {\n 'mdx/code-blocks': true,\n },\n },\n {\n files: ['**/*.d.ts'],\n rules: {\n 'no-var': 'off',\n },\n },\n {\n // ❗ALWAYS LAST\n // Rules for codeblocks inside Markdown/MDX\n files: ['**/*.{md,mdx}/*.{js,jsx,ts,tsx}'],\n rules: {\n 'import-x/no-extraneous-dependencies': 'off',\n '@typescript-eslint/no-unused-vars': 'off',\n 'import-x/no-unresolved': 'off',\n 'no-console': 'off',\n 'no-undef': 'off',\n 'react/jsx-no-undef': 'off',\n 'react-hooks/rules-of-hooks': 'off',\n 'sonarjs/no-dead-store': 'off',\n '@typescript-eslint/no-restricted-imports': 'off',\n '@typescript-eslint/no-unnecessary-condition': 'off',\n '@typescript-eslint/no-deprecated': 'off',\n },\n },\n ],\n};\n"
},
{
"path": ".gitattributes",
"content": "# Set the default behavior, in case people don't have core.autocrlf set.\n* text=auto\n\n*.js text eol=lf\n*.jsx text eol=lf\n*.ts text eol=lf\n*.tsx text eol=lf\n*.json text eol=lf\n*.md text eol=lf\n*.html text eol=lf\n*.css text eol=lf\n*.sh text eol=lf\n*.yml text eol=lf\n\n.yarn/releases/*.cjs export-ignore binary linguist-generated\n"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"content": "blank_issues_enabled: true\ncontact_links:\n - name: '📚 Support/Q&A'\n url: https://github.com/graphql/graphiql/discussions/categories/q-a-support\n about: >-\n Some questions are already answered in our github discussions Q&A section If you don't find an answer, [create a support ticket](ttps://github.com/graphql/graphiql/discussions/new?category=q-a-support)\n\n\n - name: '💬 `graphiql` Discord Support'\n url: https://discord.gg/NP5vbPeUFp\n about: '`graphiql` Discord Support Channel'\n\n - name: '💬 `vscode-graphql` Discord Support'\n url: https://discord.gg/bHrQtxGNzQ\n about: '`vscode-graphql` Discord Support Channel'\n\n - name: '💬 GraphQL LSP & CLI Discord Support'\n url: https://discord.gg/wkQCKwazxj\n about: >-\n GraphQL LSP (Language Server Protocol) Server Discord Support Channel For `graphql-language-service-server` and/or `graphql-language-service-cli`\n\n\n - name: '💬 `monaco-graphql` Discord Support'\n url: https://discord.gg/r4BxrAG6fN\n about: '`monaco-graphql` Discord Support Channel'\n\n - name: '💬 `codedemirror-graphql` Discord Support'\n url: https://discord.gg/cffZwk8NJW\n about: '`codemirror-graphql` Discord Support Channel'\n"
},
{
"path": ".github/ISSUE_TEMPLATE/graphiql-bug.yml",
"content": "name: GraphiQL 🐞 Bug\ndescription: File a bug with the graphiql web editor\ntitle: '[graphiql] '\nlabels: [bug, needs triage, graphiql]\nbody:\n - type: checkboxes\n attributes:\n label: Is there an existing issue for this?\n description: Please search to see if an issue already exists for the bug you encountered.\n options:\n - label: I have searched the existing issues\n required: true\n - type: textarea\n attributes:\n label: Current Behavior\n description: A concise description of what you're experiencing.\n validations:\n required: false\n - type: textarea\n attributes:\n label: Expected Behavior\n description: A concise description of what you expected to happen.\n validations:\n required: false\n - type: textarea\n attributes:\n label: Steps To Reproduce\n description: Steps to reproduce the behavior.\n placeholder: |\n 1. In this environment...\n 2. With this config...\n 3. Do '...' in [repro codesandbox/stackblitz]()\n 4. See error...\n validations:\n required: false\n\n - type: textarea\n attributes:\n label: Environment\n description: |\n examples:\n * **GraphiQL Version**: latest\n * **OS**: Ubuntu 20.04\n * **Browser**: Chrome 106\n * **Bundler**: vite x.y\n * **`react` Version**: 18\n * **`graphql` Version**: 16\n value: |\n * GraphiQL Version:\n * OS:\n * Browser:\n * Bundler:\n * `react` Version:\n * `graphql` Version:\n validations:\n required: false\n - type: textarea\n attributes:\n label: Anything else?\n description: |\n Links? References? Anything that will give us more context about the issue you are encountering!\n\n Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.\n validations:\n required: false\n"
},
{
"path": ".github/ISSUE_TEMPLATE/graphiql-feature.md",
"content": "---\nname: GraphiQL Feature Request\nabout: Request a feature for the graphiql web editor\ntitle: '[graphiql] <title>'\nlabels: [graphiql, enhancement]\n---\n\n<!--\n\n- Some features can be built with the new sidebar plugins\n\n We encourage exploring the plugin API prior to opening a feature request:\n\n SDK hooks\n\n https://graphiql-test.netlify.app/typedoc/modules/graphiql_react.html\n\n Sidebar Plugins\n\n api:\n https://graphiql-test.netlify.app/typedoc/modules/graphiql_react.html#graphiqlplugin-2\n\n examples:\n\n https://github.com/graphql/graphiql/tree/main/packages/graphiql-plugin-explorer\n\n\n In the event that the plugin API doesn't allow you to build a feature, it\n may be that expanding the plugin API *itself* is the best place for the\n feature to be introduced!\n\n Consider this flexible solution when opening a new feature request\n since it also unlocks new opportunities.\n\n- Prior to opening a feature request, please search for existing requests.\n\n If you find an existing feature that matches your needs, use the 👍 emote\n to show your support for it. If the specifics of your use case are not\n covered in the existing feature request but the idea seems similar enough,\n please take the time to *add new conversation* which helps the feature's\n design evolve.\n\n- If you do not find any other existing requests for the feature you desire,\n you should open a new feature request. Please take the time to help us\n understand your use-case as precisely as possible. Be sure to demonstrate\n that you've evaluated existing features and found them unsuitable and were\n unable to implement the functionality with the plugin API.\n\n Be flexible in your design and consider slight variations which might\n necessitate a specific API design. We also hope you'll be willing to engage\n in the on-going design discussion prior to opening a pull-request.\nborrowed from the apollo server template\n-->\n"
},
{
"path": ".github/ISSUE_TEMPLATE/language-server-bug.yml",
"content": "name: Generic IDE (LSP Server) Bug 🐞\ndescription: File any non syntax highlighting related bugs in vscode or any IDE lsp runtime (vim, intellij, emacs, sublime, etc), with the `graphql-language-service-server` / `graphql-lsp` CLI\ntitle: '[lsp-server] 🐞 <title>'\nlabels: [bug, lsp-server]\nbody:\n - type: checkboxes\n attributes:\n label: Is there an existing issue for this?\n description: Please search to see if an issue already exists for the bug you encountered.\n options:\n - label: I have searched the existing issues\n required: true\n\n - type: textarea\n attributes:\n label: Current Behavior\n description: A concise description of the issue you're experiencing.\n validations:\n required: false\n\n - type: textarea\n attributes:\n label: Expected Behavior\n description: A concise description of what you expected to happen.\n validations:\n required: false\n\n - type: textarea\n attributes:\n label: Steps To Reproduce\n description: Steps to reproduce the behavior.\n placeholder: |\n 1. In this environment...\n 2. With this (redacted) graphql config with [filename]...\n 3. Do '...' with [lsp client] \n 4. See errors in output channel, etc...\n validations:\n required: false\n\n - type: textarea\n attributes:\n label: Environment\n description: |\n examples:\n * **LSP Server Version**: latest\n * **OS**: Ubuntu 20.04\n * **LSP Client**: vscode (`vscode-graphql`, etc), intellij-lsp, nvim coc, etc\n value: |\n * LSP Server Version:\n * OS:\n * LSP Client:\n validations:\n required: false\n\n - type: textarea\n attributes:\n label: Anything else?\n description: |\n Links? References? Anything that will give us more context about the issue you are encountering\n\n Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/language-server-feature.md",
"content": "---\nname: LSP/CLI Feature Request\nabout: Request a feature for the `graphql-language-service-server` and/or cli\ntitle: '[lsp-server] <title>'\nlabels: [lsp-server, enhancement]\n---\n\n<!--\n\n## Current Behavior (if applicable)\n\n\n## Desired Behavior\n\n\nHelpful things to include:\n\n- screenshots & videos where applicable\n\n- graphql config sample if related to the problem you are hoping to solve\n\n- examples of other graphql language tools that support this, if applicable\n\n- if the feature involves adding support for a feature already in the current spec or proposed working group spec, please include a link to the applicable section of the spec\n\n## PRs welcome!\n\nIf you find a way to solve this problem by modifying the code in either the source or the distributed code, we are more than happy to accept enhancement requests as PRs!\n\n-->\n"
},
{
"path": ".github/ISSUE_TEMPLATE.md",
"content": "<!--\n1. Have you tried searching issues and discussions to see if your question was already answered?\n\n2. If you want to fix a bug or request a feature, PRs are always welcome!\n\n-->\n"
},
{
"path": ".github/workflows/main-test.yml",
"content": "name: Main Tests\n# report coverage on main for codecov baseline\non:\n push:\n branches: [main]\njobs:\n install:\n name: Install\n runs-on: ubuntu-latest\n\n steps:\n - name: Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.12.1\n with:\n access_token: ${{ github.token }}\n - name: Checkout Code\n uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n cache: yarn\n - name: Cache node modules\n id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - uses: actions/cache@v4\n with:\n path: |\n ~/.cache/Cypress\n key: cypress-${{ runner.os }}-${{ hashFiles('yarn.lock') }}\n - run: yarn install --frozen-lockfile --immutable\n\n jest:\n name: Jest Unit Tests\n runs-on: ubuntu-latest\n needs: [install]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - run: yarn test --coverage\n - uses: codecov/codecov-action@v4\n with:\n token: ${{ secrets.CODECOV_TOKEN }}\n files: coverage/lcov.info\n fail_ci_if_error: true\n verbose: true\n"
},
{
"path": ".github/workflows/pr-graphql-compat-check.yml",
"content": "name: Build & Test PR w/ GraphQL Regressions\non:\n push:\n # only on merge to main.\n # it's rare that this workflow would\n # show us an error, but when it does it's important!\n branches: [main]\n # don't run this regression suite if we don't need to\n paths-ignore:\n - '**.md'\n - 'examples'\n - '!examples/monaco-graphql-webpack'\n\n# TODO: test matrix?\n\npermissions:\n contents: read # to fetch code (actions/checkout)\n\njobs:\n build:\n name: Build & Test\n runs-on: ubuntu-20.04\n strategy:\n matrix:\n release:\n # test against the latest 16.x version, which might be newer than what we have\n - '^16'\n # test against the oldest version we support\n - '^16.0.0'\n # test against the latest alpha\n - '^17.0.0-alpha'\n steps:\n - name: Checkout Code\n uses: actions/checkout@v4\n\n - uses: actions/setup-node@v4\n with:\n cache: yarn\n - name: Cache node modules\n uses: actions/cache@v4\n with:\n path: node_modules\n key: node_modules-${{hashFiles('yarn.lock')}}\n restore-keys: node_modules-\n - name: Force GraphQL ${{ matrix.release }} solution\n run: yarn repo:resolve graphql@${{ matrix.release }}\n\n - run: yarn install --frozen-lockfile --immutable\n\n - name: Unit Tests\n run: yarn test:ci\n\n - name: Cypress\n run: yarn e2e\n"
},
{
"path": ".github/workflows/pr.yml",
"content": "name: PR\non:\n pull_request:\n types: [opened, synchronize]\n\njobs:\n install:\n name: Install\n runs-on: ubuntu-latest\n\n steps:\n - name: Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.12.1\n with:\n access_token: ${{ github.token }}\n - name: Checkout Code\n uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n cache: yarn\n - name: Cache node modules\n id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - uses: actions/cache@v4\n with:\n path: |\n ~/.cache/Cypress\n key: cypress-${{ runner.os }}-${{ hashFiles('yarn.lock') }}\n - run: yarn install --frozen-lockfile --immutable\n\n build:\n name: Build\n runs-on: ubuntu-latest\n needs: [install]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n\n - run: yarn build\n - uses: actions/cache@v4\n with:\n key: build-${{ github.sha }}\n path: ${{ env.BUILD-CACHE-LIST }}\n\n cspell:\n name: CSpell\n runs-on: ubuntu-latest\n needs: [install]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - run: yarn lint-cspell\n\n prettier:\n name: Prettier\n runs-on: ubuntu-latest\n needs: [install]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - run: yarn pretty-check\n\n jest:\n name: Jest Unit & Integration Tests\n runs-on: ubuntu-latest\n needs: [install]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - run: yarn test --coverage\n - uses: codecov/codecov-action@v4\n with:\n token: ${{ secrets.CODECOV_TOKEN }}\n files: coverage/lcov.info\n fail_ci_if_error: true\n verbose: true\n\n vitest:\n name: Vitest Unit Tests\n runs-on: ubuntu-latest\n needs: [build]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - uses: actions/cache@v4\n with:\n key: build-${{ github.sha }}\n path: ${{ env.BUILD-CACHE-LIST }}\n - run: yarn vitest\n\n eslint:\n name: ESLint\n runs-on: ubuntu-latest\n needs: [build]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - uses: actions/cache@v4\n with:\n key: build-${{ github.sha }}\n path: ${{ env.BUILD-CACHE-LIST }}\n - run: yarn eslint\n\n types-check:\n name: Types Check\n runs-on: ubuntu-latest\n needs: [build]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - uses: actions/cache@v4\n with:\n key: build-${{ github.sha }}\n path: ${{ env.BUILD-CACHE-LIST }}\n - run: yarn types:check\n\n e2e:\n name: Cypress\n runs-on: ubuntu-latest\n needs: [build]\n steps:\n - uses: actions/checkout@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - uses: actions/cache@v4\n with:\n key: build-${{ github.sha }}\n path: ${{ env.BUILD-CACHE-LIST }}\n - uses: actions/cache@v4\n with:\n path: |\n ~/.cache/Cypress\n key: cypress-${{ runner.os }}-${{ hashFiles('yarn.lock') }}\n - name: Cypress run\n uses: cypress-io/github-action@v6\n with:\n install: false\n command: yarn e2e\n - uses: actions/upload-artifact@v4\n if: failure()\n with:\n name: cypress-screenshots\n path: packages/graphiql/cypress/screenshots\n if-no-files-found: ignore\n - uses: actions/upload-artifact@v4\n if: failure()\n with:\n name: cypress-videos\n path: packages/graphiql/cypress/videos\n if-no-files-found: ignore\n\n canary:\n name: Canary\n runs-on: ubuntu-latest\n # ensure the basic checks pass before running the canary\n needs: [build, jest, eslint, vitest, e2e]\n if: github.event.pull_request.head.repo.full_name == github.repository\n steps:\n - uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - uses: actions/cache@v4\n with:\n key: build-${{ github.sha }}\n path: ${{ env.BUILD-CACHE-LIST }}\n - name: Setup NPM credentials\n run: echo \"//registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN\" >> ~/.npmrc\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n - name: Release Canary\n id: canary\n uses: 'kamilkisiela/release-canary@master'\n with:\n npm-token: ${{ secrets.NPM_TOKEN }}\n npm-script: 'yarn release:canary'\n changesets: true\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n - name: Publish a message\n if: steps.canary.outputs.released == 'true'\n uses: 'dotansimha/pr-comment@master'\n with:\n commentKey: canary\n message: |\n The latest changes of this PR are available as canary in npm (based on the declared `changesets`):\n\n ```\n ${{ steps.canary.outputs.changesetsPublishedPackages}}\n ```\n bot-token: ${{ secrets.GITHUB_TOKEN }}\n bot: 'github-actions[bot]'\n github-token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Publish an empty message\n if: steps.canary.outputs.released == 'false'\n uses: 'dotansimha/pr-comment@master'\n with:\n commentKey: canary\n message: |\n The latest changes of this PR are not available as canary, since there are no linked `changesets` for this PR.\n bot-token: ${{ secrets.GITHUB_TOKEN }}\n bot: 'github-actions[bot]'\n github-token: ${{ secrets.GITHUB_TOKEN }}\n\n license-check:\n name: Check Licenses\n runs-on: ubuntu-latest\n needs: [install]\n\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n - id: cache-modules\n uses: actions/cache@v4\n with:\n path: |\n **/node_modules\n key: modules-${{ github.sha }}\n - run: yarn install --frozen-lockfile --immutable\n - name: License Check\n run: yarn license-check\n\nenv:\n BUILD-CACHE-LIST: |\n packages/**/dist/**/*\n packages/**/cjs/**/*\n packages/**/esm/**/*\n packages/**/types/**/*\n packages/codemirror-graphql/*.js*\n packages/codemirror-graphql/*.d.ts\n packages/codemirror-graphql/cm6-legacy/**/*\n packages/codemirror-graphql/results/**/*\n packages/codemirror-graphql/variables/**/*\n packages/codemirror-graphql/utils/**/*\n !**/node_modules\n"
},
{
"path": ".github/workflows/release.yml",
"content": "name: Release\n\non:\n push:\n branches: [main, graphiql-5]\npermissions: {}\njobs:\n release:\n permissions:\n contents: write # for changesets/action to git push\n environment: deploy\n name: Release\n runs-on: ubuntu-latest\n steps:\n - name: Cancel Previous Runs\n uses: styfle/cancel-workflow-action@0.12.1\n with:\n access_token: ${{ github.token }}\n - name: Checkout Code\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - uses: actions/setup-node@v4\n with:\n cache: yarn\n - name: Cache node modules\n uses: actions/cache@v4\n id: cache-modules\n with:\n path: node_modules\n key: node_modules-${{hashFiles('yarn.lock')}}\n restore-keys: node_modules-\n - run: yarn install --frozen-lockfile --immutable\n - name: Create Release Pull Request or Publish to npm\n id: changesets\n uses: changesets/action@v1\n with:\n version: yarn ci:version\n # This expects you to have a script called release which does a build for your packages and calls changeset publish\n publish: yarn release\n env:\n # only use GH token here, because GITHUB_TOKEN is no longer allowed to create PRs\n GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n # for vscode marketplace, see https://github.com/microsoft/vscode-vsce/blob/194d59b975523696362ead891dc0f3ddd277b3bd/README.md#linux\n VSCE_PAT: ${{ secrets.VSCE_PAT }}\n # for ovsx, see https://github.com/eclipse/openvsx/blob/master/cli/README.md#publish-extensions\n OVSX_PAT: ${{ secrets.OPEN_VSX_TOKEN }}\n"
},
{
"path": ".gitignore",
"content": "*.swp\n*~\n.*.haste_cache.*\n.DS_Store\n.secrets\n*.log\n\n.yarn/*\n!.yarn/releases/*\n!.yarn/plugins/*\n\nnode_modules/\ncoverage/\n.nyc_output\ndist/\nesm/\nout/\n*.vsix\n*.tsbuildinfo\n\nyarn-1.18.0.js\n*.orig\n.idea/\n\n# Local Netlify folder\n.netlify/\n\nexamples/*/yarn.lock\npackage-lock.json\n.eslintcache\n.cspellcache\n\nvite.config.d.ts\nvite.config.js\ntsconfig.vitest-temp.json\n\n.next/\n.turbo/\ntypes/\npackages/codemirror-graphql/cm6-legacy/\npackages/codemirror-graphql/results/\npackages/codemirror-graphql/utils/\npackages/codemirror-graphql/variables/\npackages/codemirror-graphql/*.js\npackages/codemirror-graphql/*.d.ts\npackages/codemirror-graphql/*.map\n!packages/codemirror-graphql/*.config.js\n\npackages/graphiql/cypress/screenshots/\npackages/graphiql/cypress/downloads/\npackages/graphiql/cypress/videos/\npackages/graphiql/typedoc/\npackages/graphiql/webpack/\n\n.react-router/\n"
},
{
"path": ".mailmap",
"content": "Angel Gomez Salazar <agomezs@fb.com>\nAngel Gomez Salazar <agomezs@fb.com> Angel Gomez <AGS-@users.noreply.github.com>\nAngel Gomez Salazar <agomezs@fb.com> angel.gomez <angelegomezsd@gmail.com>\nHyohyeon Jeong <asiandrummer@fb.com> Hyo Jeong <asiandrummer@users.noreply.github.com>\n"
},
{
"path": ".npmignore",
"content": ".*\n*.swp\n*~\n*.iml\n.*.haste_cache.*\n.DS_Store\n.idea\nnpm-debug.log\n\n.babelrc\nCONTRIBUTING.md\nnode_modules\ncoverage\nresources\nsrc\npackages\npackages/graphiql/*.html\ncypress.json\nbabel.config.js\n**/*.tsbuildinfo\n"
},
{
"path": ".npmrc",
"content": "engine-strict=true\naccess=public\n"
},
{
"path": ".nvmrc",
"content": "20\n"
},
{
"path": ".prettierignore",
"content": "# removing this will break tests b/c of whitespace changes + format on save/commit, etc\npackages/graphql-language-service-server/src/__tests__/parseDocument.test.ts\n"
},
{
"path": ".prettierrc",
"content": "{\n \"singleQuote\": true,\n \"trailingComma\": \"all\",\n \"arrowParens\": \"avoid\",\n \"proseWrap\": \"never\",\n \"overrides\": [\n {\n \"files\": [\"*.md\", \"*.mdx\"],\n \"options\": {\n \"printWidth\": 80,\n \"proseWrap\": \"preserve\"\n }\n },\n {\n \"files\": \"*.svg\",\n \"options\": {\n \"parser\": \"html\"\n }\n }\n ]\n}\n"
},
{
"path": ".vscode/extensions.json",
"content": "{\n \"recommendations\": [\"dbaeumer.vscode-eslint\", \"esbenp.prettier-vscode\"]\n}\n"
},
{
"path": ".vscode/launch.json",
"content": "// A launch configuration that compiles the extension and then opens it inside a new window\n// Use IntelliSense to learn about possible attributes.\n// Hover to view descriptions of existing attributes.\n// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387\n{\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"name\": \"VS Code LSP Extension: Run\",\n \"type\": \"extensionHost\",\n \"request\": \"launch\",\n \"runtimeExecutable\": \"${execPath}\",\n \"args\": [\n \"--extensionDevelopmentPath=${workspaceFolder}/packages/vscode-graphql\"\n ],\n \"outFiles\": [\n \"${workspaceFolder}/packages/vscode-graphql/out/extension.js\"\n ],\n \"sourceMaps\": true,\n \"preLaunchTask\": \"watch-vscode\"\n },\n {\n \"type\": \"node\",\n \"name\": \"jest watch\",\n \"request\": \"launch\",\n \"program\": \"${workspaceFolder}/node_modules/jest/bin/jest\",\n \"args\": [\n \"--config\",\n \"jest.config.js\",\n \"--color\",\n \"--runInBand\",\n \"--watch\",\n \"${relativeFile}\"\n ],\n \"cwd\": \"${workspaceFolder}\",\n \"console\": \"integratedTerminal\",\n \"internalConsoleOptions\": \"neverOpen\"\n },\n {\n \"name\": \"VS Code Exec Extension: Run\",\n \"type\": \"extensionHost\",\n \"request\": \"launch\",\n \"runtimeExecutable\": \"${execPath}\",\n \"args\": [\n \"--extensionDevelopmentPath=${workspaceFolder}/packages/vscode-graphql-execution\"\n ],\n \"outFiles\": [\n \"${workspaceFolder}/packages/vscode-graphql-execution/out/extension.js\"\n ],\n \"sourceMaps\": true,\n \"preLaunchTask\": \"watch-vscode-exec\"\n }\n ]\n}\n"
},
{
"path": ".vscode/settings.json",
"content": "{\n \"npm.packageManager\": \"yarn\",\n \"editor.formatOnSave\": true,\n \"files.insertFinalNewline\": true,\n \"editor.trimAutoWhitespace\": false,\n \"coverage-gutters.showLineCoverage\": true,\n \"coverage-gutters.coverageBaseDir\": \"coverage\",\n \"coverage-gutters.coverageFileNames\": [\n \"lcov.info\",\n \"cov.xml\",\n \"coverage.xml\",\n \"jacoco.xml\",\n \"coverage.cobertura.xml\"\n ],\n \"typescript.tsdk\": \"node_modules/typescript/lib\"\n}\n"
},
{
"path": ".vscode/tasks.json",
"content": "{\n \"version\": \"2.0.0\",\n \"tasks\": [\n {\n \"label\": \"watch-vscode\",\n \"type\": \"npm\",\n \"script\": \"watch-vscode\",\n \"problemMatcher\": [\"$tsc-watch\"],\n \"isBackground\": true,\n \"presentation\": {\n \"reveal\": \"always\"\n },\n \"group\": {\n \"kind\": \"build\",\n \"isDefault\": true\n }\n },\n {\n \"label\": \"watch-vscode-exec\",\n \"type\": \"npm\",\n \"script\": \"watch-vscode-exec\",\n \"problemMatcher\": [\"$tsc-watch\"],\n \"isBackground\": true,\n \"presentation\": {\n \"reveal\": \"always\"\n },\n \"group\": {\n \"kind\": \"build\",\n \"isDefault\": true\n }\n }\n ]\n}\n"
},
{
"path": ".yarnrc.yml",
"content": "compressionLevel: 0\n\nenableGlobalCache: false\n\nnodeLinker: node-modules\n\nyarnPath: .yarn/releases/yarn-4.9.1.cjs\n"
},
{
"path": "CHANGELOG.md",
"content": "> **Archived** For up to date changelogs that are automatically generated by [changesets](https://github.com/atlassian/changesets), see CHANGELOG.md files in respective workspaces. For example, the `graphiql` changelog is located at [packages/graphiql/CHANGELOG.md](./packages/graphiql/CHANGELOG.md), and the language server changelog is located at [packages/graphql-language-service-server/CHANGELOG.md](./packages/graphql-language-service-server/CHANGELOG.md)\n\n## GraphiQL 0.14.2 - 11 Aug, 2019\n\n### Fixes\n\n- Fix SSR & use of window when introducing new `extraKeys` capability (#942)\n\n## GraphiQL 0.14.0 - 11 Aug, 2019\n\n### Features\n\n- Add defaultVariableEditorOpen prop (#744) - @acao\n\n### Fixes\n\n- Fix formatting of subscription errors - #636, #722 - @benjie\n- preserve ctrl-f key for macOS - #759 - @pd4d10\n- Fix earlier 'Mode graphql failed to advance stream' on Linux by eating an exotic whitespace character - #735 closed by #932 - @benjie\n- Fix: check `this.editor` exists before `this.editor.off` in QueryEditor\n\n## Codemirror GraphQL - 0.9 - 11 Aug, 2019\n\n### Chores\n\n- BREAKING: Update to gls-interface and gls-parser ^2.1\n- BREAKING: Deprecate support for GraphQL 0.11 and below\n- BREAKING: introduce MIT license\n- BREAKING: Support GraphQL 14\n\n## GraphQL Language Service Server 2.1.0 - 11 Aug, 2019\n\n### Features\n\n- Replace babylon with @babel/parser (#879) @ganemone\n- Add support for gql template tags (#883) @ganemone @Neitsch\n\n### Chores\n\n- BREAKING: remove incompatible dependencies on graphql 0.11 and below\n- BREAKING: add peer support for graphql 14.x\n- BREAKING: change copyright to MIT\n- update formatting for monorepo eslint/prettier rules\n- update readme, badges\n\n## GraphQL Language Service Parser 2.1.0 - 11 Aug, 2019\n\n### Fixes\n\n- Fix 'mode graphql failed to advance stream' error from shift-alt-space, etc - #932 - @benjie\n\n## GraphQL Language Service Interface 2.1.0 - 11 Aug, 2019\n\n### Features\n\n- add \\_\\_typename field suggestion against object type - (#903) @yoshiakis\n- Update sortText logic, so that field sort is schema driven rather than alphabetically sorted - (#884) @ganemone\n\n### Chores\n\n- BREAKING: add peer support for graphql 14.x\n- MINOR BREAKING: Use MIT license\n- add test case for language service hover - @divyenduz @AGS-\n\n## GraphQL Language Service 2.1.0\n\n- BREAKING: add peer support for graphql 14.x\n- BREAKING: remove incompatible dependencies on graphql 0.11 and below (b/c of gls-utils 2.x)\n\n## GraphQL Language Service Utils 2.1.0 - 11 Aug, 2019\n\n### Chores\n\n- BREAKING: change copyright to MIT\n- update formatting for monorepo eslint/prettier rules\n- update readme, badges\n\n## GraphQL Language Service Types 1.3.0 - 11 Aug, 2019\n\n### Chores\n\n- BREAKING: change copyright to MIT\n- BREAKING: add peer support for graphql 14.x\n- update formatting for monorepo eslint/prettier rules\n- update readme, badges\n\n## GraphiQL 0.13.2 - 21 June, 2019\n\n### Features\n\n- Hint/popup/etc DOM nodes use container rather than creating children of\n <body> - #791 - @codestryke\n- Add readOnly prop and pass to `QueryEditor` and `VariableEditor` - #718 - @TheSharpieOne\n- Add operationName to introspection query - #664 - @jbblanchet\n- Image Preview Functionality - #789 - @dunnbobcat @asiandrummer\n\n### Fixes\n\n- Destroy image hover tooltip when it isn't needed - #874 - @acao\n- Copy non-formatted query to avoid stripping out comments - #832 - @jaebradley\n- Normalizes no-break spaces - #781 - @zouxuoz\n- Prevents crashing on Shift-Alt-Space - #781 - @zouxuoz\n- Fix UI state change after favorite a query - #747 - @benjie\n\n### Chores\n\n- BREAKING: Upgrade to `codemirror-graphql` 0.8.3 - #773 - @jonaskello\n- BREAKING: Change copyright to GraphQL Contributors, License to MIT\n- Netlify deployments per PR - @orta\n- Add unit test coverage\n- Switch to Jest\n\n## Codemirror Graphql Mode 0.8.4 - 11 Aug, 2018\n\nYou will now be importing async methods from gls-interface 2.0.0, thus your bundler will require regenerator runtime\n\n## Chores\n\n- BREAKING - Use GLS interface/parser 2.1.0 for graphql 14\n- BREAKING - This introduces async/await\n\n## GraphQL Language Service Interface 2.0.0 - 11 Sep, 2018\n\n### Chores\n\n- BREAKING: upgrade internal dependencies - gls-parser, gls-types, and gls-utils to 2.0.0 - @lostplan\n- BREAKING: remove incompatible dependencies on graphql 0.11 and below - @lostplan\n\n## GraphQL Language Service Utils 2.0.0 - 11 Sep, 2018\n\n### Chores\n\n- BREAKING: deprecate support for graphql-js 0.11.x and below - @lostplan [graphql/graphql-language-service#256](https://github.com/graphql/graphql-language-service/pull/256) [new ref](https://github.com/graphql/graphiql/commit/895e68537fd802b8b6ddf2578a1f76f85982c773) because of [this change](https://github.com/graphql/graphiql/commit/068c57fdb4a147be3c2fc38167e2def74d217a82#diff-696ceb17e38e4a274d4a149d24513b78)\n- BREAKING: GraphQL 14.x support, peer dependency resolutions - #244 - @AGS-\n\n## GraphQL Language Service Utils 1.2.2 - 11 Sep, 2018\n\n### Chores\n\n- add graphql-js 0.13 to peer deps of types package (graphql/graphql-language-service#241)\n\n## GraphQL Language Service Server 2.0.0 - 11 Sep, 2019\n\n### Chores\n\n- add graphql-js 0.13 to peer dependencies (graphql/graphql-language-service#241)\n- BREAKING: upgrade internal dependencies - gls-interface, gls-server and gls-utils to 2.0.0 @lostplan\n\n## GraphQL Language Service 2.0.0 - 11 Sep, 2018\n\n### Chores\n\n- BREAKING: upgrade internal dependencies - gls-interface, gls-server and gls-utils to 2.0.0 @Sol\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Contributing\n\nWe welcome contributions and assistance! If you want to know where to start,\ncheck out our\n[Github Projects sorted by name](https://github.com/graphql/graphiql/projects?query=is%3Aopen+sort%3Aname-asc).\n\nIf you want to add a new feature, note that GraphiQL is eventually going to\nsupport its own extension system, and we are rarely adding new features, so make\nsure you submit feature requests with that in mind.\n\n## Development\n\nTo get setup for development, refer to [DEVELOPMENT.md](./DEVELOPMENT.md)\n\n## Issues\n\nWe use GitHub issues to track public bugs and requests. Please ensure your bug\ndescription is clear and has sufficient instructions to be able to reproduce the\nissue. The best way is to provide a reduced test case on jsFiddle or jsBin.\n\n## Pull Requests\n\nAll active development of this project happens on GitHub. We actively welcome\nyour [pull requests](https://help.github.com/articles/creating-a-pull-request).\n\n### Type Prefixes\n\n[a list of type prefixes](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)\nis available:\n\n```json\n[\n \"build\",\n \"ci\",\n \"chore\",\n \"docs\",\n \"feat\",\n \"fix\",\n \"perf\",\n \"refactor\",\n \"revert\",\n \"style\",\n \"test\"\n]\n```\n\nof these, `fix` and `feat` can trigger patch and minor version releases,\nreflexively. the rest are useful to help track activity.\n\nanother commit message that can trigger a major version bump is this:\n\n```\nfeat: introduce new `fooBar()` API, break `foo()` api\n\n- list changes\n\nBREAKING CHANGE: break `foo()` api\n```\n\nnotice the non breaking spaces between header and footer.\n\n## Releasing\n\nPlease see [the RELEASING.md document](./RELEASING.md).\n\n## License\n\nBy contributing to GraphiQL, you agree that your contributions will be licensed\nunder the LICENSE file in the project root directory.\n"
},
{
"path": "DEVELOPMENT.md",
"content": "# Getting Started\n\nPlease note that we require a signed GraphQL Specification Membership agreement\nbefore landing a contribution. This is checked automatically when you open a PR.\nIf you have not signed the membership agreement (it's free), you will be\nprompted by the EasyCLA bot. For more details, please see the\n[GraphQL WG repo](https://github.com/graphql/graphql-wg/tree/main/membership).\n\n0. First, you will need the latest `git`, `yarn` 4, & `node` 18 or greater.\n macOS, Windows and Linux should all be supported as build environments.\n\n> [!WARNING]\n>\n> None of the commands below will work with `npm`. Please use `yarn` in this repo.\n\n1. Fork this repo by using the \"Fork\" button in the upper-right\n\n2. Check out your fork\n\n ```sh\n git clone git@github.com:your-name-here/graphiql.git\n ```\n\n3. Install or Update all dependencies\n\n ```sh\n yarn\n ```\n\n4. Build all interdependencies so the project you are working on can resolve\n other packages\n\n First, you'll need:\n\n ```sh\n yarn build\n ```\n\n or\n\n ```sh\n yarn build:watch\n ```\n\n If you are focused on GraphiQL development, you can run:\n\n ```sh\n yarn dev:graphiql\n ```\n\n5. Get coding! If you've added code, add tests. If you've changed APIs, update\n any relevant documentation or tests. Ensure your work is committed within a\n feature branch.\n\n6. Ensure all tests pass and build everything\n\n ```sh\n yarn test\n ```\n\n## Fix CI issues with linting\n\nIf you have `prettier` or `eslint --fix`-able issues you see in CI, use —\n\n`yarn format`\n\nIf you see `typescript` build issues, do a `yarn build` locally, and make sure\nthe whole project references tree builds. Changing interfaces can end up\nbreaking their implementations.\n\n## Run tests for GraphiQL:\n\n- `yarn test graphiql` will run all tests for graphiql. You can also run tests\n from a workspace, but most tooling is at the root.\n- `yarn test --watch` will run `jest` with `--watch`\n- `yarn e2e` at the root will run the end-to-end suite\n- `yarn start-monaco` will launch `webpack` dev server for the `monaco` editor\n example with GitHub API from the root. This is the fastest way to test changes\n to `graphql-language-service-interface`, parser, etc.\n\nIf you want these commands to watch for changes to dependent packages in the\nrepo, then run `yarn build --watch` alongside either of these.\n\n## Developing for GraphiQL\n\nIf you want to develop just for graphiql, you won't need to execute commands\nfrom the package subdirectory at `packages/graphiql`.\n\nFirst, you'll need to `yarn build` all the packages from the root.\n\nThen, you can run `yarn dev:graphiql` command, which will launch `vite` dev server for GraphiQL.\n\n```text\nVITE v6.3.4 ready in 1015 ms\n\n➜ Local: http://localhost:5173/\n➜ Network: use --host to expose\n```\n\n## Developing Monaco GraphQL\n\n1. First run `yarn`.\n2. Run `yarn tsc --watch` to watch `monaco-graphql` and\n `graphql-language-service` in one screen session/terminal tab/etc\n3. In another session, run `yarn start-monaco` from anywhere in the repository\n aside from an individual workspace.\n4. Alternatively to the webpack example, or in addition, you can run monaco or\n next.js examples, though these examples are simpler. They also require their\n own `yarn` or `npm install` as they are excluded from the `workspaces`\n resolved on global `yarn install`\n"
},
{
"path": "LICENSE",
"content": "MIT License\n\nCopyright (c) GraphQL Contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "README.md",
"content": "<!-- @format -->\n\n# GraphQL IDE Monorepo\n\n> **Security Notice:** All versions of `graphiql` < `1.4.7` are vulnerable to an\n> XSS attack in cases where the GraphQL server to which the GraphiQL web app\n> connects is not trusted. Learn more\n> [in the graphiql `security` docs directory](docs/security)\n\n> **Looking for the [GraphiQL Docs?](packages/graphiql/README.md)**: This is the\n> root of the monorepo! The full GraphiQL docs are located at\n> [`packages/graphiql`](packages/graphiql)\n\n[](https://github.com/graphql/graphiql/actions?query=workflow%3A%22Node.JS+CI%22)\n[](https://discord.gg/NP5vbPeUFp)\n[](https://codecov.io/gh/graphql/graphiql)\n\n\n[](https://snyk.io/test/github/graphql/graphiql)\n[](https://bestpractices.coreinfrastructure.org/projects/3887)\n\n## Overview\n\nGraphiQL is the reference implementation of this monorepo, GraphQL IDE, an\nofficial project under the GraphQL Foundation. The code uses the permissive MIT\nlicense.\n\nWhether you want a simple GraphiQL IDE instance for your server, or a more\nadvanced web or desktop GraphQL IDE experience for your framework or plugin, or\nyou want to build an IDE extension or plugin, you've come to the right place!\n\nThe purpose of this monorepo is to give the GraphQL Community:\n\n- a to-specification official language service (see:\n [API Docs](https://graphiql-test.netlify.app/typedoc))\n- a comprehensive LSP server and CLI service for use with IDEs\n- a codemirror mode\n- a monaco mode (in the works)\n- an example of how to use this ecosystem with GraphiQL.\n- examples of how to implement or extend GraphiQL.\n\n## [`graphiql`](packages/graphiql#readme)\n\n<!-- prettier-ignore -->\n> [](https://npmjs.com/graphiql)\n> \n> \n> \n> \n> \n\n\n\n_/ˈɡrafək(ə)l/_ A graphical interactive in-browser GraphQL IDE.\n[Try the live demo](https://graphql.org/swapi-graphql). We also have\n[a demo using our latest netlify build](http://graphiql-test.netlify.app) for\nthe `main` branch.\n\nThe GraphiQL IDE, implemented in React, currently using\n[GraphQL mode for CodeMirror](packages/codemirror-graphql#readme) &\n[GraphQL Language Service](packages/graphql-language-service#readme).\n\n**Learn more about\n[GraphiQL in `packages/graphiql/README.md`](packages/graphiql#readme)**\n\n## [`monaco-graphql`](packages/monaco-graphql#readme)\n\n[](https://npmjs.com/monaco-graphql)\n\n\n\n\nProvides monaco editor with a powerful, schema-driven graphql language mode.\nUses the `graphql-language-service`directly.\n\nSee the [webpack example](examples/monaco-graphql-webpack#readme) for a plain\njavascript demo using GitHub API\n\n## [`codemirror-graphql`](packages/codemirror-graphql#readme)\n\n[](https://npmjs.com/codemirror-graphql)\n\n\n\n\n\n\nProvides CodeMirror 5 with a parser mode for GraphQL along with a live linter and\ntypeahead hinter powered by your GraphQL Schema. Uses the\n`graphql-language-service`.\n\n## [`cm6-graphql`](packages/cm6-graphql#readme)\n\n[](https://npmjs.com/cm6-graphql)\n\n\n\n\nProvides CodeMirror 6 with a full-featured language mode for GraphQL. Uses the `graphql-language-service`.\n\n## [`graphql-language-service`](packages/graphql-language-service#readme)\n\n[](https://npmjs.com/graphql-language-service)\n\n\n\nProvides language services for\n[`graphql-language-service-server`](packages/graphql-language-service-server#readme)\n[`codemirror-graphql`](packages/codemirror-graphql) and\n[`monaco-graphql`](packages/monaco-graphql). Previously published separately as\nthe now-retired `graphql-language-service-interface`,\n`graphql-language-service-parser`, `graphql-language-service-utils` and\n`graphql-language-service-types`.\n\n## [`graphql-language-service-server`](packages/graphql-language-service-server#readme)\n\n[](https://npmjs.com/graphql-language-service-server)\n\n\n\nProvides language services for LSP-based IDE extensions using the\n`graphql-language-service`\n\n## [`graphql.vscode-graphql`](packages/vscode-graphql#readme)\n\nAn example implementation of `graphql-language-service-server` for Visual Studio\nCode. Available\n[on the marketplace](https://marketplace.visualstudio.com/items?itemName=GraphQL.vscode-graphql).\nOVSX fix is pending.\n\n## [`graphql.vscode-graphql-syntax`](packages/vscode-graphql-syntax#readme)\n\nA new syntax highlighting-only extension for vscode to be used by other vscode\nextensions.\n\n## [`graphql.vscode-graphql-execution`](packages/vscode-graphql-execution#readme)\n\nAn extension for vscode-graphql that allows inline query execution.\n\n## [`graphql-language-service-cli`](packages/graphql-language-service-cli#readme)\n\n[](https://npmjs.com/graphql-language-service-cli)\n\n\n\nProvides a CLI for the language service server.\n\n## Browser & Runtime Support\n\nMany of these packages need to work in multiple environments.\n\nBy default, all typescript packages target `es6`.\n\n`graphql-language-service-server` and `graphql-language-service-cli` are made\nfor the node runtime, so they target `es2017`\n\n`codemirror-graphql` and the `graphiql` browser bundle use the\n[`.browserslistrc`](./.browserslistrc), which targets modern browsers to keep\nbundle size small and keep the language services performant where async/await is\nused, and especially to avoid the requirement of `regenerator-runtime` or\nspecial babel configuration.\n\n### [`.browserslistrc`](./.browserslistrc):\n\n```\nlast 2 versions\nFirefox ESR\nnot dead\nnot IE 11\nnot ios 10\nmaintained node versions\n```\n\nTo be clear, we do _not_ support Internet Explorer or older versions of\nevergreen browsers.\n\n## Development\n\nTo get setup for local development of this monorepo, refer to\n[DEVELOPMENT.md](./DEVELOPMENT.md)\n\n# Contributing to this repo\n\nThis is an open source project, and we welcome contributions. Please see\n[CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute.\n\nThis repository is managed by EasyCLA. Project participants must sign the free\n[GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org)\nbefore making a contribution. You only need to do this one time, and it can be\nsigned by\n[individual contributors](http://individual-spec-membership.graphql.org) or\ntheir [employers](http://corporate-spec-membership.graphql.org).\n\nTo initiate the signature process please open a PR against this repo. The\nEasyCLA bot will block the merge if we still need a membership agreement from\nyou.\n\nPlease note that EasyCLA is configured to accept commits from certain GitHub\nbots. These are approved on an exception basis once we are confident that any\ncontent they create is either unlikely to consist of copyrightable content or\nelse was written by someone who has already signed the CLA (e.g., a project\nmaintainer). The bots that have currently been approved as exceptions are:\n\n- github-actions (exclusively for the `changesets` Action)\n\nYou can find\n[detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership).\nIf you have issues, please email\n[operations@graphql.org](mailto:operations@graphql.org).\n\n## Maintainers\n\nMaintainers of this repository regularly review PRs and issues and help advance\nthe GraphiQL roadmap\n\n### Alumni\n\nWithout these amazing past maintainers, where would we be?!\n\n- [@leebyron](https://github.com/leebyron) - original author of all libraries\n- [@asiandrummer](https://github.com/asiandrummer) - original creator of\n GraphiQL\n- [@wincent](https://github.com/wincent) - early co-author and maintainer\n- [@lostplan](https://github.com/lostplan) - maintained the language service\n ecosystem until about 2017\n- [@IvanGoncharov](https://github.com/ivangoncharov) - maintainer and\n transitional mentor to @acao and others\n- [@orta](https://github.com/orta) - has helped with so many parts of the\n project over the years, and provided the original redesign!\n- [@divyenduz](https://github.com/divyenduz) - the original creator of\n `vscode-graphql`, and contributor to much of the ecosystem. Thanks Divy!\n\n### Active\n\nMaintainers who are currently active (to varying degrees, please contact us via\nour discord channels!):\n\n- [@imolorhe](https://github.com/imolorhe)\n- [@yoshiakis](https://github.com/yoshiakis)\n- [@urigo](https://github.com/urigo)\n- [@timsuchanek](https://github.com/timsuchanek)\n- [@thomasheyenbrock](https://github.com/thomasheyenbrock)\n- [@n1ru4l](https://github.com/n1ru4l)\n- [@acao](https://github.com/acao)\n- [@stonexer](https://github.com/stonexer)\n- [@dimaMachina](https://github.com/dimaMachina)\n- [@dotansimha](https://github.com/dotansimha)\n- [@saihaj](https://github.com/saihaj)\n- [@jonathanawesome](https://github.com/jonathanawesome)\n- [@cshaver](https://github.com/cshaver)\n\n> Thank you graphql community for all the help & support! I did it all for you,\n> and I couldn't have done it without you ❤️ - @acao\n\n### Fielding Proposals!\n\nThe door is open for proposals for the new GraphiQL Plugin API, and other ideas\non how to make the rest of the IDE ecosystem more performant, scalable,\ninteroperable and extensible. Feel free to open a PR to create a document in the\n`/proposals/` directory. Eventually we hope to move these to a repo that serves\nthis purpose.\n\n## Community\n\n- **Discord**\n [](https://discord.gg/NP5vbPeUFp) -\n Most discussion outside of GitHub happens on the GraphQL\n [Discord Server](https://discord.gg/NP5vbPeUFp)\n- **Twitter** - [@GraphiQL](https://twitter.com/@GraphiQL) and\n [#GraphiQL](https://twitter.com/hashtag/GraphiQL)\n- **GitHub** - Create feature requests, discussions issues and bugs above\n- **Working Group** - Yes, you're invited! Monthly planning/decision making\n meetings, and working sessions every two weeks on zoom!\n [Learn more.](working-group#readme)\n"
},
{
"path": "RELEASING.md",
"content": "# Cutting New Releases\n\nTODO: Redo for `changesets`. See [`Changesets Readme`](./.changeset/README.md)\n"
},
{
"path": "SECURITY.md",
"content": "# GraphiQL Ecosystem Security Advisories\n\nSecurity Advisories for packages in this repository will be listed here\n\n## GraphiQL\n\n### 2021\n\n- [Introspection Schema XSS Attack](./docs/security/2021-introspection-schema-xss.md)\n"
},
{
"path": "babel.config.js",
"content": "// for ESM don't transpile modules\n\nconst envConfig = {\n modules: 'commonjs',\n};\n\nif (process.env.ESM) {\n envConfig.modules = false;\n envConfig.targets = { node: 'current' };\n envConfig.bugfixes = true;\n}\n\nif (process.env.CDN) {\n envConfig.modules = 'umd';\n envConfig.targets = null;\n}\n\nmodule.exports = {\n presets: [\n [require.resolve('@babel/preset-env'), envConfig],\n require.resolve('@babel/preset-react'),\n require.resolve('@babel/preset-typescript'),\n ],\n env: {\n test: {\n presets: [\n [require.resolve('@babel/preset-env'), envConfig],\n [require.resolve('@babel/preset-react'), { runtime: 'automatic' }],\n require.resolve('@babel/preset-typescript'),\n ],\n plugins: [require.resolve('babel-plugin-macros')],\n },\n development: {\n compact: false,\n },\n },\n plugins: [\n require.resolve('@babel/plugin-proposal-class-properties'),\n\n require.resolve('@babel/plugin-proposal-nullish-coalescing-operator'),\n require.resolve('@babel/plugin-proposal-optional-chaining'),\n require.resolve('@babel/plugin-transform-private-methods'),\n ['babel-plugin-transform-import-meta', { module: 'ES6' }],\n ],\n};\n"
},
{
"path": "cspell.json",
"content": "{\n \"$schema\": \"https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json\",\n \"language\": \"en\",\n \"useGitignore\": true,\n \"cache\": {\n \"useCache\": true\n },\n \"dictionaries\": [\"custom-words\"],\n \"dictionaryDefinitions\": [\n {\n \"name\": \"custom-words\",\n \"path\": \"./resources/custom-words.txt\",\n \"addWords\": true\n }\n ],\n \"ignorePaths\": [\n \"**/CHANGELOG.md\",\n \"**/package.json\",\n \"**/esbuild.js\",\n \".eslintrc.js\",\n \".vscode/extensions.json\",\n \"packages/monaco-graphql/test/monaco-editor.test.ts\",\n \"working-group\"\n ],\n \"files\": [\"**/*.{js,cjs,mjs,ts,jsx,tsx,md,mdx,html,json,css,toml,yaml,yml}\"]\n}\n"
},
{
"path": "docs/migration/graphiql-2.0.0.md",
"content": "# Upgrading `graphiql` from `1.x` to `2.0.0`\n\nHello GraphiQL user and thanks for upgrading!\n\nThis migration guide walks you through all changes that come with\n`graphiql@2.0.0`, in particular the breaking ones, and will show you how to\nupgrade your `1.x` implementation.\n\n> If you encounter any issues while upgrading that are not covered in here,\n> please open an issue or PR on this repo and we will extend this guide.\n\n## Design refresh including dark theme\n\nArguably the biggest change in `graphiql@2` is the new design of the UI. It has\nbeen reworked from scratch to look more modern while keeping its simplistic look\nand feel. We also finally added a built-in dark theme. Theme selection is based\non system defaults and can be changed in the new settings dialog (available by\nclicking on the gear icon at the bottom of the sidebar on the left of the\nscreen).\n\nStarting with `graphiql@2`, the only officially supported way of customizing the\nCSS that make up the looks of GraphiQL is by overriding the design tokens\ndefined using CSS variables. In particular, changes to class names are no longer\nconsidered breaking changes. If you use class-name based selectors to change\nstyles your overrides might break with minor or patch version bumps.\n\nA list of all CSS variables that can be customized can be found in the\n[`root.css`](../../packages/graphiql-react/src/style/root.css) file of the\n`@graphiql/react` package. The variables for colors use a list of values that\ncan be passed into the\n[`hsl`](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl)\nfunction in CSS that defines colors by hue, saturation and lightness.\n\n## Changes to `GraphiQL` component props\n\nA couple of props of the `GraphiQL` have undergone breaking changes:\n\n- The props `defaultVariableEditorOpen` and `defaultSecondaryEditorOpen` have\n been merged into one prop `defaultEditorToolsVisibility`. The default behavior\n if this prop is not passed is that the editor tools are shown if at least one\n of the secondary editors has contents. You can pass the following values to\n the prop:\n - Passing `false` hides the editor tools.\n - Passing `true` shows the editor tools.\n - Passing `\"variables\"` explicitly shows the variables editor.\n - Passing `\"headers\"` explicitly shows the headers editor.\n- The props `docExplorerOpen`, `onToggleDocs` and `onToggleHistory` have been\n removed. They are replaced by the more generic props `visiblePlugin` (for\n controlling which plugin is visible) and `onTogglePluginVisibility` (which is\n called each time the visibility of any plugin changes).\n- The `headerEditorEnabled` prop has been renamed to `isHeadersEditorEnabled`.\n- The `ResultsTooltip` prop has been renamed to `responseTooltip`.\n\n### Tabs enabled by default\n\nTabs were supported opt-in starting with `@graphiql@1.8`. With `graphiql@2` tabs\nare now always enabled. The `tabs` prop (which previously toggled if tabs were\nenabled or not) has therefore been replaced with a prop `onTabChange`. If you\nused the `tabs` prop before to pass this function you can change your\nimplementation like so:\n\n```diff\n<GraphiQL\n- tabs={{ onTabChange: (tabState) => {/* do something */} }}\n+ onTabChange={(tabState) => {/* do something */}}\n/>\n```\n\nAs long as only one session is open, the tab bar above the editors is hidden. A\nplus icon next to the logo on the top right allows the user to open more tabs.\nWith at least two tabs opened, the tab bar appears above the editors.\n\n## Removed package exports\n\nAll React components apart from the `GraphiQL` component have been moved to the\n`@graphiql/react` package. That's why we removed most of the exports with\n`graphiql@2`. Here is a list of all exported components and functions that have\nbeen removed and where you can find them now:\n\n- `QueryEditor`, `VariableEditor` and `DocExplorer`: Now exported from\n `@graphiql/react` under the same names\n - Note that the `schema` prop of the `DocExplorer` no longer exists, the\n component now uses the schema provided by the `ExplorerContext`.\n- `ToolbarMenu`: Now exported from `@graphiql/react` as `ToolbarMenu`\n- `ToolbarMenuItem`: Now exported from `@graphiql/react` as `ToolbarMenu.Item`\n- `ToolbarSelect`: Now exported from `@graphiql/react` as `ToolbarListbox`\n- `ToolbarSelectOption`: Now exported from `@graphiql/react` as\n `ToolbarListbox.Option`\n- `onHasCompletion`: This function is only meant to be used internally, it is no\n longer being exported\n- `fillLeafs`, `getSelectedOperationName` and `mergeAst`: Now exported from\n `@graphiql/toolkit` under the same names\n- types `Fetcher`, `FetcherOpts`, `FetcherParams`, `FetcherResult`,\n `FetcherReturnType`, `Observable`, `Storage` and `SyncFetcherResult`: Exported\n from `@graphiql/toolkit` under the same names (previously just re-exported by\n `graphiql`)\n\n## `GraphiQL` is now a function component\n\nThe `GraphiQL` component in `graphiql@1.x` was a class component. That allowed\neasy access to its props, state and methods by attaching a ref to it like so:\n\n```tsx\nimport { createGraphiQLFetcher } from '@graphiql/toolkit';\nimport { GraphiQL } from 'graphiql';\nimport { Component } from 'react';\n\nconst fetcher = createGraphiQLFetcher({ url: 'https://my.endpoint' });\n\nclass MyComponent extends Component {\n _graphiql: GraphiQL;\n\n componentDidMount() {\n const query = this._graphiql.getQueryEditor().getValue();\n }\n\n render() {\n return <GraphiQL ref={r => (this._graphiql = r)} fetcher={fetcher} />;\n }\n}\n```\n\nWith `graphiql@2` we refactored the codebase to more \"modern\" React. This also\nmeant replacing all class components with function components. The code above no\nlonger works in `graphiql@2` as attaching refs to function components is not\npossible in React.\n\nAll logic and state management now lives in multiple React contexts, provided by\nthe `@graphiql/react` package. The `GraphiQL` component is now basically\ncombining two other components, both of which are also exported by the package.\n\n- `GraphiQLProvider` (originally coming from `@graphiql/react`) will render all\n context providers and takes care of state management\n- `GraphiQLInterface` is defined in the `graphiql` package and renders the UI\n\nIf you want to read or modify GraphiQL state from your custom implementation you\nneed to render both the above components separately as the hooks for consuming\nthe context values only work in components that are rendered inside the provider\ncomponent.\n\nWith all that, the example above can be refactored a such:\n\n```jsx\nimport { useEditorContext } from '@graphiql/react';\nimport { createGraphiQLFetcher } from '@graphiql/toolkit';\nimport { GraphiQLInterface, GraphiQLProvider } from 'graphiql';\nimport { useEffect } from 'react';\n\nconst fetcher = createGraphiQLFetcher({ url: 'https://my.endpoint' });\n\nfunction MyComponent() {\n return (\n <GraphiQLProvider fetcher={fetcher}>\n <InsideContext />\n </GraphiQLProvider>\n );\n}\n\nfunction InsideContext() {\n // Calling this hook would not work in `MyComponent` (it would return `null`)\n const { queryEditor } = useEditorContext();\n\n useEffect(() => {\n const query = queryEditor.getValue();\n }, [queryEditor]);\n\n return <GraphiQLInterface />;\n}\n```\n\nHere is a list of all public class methods that existed in `graphiql@1` and its\nreplacement in `graphiql@2`. All the contexts mentioned below can be accessed\nusing a hook exported by `@graphiql/react`.\n\n- `getQueryEditor`: Use the `queryEditor` property from the `EditorContext`.\n- `getVariableEditor`: Use the `variableEditor` property from the\n `EditorContext`.\n- `getHeaderEditor`: Use the `headerEditor` property from the `EditorContext`.\n- `refresh`: Calling this method should no longer be necessary, all editors will\n refresh automatically after resizing. If you really need to refresh manually\n you have to call the `refresh` method on all editor instances individually.\n- `autoCompleteLeafs`: Use the `useAutoCompleteLeafs` hook provided by\n `@graphiql/react` that returns this function.\n\nThere are a couple more class methods that were intended to be private and were\nalready removed starting in `graphiql@1.9.0`. Since they were not actually\nmarked with `private`, here's an extension to the above list for these methods:\n\n- `handleClickReference`: This was a callback method triggered when clicking on\n a type or field. It would open the doc explorer for the clicked reference. If\n you want to manually mimic this behavior you can use the `push` method from\n the `ExplorerContext` to add an item to the navigation stack of the doc\n explorer, and you can use the `setVisiblePlugin` method of the `PluginContext`\n (use the `usePluginContext()` hook to access this) to show the doc explorer\n plugin (by passing the `DOC_EXPLORER_PLUGIN` object provided by\n `@graphiql/react`).\n- `handleRunQuery`: To execute a query, use the `run` method of the\n `ExecutionContext`. If you want to explicitly set an operation name, call the\n `setOperationName` method of the `EditorContext` provider before that (passing\n in the operation name string as argument).\n- `handleEditorRunQuery`: Use the `run` method of the `ExecutionContext`.\n- `handleStopQuery`: Use the `stop` method from the `ExecutionContext`.\n- `handlePrettifyQuery`: Use the `usePrettifyEditors` hook provided by\n `@graphiql/react` that returns this function.\n- `handleMergeQuery`: Use the `useMergeQuery` hook provided by `@graphiql/react`\n that returns this function.\n- `handleCopyQuery`: Use the `useCopyQuery` hook provided by `@graphiql/react`\n that returns this function.\n- `handleToggleDocs` and `handleToggleHistory`: Use the `setVisiblePlugin`\n method of the `PluginContext`.\n\nSome class methods were callbacks to modify state which are not intended to be\ncalled manually. All these methods don't have a successor: `handleEditQuery`,\n`handleEditVariables`, `handleEditHeaders`, `handleEditOperationName`,\n`handleSelectHistoryQuery`, `handleResetResize` and\n`handleHintInformationRender`\n\n### Static properties have been removed\n\nIn `graphiql@1.x` the `GraphiQL` component included a bunch of static properties\nthat exposed utility functions and other components. Most of these have been\nremoved in `graphiql@2` since the components and functions have been moved to\nthe `@graphiql/react` and `@graphiql/toolkit` packages.\n\nThe properties that remain on the `GraphiQL` function component are\n`GraphiQL.Logo`, `GraphiQL.Toolbar` and `GraphiQL.Footer`. All three are React\ncomponents that can be passed as children to the `GraphiQL` components and\noverride certain parts of the UI:\n\n- `GraphiQL.Logo`: Overrides the \"logo\" at the top right of the screen. By\n default, it contains the text \"Graph*i*QL\".\n- `GraphiQL.Toolbar`: Overrides the toolbar next to the operation editor. By\n default, if contains buttons for prettifying the current editor contents,\n merging fragment definitions into the operation definition and copying the\n contents of the operation editor to the clipboard. Note that the default buttons\n will not be shown when passing this component as child to `GraphiQL`, instead\n it will show the children you pass to `GraphiQL.Toolbar`. The execute button\n will always be shown. If you want to keep the default buttons and add\n additional buttons you can use the `toolbar` prop.\n- `GraphiQL.Footer`: Adds a section below the response editor. By default, this\n won't show up in the UI.\n\nHere is a list of all the static properties that have been removed and their\nreplacements:\n\n- `GraphiQL.formatResult` and `GraphiQL.formatError`: Replaced by equally named\n functions from `@graphiql/toolkit`\n- `GraphiQL.QueryEditor`, `GraphiQL.VariableEditor` and `GraphiQL.HeaderEditor`:\n Replaced by equally named components from `@graphiql/react`\n- `GraphiQL.ResultViewer`: Replaced by the `ResponseEditor` component from\n `@graphiql/react`\n- `GraphiQL.Button`: Replaced by the `ToolbarButton` component from\n `@graphiql/react`\n- `GraphiQL.ToolbarButton`: This exposed the same component as\n `GraphiQL.Button`.\n- `GraphiQL.Menu`: Replaced by the `ToolbarMenu` component from\n `@graphiql/react`\n- `GraphiQL.MenuItem`: Replaced by the `ToolbarMenu.Item` component from\n `@graphiql/react`\n- `GraphiQL.Group`: Grouping multiple buttons side-by-side is not provided\n out-of-the box anymore in the new GraphiQL UI. If you want to implement a\n similar feature in the new vertical toolbar you can do so by adding your own\n styles for your custom toolbar elements. Example:\n\n ```jsx\n import { createGraphiQLFetcher } from '@graphiql/toolkit';\n import { GraphiQL } from 'graphiql';\n\n const fetcher = createGraphiQLFetcher({ url: 'https://my.endpoint' });\n\n function MyComponent() {\n return (\n <GraphiQL fetcher={fetcher}>\n <GraphiQL.Toolbar>\n {/* Add custom styles for your buttons using the given class */}\n <div className=\"button-group\">\n <button>1</button>\n <button>2</button>\n <button>3</button>\n </div>\n </GraphiQL.Toolbar>\n </GraphiQL>\n );\n }\n ```\n\n### `window.g` has been removed\n\nIn `graphiql@1.x` the `GraphiQL` class component stored a reference to itself on\na global property named `g`. This property has been removed as refs don't exist\nfor function components. (Also, the property was only intended for internal use\nlike testing in the first place.)\n"
},
{
"path": "docs/migration/graphiql-4.0.0.md",
"content": "# Upgrading `graphiql` from `3.x` to `4.0.0`\n\n---\n\n## `graphiql`\n\n- Dropped support for **React 16/17**, added support for **React 19**\n- Dropped **CommonJS** build output – now **ESM only**\n- Improved UI of tabs\n - Changed tabs behavior – tabs are always visible (even if only one)\n - Updated tabs tooltip usage – now use HTML `title` attribute\n- Removed **default export**\n- Removed `disableTabs` option\n- Improved Markdown handling – single newlines are ignored\n- Added `onPrettifyQuery` callback for custom formatting\n- ⚠️ Deprecate **UMD CDN build `index.umd.js`**\n- Changed **CDN paths** and **style import**\n\n> [!WARNING]\n>\n> ⚠️ **`index.umd.js` is deprecated**. Switch to the [ESM CDN example](../../examples/graphiql-cdn/index.html).\n\n### UMD CDN path changes\n\n```diff\n-https://unpkg.com/graphiql/graphiql.js\n-https://unpkg.com/graphiql/graphiql.min.js\n+https://unpkg.com/graphiql/dist/index.umd.js // ⚠️ deprecated\n\n-https://unpkg.com/graphiql/graphiql.css\n-https://unpkg.com/graphiql/graphiql.min.css\n+https://unpkg.com/graphiql/dist/style.css\n```\n\n### Default export removed\n\n```diff\n-import GraphiQL from 'graphiql'\n+import { GraphiQL } from 'graphiql'\n```\n\n### Style import changed\n\n```diff\n-import 'graphiql/graphiql.css'\n+import 'graphiql/style.css'\n```\n\n### Toolbar API migration\n\n#### `toolbar.additionalContent` → `<GraphiQL.Toolbar>`\n\n**Before:**\n\n```tsx\n<GraphiQL toolbar={{ additionalContent: <button>My button</button> }} />\n```\n\n**After:**\n\n```jsx\n<GraphiQL>\n <GraphiQL.Toolbar>\n {({ merge, prettify, copy }) => (\n <>\n {prettify}\n {merge}\n {copy}\n <button>My button</button>\n </>\n )}\n </GraphiQL.Toolbar>\n</GraphiQL>\n```\n\n---\n\n#### `toolbar.additionalComponent` → `<GraphiQL.Toolbar>`\n\n**Before:**\n\n```jsx\n<GraphiQL\n toolbar={{\n additionalComponent: function MyComponentWithAccessToContext() {\n return <button>My button</button>;\n },\n }}\n/>\n```\n\n**After:**\n\n```jsx\n<GraphiQL>\n <GraphiQL.Toolbar>\n {({ merge, prettify, copy }) => (\n <>\n {prettify}\n {merge}\n {copy}\n <MyComponentWithAccessToContext />\n </>\n )}\n </GraphiQL.Toolbar>\n</GraphiQL>\n```\n\n---\n\n#### Customizing default toolbar buttons\n\nYou can reorder or remove default toolbar buttons:\n\n```tsx\n<GraphiQL>\n <GraphiQL.Toolbar>\n {({ prettify, copy }) => (\n <>\n {copy} {/* Move copy button to the top */}\n {prettify} {/* Omit merge button */}\n </>\n )}\n </GraphiQL.Toolbar>\n</GraphiQL>\n```\n\n---\n\n## `@graphiql/react`\n\n- Dropped support for **React 16/17**, added support for **React 19**\n- Dropped **CommonJS** build output\n- Improved UI of tabs\n- Updated dependencies: `@radix-ui` and `@headlessui/react`\n- Added `onPrettifyQuery` callback for custom formatting\n- Improved Markdown handling (ignores single newlines)\n- Style import changed:\n ```diff\n -import '@graphiql/react/dist/style.css'\n +import '@graphiql/react/style.css'\n ```\n\n---\n\n## `@graphiql/plugin-code-exporter`\n\n- Dropped support for **React 16/17**, added support for **React 19**\n- Dropped **CommonJS** build output\n- Updated ESM-based CDN example:\n [code-exporter ESM CDN example](../../packages/graphiql-plugin-code-exporter/example/index.html)\n- ⚠️ UMD build deprecated – migrate to ESM-based CDN\n- Style import changed:\n ```diff\n -import '@graphiql/plugin-code-exporter/dist/style.css'\n +import '@graphiql/plugin-code-exporter/style.css'\n ```\n\n---\n\n## `@graphiql/plugin-explorer`\n\n- Dropped support for **React 16/17**, added support for **React 19**\n- Dropped **CommonJS** build output\n- Improved styles for the explorer UI\n- Updated ESM-based CDN example:\n [explorer ESM CDN example](../../examples/graphiql-cdn/index.html)\n- ⚠️ UMD build deprecated – migrate to ESM-based CDN\n- Style import changed:\n ```diff\n -import '@graphiql/plugin-explorer/dist/style.css'\n +import '@graphiql/plugin-explorer/style.css'\n ```\n"
},
{
"path": "docs/migration/graphiql-5.0.0.md",
"content": "# Upgrading `graphiql` from `4.x` to `5.0.0`\n\nStarting from GraphiQL 5, you need to set up Monaco workers in your project:\n\n- For **Vite** projects you must:\n\n 1. Install `vite-plugin-monaco-editor` package:\n\n ```sh\n npm install vite-plugin-monaco-editor --save-dev\n ```\n\n 2. Import and configure the plugin in your `vite.config.mjs` file:\n\n ```diff\n // vite.config.mjs\n import { defineConfig } from 'vite'\n import react from '@vitejs/plugin-react'\n +import $monacoEditorPlugin from 'vite-plugin-monaco-editor'\n\n +const monacoEditorPlugin = $monacoEditorPlugin.default ?? $monacoEditorPlugin\n\n export default defineConfig({\n plugins: [\n react(),\n + monacoEditorPlugin({\n + languageWorkers: ['editorWorkerService', 'json'],\n + customWorkers: [\n + {\n + label: 'graphql',\n + entry: 'monaco-graphql/esm/graphql.worker.js'\n + }\n + ]\n + })\n ]\n })\n ```\n\n> [!NOTE]\n>\n> See [Vite example](../../examples/graphiql-vite/src/App.jsx).\n\n- For Webpack projects such as **Next.js** you must import:\n\n ```js\n import 'graphiql/setup-workers/webpack';\n ```\n\n> [!NOTE]\n>\n> See [Next.js example](../../examples/graphiql-nextjs/src/app/page.tsx).\n\n- For ESM-based CDN usages, you must use\n [`?worker` query](https://esm.sh/#web-worker) to load the module as a web\n worker:\n\n ```js\n import createJSONWorker from 'https://esm.sh/monaco-editor/esm/vs/language/json/json.worker.js?worker';\n import createGraphQLWorker from 'https://esm.sh/monaco-graphql/esm/graphql.worker.js?worker';\n import createEditorWorker from 'https://esm.sh/monaco-editor/esm/vs/editor/editor.worker.js?worker';\n\n globalThis.MonacoEnvironment = {\n getWorker(_workerId, label) {\n switch (label) {\n case 'json':\n return createJSONWorker();\n case 'graphql':\n return createGraphQLWorker();\n }\n return createEditorWorker();\n },\n };\n ```\n\n> [!NOTE]\n>\n> See [CDN example](../../examples/graphiql-cdn/index.html).\n\n## Allow to Override All Default GraphiQL Plugins\n\nStarting from GraphiQL 5, you can override all default plugins.\n\n### Removing All Default Plugins\n\nTo remove all default plugins (currently **Doc Explorer** and **History**), set\n`referencePlugin={null}` and pass an empty array to the `plugins` prop:\n\n```jsx\nimport { GraphiQL } from 'graphiql';\n\nconst myPlugins = [];\n\nfunction App() {\n return (\n <GraphiQL\n referencePlugin={null} // Removes Doc Explorer plugin\n plugins={myPlugins} // Removes History plugin\n />\n );\n}\n```\n\n> [!NOTE]\n>\n> If you're using a custom Doc Explorer, pass it to the `referencePlugin` prop —\n> **not** the `plugins` array. It will be automatically included and always\n> rendered first.\n\n### Adding Plugins While Keeping Defaults\n\nIf you're adding custom plugins (e.g., the **Explorer** plugin) and want to keep\nthe **History** plugin, you must explicitly include it in the `plugins` array:\n\n```jsx\nimport { GraphiQL, HISTORY_PLUGIN } from 'graphiql';\nimport { explorerPlugin } from '@graphiql/plugin-explorer';\n\nconst myPlugins = [HISTORY_PLUGIN, explorerPlugin()];\n\nfunction App() {\n return <GraphiQL plugins={myPlugins} />;\n}\n```\n\n---\n\n## `graphiql`\n\n> [!WARNING]\n>\n> ⚠️ UMD build is removed. Switch to the [ESM CDN example](../../examples/graphiql-cdn/index.html).\n\n- Migration from Codemirror to [Monaco Editor](https://github.com/microsoft/monaco-editor)\n - Replacing `codemirror-graphql` with [`monaco-graphql`](../../packages/monaco-graphql)\n - Clicking on a reference in the operation editor now works by holding `Cmd` on macOS or `Ctrl` on Windows/Linux\n- Support for comments in **Variables** and **Headers** editors\n- Added new examples: [**GraphiQL x Vite**](../../examples/graphiql-vite) and [**GraphiQL x Next.js**](../../examples/graphiql-nextjs)\n- Removed examples: **GraphiQL x Parcel** and **GraphiQL x Create React App**\n- Removed props\n - `query`\n - `variables`\n - `headers`\n - `response`\n - `readOnly`\n - `keyMap`. To use Vim or Emacs keybindings in Monaco, you can use community plugins. Monaco Vim: https://github.com/brijeshb42/monaco-vim. Monaco Emacs: https://github.com/aioutecism/monaco-emacs\n - `validationRules`. Use custom GraphQL worker, see https://github.com/graphql/graphiql/tree/main/packages/monaco-graphql#custom-webworker-for-passing-non-static-config-to-worker.'\n\n> [!NOTE]\n>\n> If you used `query`, `variables` and `headers` in integration tests, you can use the new `initialQuery`,\n> `initialVariables` and `initialHeaders` props instead. These props will only be used for the first tab.\n> When opening more tabs, the operation editor will start out empty.\n\n- Added new props\n - `initialQuery`\n - `initialVariables`\n - `initialHeaders`\n- feat: allow `children: ReactNode` for `<GraphiQL.Toolbar />` component\n\n---\n\n## `@graphiql/react`\n\n> [!IMPORTANT]\n>\n> Clicking on a reference in the operation editor now works by holding `Cmd` on macOS or `Ctrl` on Windows/Linux.\n\n- `usePrettifyEditors`, `useCopyQuery`, `useMergeQuery`, `useExecutionContext`, `usePluginContext`, `useSchemaContext`, `useStorageContext` hooks are deprecated.\n- Add new `useGraphiQL` and `useGraphiQLActions` hooks instead. See updated [README](../../packages/graphiql-react/README.md#available-stores) for more details about them.\n- remove `useSynchronizeValue` hook\n- fix `defaultQuery` with empty string does not result in an empty default query\n- fix `defaultQuery`, when is set will only be used for the first tab. When opening more tabs, the operation editor will start out empty\n- fix execute query shortcut in operation editor, run it even there are no operations in the operation editor\n- fix plugin store, save last opened plugin in storage\n- remove `onClickReference` from variable editor\n- fix shortcut text per OS for default query and in run query in execute query button's tooltip\n\nThe `ToolbarMenu` component has changed.\n\n- The `label` and `className` props were removed\n- The `button` prop should now be a button element\n\n ```jsx\n <ToolbarMenu\n label=\"Options\"\n button={\n <ToolbarButton label=\"Options\">\n <SettingsIcon className=\"graphiql-toolbar-icon\" aria-hidden=\"true\" />\n </ToolbarButton>\n }\n >\n <ToolbarMenu.Item onSelect={() => console.log('Clicked!')}>\n Test\n </ToolbarMenu.Item>\n </ToolbarMenu>\n ```\n\n## `@graphiql/plugin-code-exporter`\n\n> [!WARNING]\n>\n> ⚠️ UMD build is removed. Switch to the [ESM CDN example](../../packages/graphiql-plugin-code-exporter/example/index.html).\n\n---\n\n## `@graphiql/plugin-explorer`\n\n> [!WARNING]\n>\n> ⚠️ UMD build is removed. Switch to the [ESM CDN example](../../examples/graphiql-cdn/index.html).\n\n---\n\n## @graphiql/plugin-doc-explorer\n\n- `useExplorerContext` hook is deprecated. Use new `useDocExplorer` and `useDocExplorerActions` hooks instead.\n- The shortcut to focus on the Doc Explorer search input is now `Cmd/Ctrl+Alt+K`\n instead of the previous `Cmd/Ctrl+K`. This was changed because monaco-editor has\n a built-in `Cmd/Ctrl+K` command.\n- push a field type on stack too before field\n- fix: show spinner in doc explorer based on `isIntrospecting` value, and not based on `isFetching`\n\n---\n\n## @graphiql/plugin-history\n\n- `useHistoryContext` hook is deprecated. Use new `useHistory` and `useHistoryActions` hooks instead.\n"
},
{
"path": "docs/security/2021-introspection-schema-xss.md",
"content": "- [1. GraphiQL introspection schema template injection attack: Advisory Statement](#1-graphiql-introspection-schema-template-injection-attack-advisory-statement)\n - [1.1. Impact](#11-impact)\n - [1.2. Scope](#12-scope)\n - [1.3. Patches](#13-patches)\n - [1.3.1 CDN bundle implementations may be automatically patched](#131-cdn-bundle-implementations-may-be-automatically-patched)\n - [1.4. Workarounds for Older Versions](#14-workarounds-for-older-versions)\n - [1.5. How to Re-create the Exploit](#15-how-to-re-create-the-exploit)\n - [1.6. Credit](#16-credit)\n - [1.7. References](#17-references)\n - [1.8. For more information](#18-for-more-information)\n- [2. More Details on the Vulnerability](#2-more-details-on-the-vulnerability)\n- [3. Compromised introspection Schema Example](#3-compromised-introspection-schema-example)\n\n## 1. GraphiQL introspection schema template injection attack: Advisory Statement\n\nThis is a security advisory for an XSS vulnerability in `graphiql`.\n\nA similar vulnerability affects `graphql-playground`, a fork of `graphiql`.\nThere is a corresponding `graphql-playground`\n[advisory](https://github.com/graphql/graphql-playground/security/advisories/GHSA-59r9-6jp6-jcm7)\nand\n[Apollo Server advisory](https://github.com/apollographql/apollo-server/security/advisories/GHSA-qm7x-rc44-rrqw).\n\n### 1.1. Impact\n\nAll versions of `graphiql` older than\n[`graphiql@1.4.7`](https://github.com/graphql/graphiql/releases/tag/v1.4.7) are\nvulnerable to compromised HTTP schema introspection responses or `schema` prop\nvalues with malicious GraphQL type names, exposing a dynamic XSS attack surface\nthat can allow code injection on operation autocomplete.\n\nIn order for the attack to take place, the user must load a vulnerable schema in\n`graphiql`. There are a number of ways that can occur.\n\nBy default, the schema URL is _not_ attacker-controllable in `graphiql` or in\nits suggested implementations or examples, leaving only very complex attack\nvectors.\n\nIf a custom implementation of `graphiql`'s `fetcher` allows the schema URL to be\nset dynamically, such as a URL query parameter like `?endpoint=` in\n`graphql-playground`, or a database provided value, then this custom `graphiql`\nimplementation is _vulnerable to phishing attacks_, and thus much more readily\navailable, low or no privilege level xss attacks. The URLs could look like any\ngeneric looking graphql schema URL.\n\nBecause this exposes an XSS attack surface, it would be possible for a threat\nactor to exfiltrate user credentials, data, etc. using arbitrary malicious\nscripts, without it being known to the user.\n\n### 1.2. Scope\n\nThis advisory describes the impact on the `graphiql` package. The vulnerability\nalso affects other projects forked from `graphiql` such as\n[`graphql-playground`](https://github.com/graphql/graphql-playground/security/advisories/GHSA-59r9-6jp6-jcm7)\nand the `graphql-playground` fork distributed by Apollo Server. The impact is\nmore severe in the `graphql-playground` implementations; see the\n[`graphql-playground` advisory](https://github.com/graphql/graphql-playground/security/advisories/GHSA-59r9-6jp6-jcm7)\nand\n[Apollo Server advisory](https://github.com/apollographql/apollo-server/security/advisories/GHSA-qm7x-rc44-rrqw)\nfor details.\n\nThis vulnerability does not impact `codemirror-graphql`, `monaco-graphql` or\nother dependents, as it exists in `onHasCompletion.ts` in `graphiql`. It does\nimpact all forks of `graphiql`, and every released version of `graphiql`.\n\nIt should be noted that desktop clients such as Altair, Insomnia, Postwoman, do\nnot appear to be impacted by this.\n\n### 1.3. Patches\n\n`graphiql@1.4.7` addresses this issue via defense in depth.\n\n- **HTML-escaping text** that should be treated as text rather than HTML. In\n most of the app, this happens automatically because React escapes all\n interpolated text by default. However, one vulnerable component uses the\n unsafe `innerHTML` API and interpolated type names directly into HTML. We now\n properly escape that type name, which fixes the known vulnerability.\n\n- **Validates the schema** upon receiving the introspection response or schema\n changes. Schemas with names that violate the GraphQL spec will no longer be\n loaded. (This includes preventing the Doc Explorer from loading.) This change\n is also sufficient to fix the known vulnerability. You can disable this\n validation by setting `dangerouslyAssumeSchemaIsValid={true}`, which means you\n are relying only on escaping values to protect you from this attack.\n\n- **Ensuring that user-generated HTML is safe**. Schemas can contain Markdown in\n `description` and `deprecationReason` fields, and the web app renders them to\n HTML using the `markdown-it` library. As part of the development of\n `graphiql@1.4.7`, we verified that our use of `markdown-it` prevents the\n inclusion of arbitrary HTML. We use `markdown-it` without setting\n `html: true`, so we are comfortable relying on\n [`markdown-it`'s HTML escaping](https://github.com/markdown-it/markdown-it/blob/master/docs/security.md)\n here. We considered running a second level of sanitization over all rendered\n Markdown using a library such as `dompurify` but believe that is unnecessary\n as `markdown-it`'s sanitization appears to be adequate. `graphiql@1.4.7` does\n update to the latest version of `markdown-it` (v12, from v10) so that any\n security fixes in v11 and v12 will take effect.\n\n### 1.3.1 CDN bundle implementations may be automatically patched\n\nNote that if your implementation is depending on a CDN version of `graphiql`,\nand is pointed to the `latest` tag (usually the default for most cdns if no\nversion is specified) then this issue is already mitigated, in case you were\nvulnerable to it before.\n\n### 1.4. Workarounds for Older Versions\n\nIf you cannot use `graphiql@1.4.7` or later\n\n- Always use a static URL to a trusted server that is serving a trusted GraphQL\n schema.\n\n- If you have a custom implementation that allows using user-provided schema\n URLs via a query parameter, database value, etc, you must either disable this\n customization, or only allow trusted URLs.\n\n### 1.5. How to Re-create the Exploit\n\nYou can see an example on\n[codesandbox](https://codesandbox.io/s/graphiql-xss-exploit-gr22f?file=/src/App.js).\nThese are both fixed to the last `graphiql` release `1.4.6` which is the last\nvulnerable release; however it would work with any previous release of\n`graphiql`.\n\nBoth of these examples are meant to demonstrate the phishing attack surface, so\nthey are customized to accept a `url` parameter. To demonstrate the phishing\nattack, add `?url=https://graphql-xss-schema.netlify.app/graphql` to the\nin-codesandbox browser.\n\nErase the contents of the given query and type `{u`. You will see an alert\nwindow open, showing that attacker-controlled code was executed.\n\nNote that when React is in development mode, a validation exception is thrown\nvisibly; however that exception is usually buried in the browser console in a\nproduction build of `graphiql`. This validation exception comes from\n`getDiagnostics`, which invokes `graphql` `validate()` which in turn will\n`assertValidSchema()`, as `apollo-server-core` does on executing each operation.\nThis validation does not prevent the exploit from being successful.\n\nNote that something like the `url` parameter is not required for the attack to\nhappen if `graphiql`'s `fetcher` is configured in a different way to communicate\nwith a compromised GraphQL server.\n\n### 1.6. Credit\n\nThis vulnerability was discovered by [@Ry0taK](https://github.com/Ry0taK), thank\nyou! :1st_place_medal:\n\nOthers who contributed:\n\n- [@imolorhe](https://github.com/imolorhe)\n- [@glasser](https://github.com/glasser)\n- [@divyenduz](https://github.com/divyenduz)\n- [@dotansimha](https://github.com/dotansimha)\n- [@acao](https://github.com/acao)\n- [@benjie](https://github.com/benjie) and many others who provided morale\n support\n\n### 1.7. References\n\n**The vulnerability has always been present**\n\n[In the first commit](https://github.com/graphql/graphiql/commit/b9dec272d89d9c590727fd10d62e4a47e0317fc7#diff-855b77f6310b7e4fb1bcac779cd945092ed49fd759f4684ea391b45101166437R87)\n\n[And later moved to onHasCompletion.js in 2016](https://github.com/graphql/graphiql/commit/6701b0b626e43800e32413590a295e5c1e3d5419#diff-d45eb76aebcffd27d3a123214487116fa95e0b5a11d70a94a0ce3033ce09f879R110)\n(now `.ts` after the typescript migration)\n\n### 1.8. For more information\n\nIf you have any questions or comments about this advisory:\n\n- Open an issue in\n [graphiql repo](https://github.com/graphql/graphiql/new/issues)\n\n## 2. More Details on the Vulnerability\n\nThis section provides more details in addition to the advisory.\n\nAn installation of the GraphiQL web app is vulnerable if two conditions are met:\n\n- The web app trusts information from its corresponding GraphQL server by\n interpolating information such as GraphQL type names directly into HTML\n instead of appropriately escaping or sanitizing the information.\n- The victim can load the web app in a way where it speaks to a GraphQL server\n controlled by the attacker.\n\nAll versions of `graphiql` prior to 1.4.7 inappropriately trust type names\nprovided by the GraphQL server. They additionally rely on XSS filtering in the\n`markdown-it` package to try to protect themselves from XSS attacks in GraphQL\ndescriptions and deprecation reasons.\n\nBy default, `graphiql` does _not_ allow the attacker to control what GraphQL\nserver it speaks to. Therefore, many installations of `graphiql` are not\naffected by this advisory. Installations are only affected if the `fetcher`\nargument provided to GraphiQL allows arbitrary customization of the GraphQL\nendpoint (eg, reading a GraphQL URL from an URL parameter), or if the attacker\nhas another way of affecting the introspection schema returned by the GraphQL\nserver. (Note that `graphql-playground`, a project which started as a fork of\n`graphiql`, does this sort of URL parsing by default, so `graphql-playground`\ninstallations _are_ affected by a corresponding vulnerability in their default\nconfiguration.)\n\nOne example of \"another way of affecting the introspection schema\" would be if\nyou served `graphiql` as part of a PAAS platform that allows users to define\ntheir own GraphQL schemas. In this case, even though the `graphiql` installation\nmight be hard-wired to a single GraphQL endpoint, the attacker has control over\nthat GraphQL endpoint and could use it to inject scripts into `graphiql`. In\nthis case, your `graphiql` installation could be vulnerable if it responds to\nintrospection requests without first validating its schema. GraphQL servers can\nprevent this by refusing to execute operations (including introspection\noperations) on invalid schemas; any server built with `graphql-js` properly\nvalidates its schema prior to execution.\n\n## 3. Compromised introspection Schema Example\n\nYou can view the code for the exploited schema\n[on codesandbox](https://codesandbox.io/s/graphql-xss-compromised-schema-3wdq7?file=/src/bad-schema.js)\nor [in the repository](../../packages/graphiql/test/bad-schema.js)\n\nAs you can see, the introspection schema must contain items with a compromised\n`name` value. this could be fields, input object names, enum names, variable\nnames, etc any graphql\n[NamedType](https://github.com/graphql/graphql-spec/blob/main/spec/Section%202%20--%20Language.md#type-references)\nin the schema with it's name rendered in the autocomplete list.\n\n```json\n{\n \"kind\": \"OBJECT\",\n \"name\": \"<img src=x onerror=alert(document.domain)>\",\n \"description\": null,\n \"fields\": [\n {\n \"name\": \"name\",\n \"description\": null,\n \"args\": [],\n \"type\": {\n \"kind\": \"NON_NULL\",\n \"name\": null,\n \"ofType\": {\n \"kind\": \"SCALAR\",\n \"name\": \"String\",\n \"ofType\": null\n }\n },\n \"isDeprecated\": false,\n \"deprecationReason\": null\n }\n ],\n \"inputFields\": null,\n \"interfaces\": [],\n \"enumValues\": null,\n \"possibleTypes\": null\n}\n```\n"
},
{
"path": "examples/cm6-graphql-legacy-parcel/.gitignore",
"content": ".cache/\n"
},
{
"path": "examples/cm6-graphql-legacy-parcel/README.md",
"content": "## Codemirror 6 Parcel Example\n\nThis example demonstrates how to transpile your own custom ES6 Codemirror 6\nGraphQL implementation with parcel bundler.\n\n### Setup\n\n1. `yarn` and `yarn start` from this folder to start parcel dev mode.\n1. `yarn build` to find production ready files.\n"
},
{
"path": "examples/cm6-graphql-legacy-parcel/package.json",
"content": "{\n \"name\": \"example-cm6-graphql-legacy-parcel\",\n \"version\": \"0.0.0\",\n \"license\": \"MIT\",\n \"description\": \"GraphiQL Parcel Example\",\n \"main\": \"index.js\",\n \"private\": true,\n \"scripts\": {\n \"start\": \"parcel src/index.html -p 8080\",\n \"build\": \"parcel build src/index.html --public-url /\"\n },\n \"browserslist\": {\n \"production\": [\n \">0.2%\",\n \"not dead\",\n \"not op_mini all\"\n ],\n \"development\": [\n \"last 1 chrome version\",\n \"last 1 firefox version\",\n \"last 1 safari version\"\n ]\n },\n \"dependencies\": {\n \"@codemirror/basic-setup\": \"^0.20.0\",\n \"@codemirror/language\": \"^0.20.0\",\n \"codemirror-graphql\": \"^2.0.2\",\n \"graphql\": \"^16.9.0\"\n },\n \"devDependencies\": {\n \"parcel-bundler\": \"^1.12.4\",\n \"worker-loader\": \"^2.0.0\",\n \"typescript\": \"^4.6.3\"\n }\n}\n"
},
{
"path": "examples/cm6-graphql-legacy-parcel/src/index.html",
"content": "<!doctype html>\n<html lang=\"en\">\n <head>\n <style>\n body {\n padding: 0;\n margin: 0;\n min-height: 100vh;\n }\n #root {\n height: 100vh;\n }\n </style>\n <meta charset=\"UTF-8\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n <meta http-equiv=\"X-UA-Compatible\" content=\"ie=edge\" />\n <title>CM6 GraphQL Editor Example\n \n\n \n \n \n \n