Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add breakpoint debugging guide #12212

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

theetrain
Copy link
Contributor

Closes #7781, relates to #1144

  • Add breakpoint debugging documentation to the 'appendix' section
image

While testing with the Node.js inspector, I tried to enable server-side breakpoint debugging, but was not successful. The sourcemaps are being generated, but only client-side code connect to chrome devtools. VSCode breakpoint debugging works well.

I'm hoping there could be a way to debug server-side code within chrome devtools as well, which would help developers who aren't using VSCode, but I'm unsure whose domain this falls in: SvelteKit, Vite, or something else.


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented May 12, 2024

⚠️ No Changeset found

Latest commit: 5585533

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

"version": "0.2.0",
"configurations": [
{
"command": "npm start",
Copy link
Member

Choose a reason for hiding this comment

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

I think it'd be helpful to make this npm run dev to match the text above and real projects so that the user can copy/paste this example

@theetrain
Copy link
Contributor Author

Thanks, Ben! I also added a link to Svelte Inspector for good measure.

Copy link
Member

@Conduitry Conduitry left a comment

Choose a reason for hiding this comment

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

Proposed changes to the svelte.dev site need to target the svelte-4 branch, not main.

@Conduitry Conduitry self-requested a review May 16, 2024 13:07
@Conduitry
Copy link
Member

Apologies, I can't read. This is kit.

"configurations": [
{
"command": "npm run dev",
"name": "Run npm start",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"name": "Run npm start",
"name": "Run npm dev",

@benmccann
Copy link
Member

Can we change the page prefix from 15- to 25-? I'd like to keep the integrations page coming first


## Visual Studio Code

With the build-in debug terminal, you can set up breakpoints in source files within VSCode.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
With the build-in debug terminal, you can set up breakpoints in source files within VSCode.
With the built-in debug terminal, you can set up breakpoints in source files within VSCode.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on how to debug frontend and backend code with source maps
4 participants