{"id":17921871,"url":"https://github.com/zth/vscode-graphiql-explorer","last_synced_at":"2025-03-24T02:32:01.895Z","repository":{"id":39263621,"uuid":"228229046","full_name":"zth/vscode-graphiql-explorer","owner":"zth","description":"Use GraphiQL + GraphiQL Explorer to build your GraphQL operations, right from inside of VSCode.","archived":false,"fork":false,"pushed_at":"2022-12-11T17:18:26.000Z","size":2171,"stargazers_count":36,"open_issues_count":27,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-03-03T00:27:32.402Z","etag":null,"topics":["apollo-client","graphql","reasonml","relay","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zth.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-15T18:11:52.000Z","updated_at":"2022-12-23T02:47:31.000Z","dependencies_parsed_at":"2023-01-27T03:45:55.069Z","dependency_job_id":null,"html_url":"https://github.com/zth/vscode-graphiql-explorer","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zth%2Fvscode-graphiql-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zth%2Fvscode-graphiql-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zth%2Fvscode-graphiql-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zth%2Fvscode-graphiql-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zth","download_url":"https://codeload.github.com/zth/vscode-graphiql-explorer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221931696,"owners_count":16903799,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apollo-client","graphql","reasonml","relay","vscode","vscode-extension"],"created_at":"2024-10-28T20:36:33.477Z","updated_at":"2024-10-28T20:36:33.993Z","avatar_url":"https://github.com/zth.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vscode-graphiql-explorer\n\nUse [GraphiQL](https://github.com/graphql/graphiql) + [OneGraph's](https://www.onegraph.com/) [GraphiQL Explorer](https://github.com/OneGraph/graphiql-explorer) to build your GraphQL operations, right from inside of VSCode.\n\n![Demo](https://github.com/zth/vscode-graphiql-explorer/blob/master/images/vscode-graphiql-explorer.gif?raw=true)\n\n## Features\n\n- Explore your schema and edit + insert GraphQL operations using GraphiQL Explorer conveniently right from VSCode.\n- Supports:\n  - `graphql` and `gql` tags in JavaScript/TypeScript/Vue\n  - `[%graphql]` and `[%relay]` nodes in ReasonML\n  - Plain `.graphql` files\n  - ...easy to add support for more languages and frameworks\n- Explore your schema using GraphiQL right from VSCode.\n\n## Setup\n\n`vscode-graphiql-explorer` needs your introspected schema, either in a `.json` or a `.graphql` file. It tries to find your schema by looking in the workspace root for:\n\n1. `schema.graphql`, `schema.json` or `graphql_schema.json`.\n2. A `.graphqlconfig` file containing `schemaPath` pointing to your schema, like `{ \"schemaPath\": \"/path/to/schema.graphql\" }`.\n\nIf your schema is located somewhere other than the workspace root, please add and configure a `.graphqlconfig` file pointing to the schema as described above.\n\n\u003e **For large schemas, please prefer providing your schema in the SDL format (`.graphql`) rather than JSON**. That will make opening GraphiQL significantly faster.\n\nIf you don't have a schema file, you can create one by running `npx get-graphql-schema http://url/to/your/graphql/endpoint \u003e schema.graphql` in your project root.\n\n## Usage\n\nPut your cursor in a GraphQL operation, activate \"Code Actions\" (the lightbulb that appears next to the code), and select `Edit GraphQL code in GraphiQL explorer`.\n\nIn addition to that, the extension adds 3 commands:\n\n1. `Edit operation`, which does the same as described above, but through an explicit command. Use this with the cursor set in a tag (or full `.graphql` file) containing a GraphQL operation.\n2. `Insert operation here`, which let you insert an operation into your source file via GraphiQL. Use this with the cursor set in an empty GraphQL tag, or in a `.graphql` file.\n3. `Explore schema with GraphiQL`, which opens GraphiQL and let you explore your schema, without inserting or editing anything.\n\n## Contributing\n\nIs your favorite language/framework not supported? Check out [this link](https://github.com/zth/vscode-graphiql-explorer/issues/7#issuecomment-582071568) for instructions on how to PR support.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzth%2Fvscode-graphiql-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzth%2Fvscode-graphiql-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzth%2Fvscode-graphiql-explorer/lists"}