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 debugging guide #9540

Merged
merged 3 commits into from
Mar 7, 2025
Merged

docs: add debugging guide #9540

merged 3 commits into from
Mar 7, 2025

Conversation

hardfist
Copy link
Contributor

@hardfist hardfist commented Mar 4, 2025

This pull request includes several changes to improve debugging configurations and documentation for the Rspack project. The most important changes involve updates to the .vscode/launch.json file, enhancements to debugging documentation, and the addition of example files for debugging.

Debugging Configuration Updates:

  • .vscode/launch.json: Removed outdated configurations and added new ones for debugging Rspack, including
  • Debug Rspack: use lldb to debug rust code
  • Attach JavaScript: used to debug javascript code
  • Attach Rust: used to debug launched rspack process

Also added input options for rspack command and configuration path

  • rspackProjectPath: rspack config path, default to examples/basic/rspack.config.js, so rspack constributors don't need to setup a new project to debug rspack
  • rspackCommand: dev & build

Documentation Enhancements:

Example Files for Debugging:

@github-actions github-actions bot added the team The issue/pr is created by the member of Rspack. label Mar 4, 2025
Copy link

netlify bot commented Mar 4, 2025

Deploy Preview for rspack canceled.

Name Link
🔨 Latest commit 8a2a177
🔍 Latest deploy log https://app.netlify.com/sites/rspack/deploys/67c6a7c640dc8f00081376f8

@hardfist hardfist changed the title chore: add debugging guide docs: add debugging guide Mar 4, 2025
@github-actions github-actions bot added the release: document release: document related release(mr only) label Mar 4, 2025
Copy link

codspeed-hq bot commented Mar 4, 2025

CodSpeed Performance Report

Merging #9540 will not alter performance

Comparing yj/rewrite-debug-guide (8a2a177) with main (44f96be)

Summary

✅ 7 untouched benchmarks

@hardfist hardfist enabled auto-merge (squash) March 7, 2025 08:52
@hardfist hardfist merged commit 1c272bc into main Mar 7, 2025
29 checks passed
@hardfist hardfist deleted the yj/rewrite-debug-guide branch March 7, 2025 08:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release: document release: document related release(mr only) team The issue/pr is created by the member of Rspack.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants