apollographql / apollographql/apollo-tooling

vscode: support outline for .graphql files

Open
#1,863 0 comments 0 reactions 0 assignees View on GitHub
:computer: component - language-server :spiral_notepad: component - vscode
Dominant language
TypeScript
Stars
3k
Forks
460
PR merge metrics
No merged PRs in 30d

Description

In vscode, GraphQL files do not seem to provide an outline:

![image](https://user-images.githubusercontent.com/8641/77864582-6f83f080-71f7-11ea-9c08-78ab14cf73e2.png)

I think it'd be a swell feature to edit large schemas effectively.

Observed in `apollographql.vscode-apollo` 1.14.4.

AFAICT this should correspond to `textDocument/documentSymbol` in LSP.

Contributor guide

Open the contributing guide

Research direction

Start by locating the VS Code or language-server handling for the `textDocument/documentSymbol` LSP request and the GraphQL schema parsing entry point. Verify how `.graphql` files are identified and how symbols could be exposed; the work is done when large GraphQL schemas display a useful outline in VS Code.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.