Skip to content

Commit

Permalink
add documentation for vscode devtools (#12205)
Browse files Browse the repository at this point in the history
  • Loading branch information
phryneas authored Dec 11, 2024
1 parent e022f72 commit db01059
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions .semgrepignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ dist/
# custom paths
__tests__/
./docs/source/data/subscriptions.mdx
./docs/source/development-testing/developer-tooling.mdx
Binary file added docs/source/assets/devtools/vscode-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/assets/devtools/vscode-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,38 @@ You can install the extension via the webstores for [Chrome](https://chrome.goog
While your app is in dev mode, the Apollo Client Devtools will appear as an "Apollo" tab in your web browser inspector. To enable the devtools in your app in production, pass `connectToDevTools: true` to the `ApolloClient` constructor in your app. Pass `connectToDevTools: false` if want to manually disable this functionality.

Find more information about contributing and debugging on the [Apollo Client Devtools GitHub page](https://github.com/apollographql/apollo-client-devtools).

## Apollo Client Devtools in VS Code

The Apollo VSCode extension ships with an instance of the Apollo Client Devtools.
You can use it to remotely debug your client, which makes it possible to also debug React Native and node applications.

The following sections walk through how to install and integrate with the extension.

<Note>
This feature is currently released as "experimental" - please try it out and give us feedback in our [GitHub issues](https://github.com/apollographql/vscode-graphql/issues)!
</Note>

* Install the Apollo VS Code extension: [start installation](vscode:extension/apollographql.vscode-apollo) | [marketplace page](https://marketplace.visualstudio.com/items?itemName=apollographql.vscode-apollo)
* Set the "Apollographql > Dev Tools: Show Panel" setting to "detect" or "always" in the VS code settings dialog.
<img class="screenshot" alt="A screenshot of the VS Code settings dialog focusing on the 'Show Panel' option" src="../assets/devtools/vscode-setting.png"/>
* In your code base, install the `@apollo/client-devtools-vscode` package:
```sh
npm install @apollo/client-devtools-vscode
```
* After initializing your `ApolloClient` instance, call `registerClient` with your client instance.
```js
import { registerClient } from "@apollo/client-devtools-vscode";

const client = new ApolloClient({ /* ... */ });

// we recommend wrapping this statement in a check for e.g. process.env.NODE_ENV === "development"
const devtoolsRegistration = registerClient(
client,
// the default port of the VSCode DevTools is 7095
"ws://localhost:7095",
);
```
* Open the "Apollo Client DevTools" panel in VS Code.
* Start your application. It should automatically connect to the DevTools.
<img class="screenshot" alt="Apollo Client Devtools in a VS Code panel" src="../assets/devtools/vscode-panel.png"/>

0 comments on commit db01059

Please sign in to comment.