You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/spfx/debug-in-vscode.md
+18-15Lines changed: 18 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,20 @@
1
1
---
2
2
title: Debug SharePoint Framework solutions in Visual Studio Code
3
3
description: Prerequisites and steps for configuring Visual Studio Code for debugging SharePoint Framework solutions.
4
-
ms.date: 07/15/2022
4
+
ms.date: 04/26/2025
5
5
ms.localizationpriority: high
6
6
---
7
7
# Debug SharePoint Framework solutions in Visual Studio Code
8
8
9
9
Visual Studio Code is a popular code editor frequently used for building SharePoint Framework solutions. By setting up debugging of your SharePoint Framework solution in Visual Studio Code, you can more efficiently step through your code and fix errors.
10
10
11
-
You can also see the required steps to enable debugging in Visual Studio Code in this video on the Microsoft 365 Platform Communtiy (PnP) YouTube Channel:
11
+
You can also see the required steps to enable debugging in Visual Studio Code in this video on the Microsoft 365 Platform Community (PnP) YouTube Channel:
The easiest way to configure Visual Studio Code (VS Code) to debug SharePoint Framework solutions is by using the [JavaScript Debugger](https://github.com/microsoft/vscode-js-debug) included in VS Code to debug Chrome & Edge.
17
+
The easiest way to configure Visual Studio Code (VS Code) to debug SharePoint Framework solutions is to use the [JavaScript Debugger](https://github.com/microsoft/vscode-js-debug) included in VS Code to debug Chrome & Edge.
18
18
19
19
You also need **Google Chrome** or **Microsoft Edge**.
20
20
@@ -29,13 +29,13 @@ You can locate the debug configurations in the **./vscode/launch.json** file und
29
29

30
30
31
31
1. In Visual Studio Code, on the **View** menu, select the **Integrated Terminal** option or select <kbd>ctrl</kbd>+<kbd>`</kbd> on the keyboard.
32
-
1. In the terminal run the following command:
32
+
1. In the terminal, run the following command:
33
33
34
34
```console
35
35
gulp serve --nobrowser
36
36
```
37
37
38
-
Running this command builds your SharePoint Framework solution and starts the local webserver to serve the output files. Because the debugger starts its own instance of the browser, you use the **--nobrowser** argument to prevent the **serve** task from opening a browser window.
38
+
Running this command builds your SharePoint Framework solution and starts the local web server to serve the output files. Because the debugger starts an instance of the browser, you use the **--nobrowser** argument to prevent the **serve** task from opening a browser window.
39
39
40
40

41
41
@@ -46,7 +46,7 @@ After the gulp task is finished, move the focus to the code area of Visual Studi
46
46
The debug mode in Visual Studio Code starts, changing the color of the status bar to orange and opening a new window of Google Chrome showing the SharePoint Workbench.
47
47
48
48
> [!NOTE]
49
-
> At this point the breakpoint is disabled because the web part's code hasn't been loaded yet. SharePoint Framework loads web parts on demand only after they have been added to the page.
49
+
> At this point, the breakpoint is disabled because the web part's code hasn't been loaded yet. SharePoint Framework loads web parts on demand only after they have been added to the page.
50
50
51
51

52
52
@@ -104,19 +104,19 @@ Debugging an Extension in a hosted workbench is similar to the steps for a Web P
104
104
105
105

106
106
107
-
1. After initiating the gulp serve in the Terminal start debugging either by selecting <kbd>F5</kbd> or by selecting the **Start Debugging** option on the **Debug** menu. Visual Studio Code switches into debug mode, indicated by the orange status bar, and the Debugger for Chrome extension opens a new instance of Google Chrome with the Microsoft 365 sign-in page.
107
+
1. After initiating the gulp serve in the Terminal, start debugging either by selecting <kbd>F5</kbd> or by selecting the **Start Debugging** option on the **Debug** menu. Visual Studio Code switches into debug mode, indicated by the orange status bar, and the Debugger for Chrome extension opens a new instance of Google Chrome with the Microsoft 365 sign-in page.
108
108
109
109

110
110
111
-
1. In the workbench tab that was opened in your browser navigate to a SharePoint Online page that you wish to test your extension.
111
+
1. In the workbench tab that was opened in your browser, navigate to a SharePoint Online page that you wish to test your extension.
112
112
1. Append the following query string parameters to the URL. Notice that you need to update the ID to match your own extension identifier. This is available in the **HelloWorldApplicationCustomizer.manifest.json** file.
113
113
114
114
> [!CAUTION]
115
115
> Line breaks & indentation have been added to the following snippet for readability. The following text should be on a single line with no whitespace.
@@ -125,14 +125,17 @@ Debugging an Extension in a hosted workbench is similar to the steps for a Web P
125
125
}}
126
126
```
127
127
128
-
More detail about the URL parameters:
128
+
> [!NOTE]
129
+
> The development URL was changed in the SPFx v1.21 release from `https://localhost:4321/temp/manifests.js` to `https://localhost:4321/temp/build/manifests.js`.
130
+
131
+
Additional details about the URL parameters:
129
132
130
133
- **loadSPFX=true**: Ensures that the SharePoint Framework is loaded on the page. For performance reasons, the framework does not load unless at least one extension is registered. Because no components are registered, you must explicitly load the framework.
131
134
- **debugManifestsFile**: Specifies that you want to load SPFx components that are locally served. The loader only looks for components in the app catalog (for your deployed solution) and the SharePoint manifest server (for the system libraries).
132
135
- **customActions**: Simulates a custom action. When you deploy and register this component in a site, you'll create this **CustomAction** object and describe all the different properties you can set on it.
133
136
- **Key**: Use the GUID of the extension as the key to associate with the custom action. This has to match the ID value of your extension, which is available in the extension manifest.json file.
134
137
- **Location**: The type of custom action. Use `ClientSideExtension.ApplicationCustomizer` for the Application Customizer extension.
135
-
- **Properties**: An optional JSON object that contains properties that are available via the `this.properties` member. In this HelloWorld example, it defined a `testMessage` property.
138
+
- **Properties**: An optional JSON object that contains properties that are available via the `this.properties` member. In this HelloWorld example, it defines a `testMessage` property.
136
139
137
140
The full URL should look similar to the following:
138
141
@@ -142,7 +145,7 @@ Debugging an Extension in a hosted workbench is similar to the steps for a Web P
@@ -155,7 +158,7 @@ Debugging an Extension in a hosted workbench is similar to the steps for a Web P
155
158
156
159

157
160
158
-
When the page loads, you should now be able to see the Extension on your page (in this case a list view command extension):
161
+
When the page loads, you should now be able to see the Extension on your page (in this case, a list view command extension):
159
162
160
163

161
164
@@ -165,10 +168,10 @@ Debugging an Extension in a hosted workbench is similar to the steps for a Web P
165
168
166
169
## Debugging with Microsoft Edge or older projects
167
170
168
-
If you're using an older version of SharePoint Framework Yeoman generator or want to debug with Microsoft Edge, follow these steps to create the launch.json file manually.
171
+
If you're using an older version of the SharePoint Framework Yeoman generator or want to debug with Microsoft Edge, follow these steps to create the launch.json file manually.
169
172
170
173
> [!NOTE]
171
-
> In order for you to debug with Microsoft Edge, you'll have to install the **Windows 10 April 2018 Update** which includes the Microsoft Edge DevTools Protocol.
174
+
> In order for you to debug with Microsoft Edge, you'll have to install the **Windows 10 April 2018 Update**, which includes the Microsoft Edge DevTools Protocol.
172
175
173
176
### Create debug configuration for hosted workbench
0 commit comments