Skip to content

Conversation

@karthik2804
Copy link
Contributor

Adds docs for using the StarlingMonkey debugger with the JavaScript SDK for Spin.


#### Setup

First, make sure that the extension is installed. Next verify that the templates are new enough to support debugging. This can be verified by looking `.vscode/setting.json` and verifying if something like the following is configured:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe split this into "installing the extension" (once) and "setting up the project" (each project).


![JS debugger running](/static/image/docs/js-debugger-running.png)

**Note:** that the debugger currently does not follow sourcemaps for npm dependencies as some packages may not bundle the source code in the pacakge.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Note:** that the debugger currently does not follow sourcemaps for npm dependencies as some packages may not bundle the source code in the pacakge.
**Note:** The debugger currently does not follow sourcemaps for NPM dependencies, as some packages do not bundle the source code in the package.


**Note:** that the debugger currently does not follow sourcemaps for npm dependencies as some packages may not bundle the source code in the pacakge.

## Caveats
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure but it feels like this has come adrift from the stuff about APIs and packages that it more naturally lives with perhaps?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not follow this. Can you elaborate please?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Caveats" section feels like it's talking primarily about APIs and packages. But it is now separated from the APIs and packages stuff by a long section about debugging - someone reading about the programming model will likely not check all the way to the bottom of the page to see it. So I am wondering if the debugging stuff should come after Caveats rather than before it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah got it. Moved the section above.

@itowlson
Copy link
Contributor

itowlson commented Feb 3, 2026

@karthik2804 Is this still on your radar? Sorry, I realise travel has thrown things out.

@karthik2804
Copy link
Contributor Author

@itowlson I will get to this today.

@karthik2804 karthik2804 force-pushed the add_js_debugger_docs branch 2 times, most recently from 4b39d7c to 701fe98 Compare February 5, 2026 13:39
Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>

small fixes based on suggestions

Signed-off-by: Karthik Ganeshram <kganeshr@akamai.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants