Skip to content

Commit 2199806

Browse files
authored
docs: broaden IDE page scope (#3197)
Updates the "IDE Support" page to describe options beyond JetBrains.
1 parent 0311433 commit 2199806

File tree

2 files changed

+48
-34
lines changed

2 files changed

+48
-34
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: IDE Support for Apollo Federation
3+
subtitle: Streamline federated GraphQL development
4+
description: Enhance your development workflow with federation-specific features in VSCode and IntelliJ-based IDEs.
5+
redirectFrom:
6+
- /graphos/reference/federation/jetbrains-ide-support
7+
---
8+
9+
Many IDEs provide features to streamline federated GraphQL development, such as GraphQL-aware syntax highlighting, inline performance information, and autocomplete for fields, types, and federation directives. Learn how to enable federation-specific features in tools like VS Code and JetBrains IDEs.
10+
11+
## Visual Studio Code
12+
13+
Apollo's [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=apollographql.vscode-apollo) provides an all-in-one tooling experience for developing apps with Apollo. See the [dedicated documentation page](/vs-code-extension) for configuration details. If you're developing with Apollo Connectors, refer to the connectors-specific [VS Code Extension page](/graphos/schema-design/connectors/vs-code).
14+
15+
## JetBrains
16+
17+
The [GraphQL Plugin for JetBrains](https://plugins.jetbrains.com/plugin/8097-graphql/) provides federation-specific development features, such as autocomplete for federation directives. However, you must enable this federation support after installing the plugin. Otherwise, your IDE might display unexpected errors while you're working with a subgraph schema.
18+
19+
### Setup
20+
21+
To enable federation support, do the following in your IDE after installing the plugin:
22+
23+
1. Open your IDE's **Settings** window.
24+
2. Expand the **Languages & Frameworks** section.
25+
3. Click **GraphQL**.
26+
4. Check the **Federation** checkbox.
27+
28+
<img
29+
class="screenshot"
30+
alt="An animation showing the process of enabling Apollo Federation support in the GraphQL plugin for JetBrains (described above)"
31+
src="../../images/JetBrains-plugin.webp"
32+
width="600"
33+
/>
34+
35+
This plugin supports all IntelliJ-based IDEs, including:
36+
37+
- IntelliJ IDEA
38+
- PyCharm
39+
- PhpStorm
40+
- WebStorm
41+
- CLion
42+
- RubyMine
43+
- Rider
44+
- GoLand
45+
46+
## Additional resources
47+
48+
If your graph uses the Apollo Router, make sure to enable [router configuration awareness](/graphos/reference/router/configuration#configuration-awareness-in-your-text-editor) in your editor.

docs/source/reference/federation/jetbrains-ide-support.mdx

-34
This file was deleted.

0 commit comments

Comments
 (0)