paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 36 Packages Projects Releases Wiki Activity

Merge pull request #22268 from jrtaylorJH/patch-3

Browse Source 
Added documentation for debugging with WebStorm
This commit is contained in:
Ben Lambert
2024-01-17 13:31:34 +01:00
committed by GitHub
parent 29f33964e3 60d459822d
commit 52b0405462
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/local-dev/debugging.md
+17
View File
@@ -71,3 +71,20 @@ In your `launch.json`, add a new entry with the following,
"console": "integratedTerminal"
},
```
### WebStorm
This section describes the process for enabling run configurations for Backstage in WebStorm.
Run configurations enable the use of debugging functionality such as steppers and breakpoints.
1. Select `Edit Configurations` in the `Run` dropdown menu. Click the plus sign to add a new
configuration, then select `Node.js`.
2. In `Working directory`, input `{PROJECT_DIR}/packages/backend`.
Replace `{PROJECT_DIR}` with the path to your Backstage repo.
3. In `JavaScript file`, input `{PROJECT_DIR}/node_modules/@backstage/cli/bin/backstage-cli`.
Replace `{PROJECT_DIR}` with the path to your Backstage repo.
4. In `Application parameters`, input `package start`.
5. Optionally, for `Environment Variables`, input `LOG_LEVEL=debug`.
6. Click `Apply` to save the changes.
7. With the newly-created configuration selected, use the `Run` or `Debug` icons on the
toolbar to execute the newly created configuration.