Debugging

rust-lldb

rust-lldb can be used to get panic information from debug builds.

Enable debug symbols:

[profile.release]
debug = true
strip = false
panic = "unwind"

Build the binary:

cargo build --release --bin oxlint --features allocator

Run the binary:

rust-lldb -- ./target/release/oxlint

Once it launches, press r for running the program.

Debug TypeScript in VSCode

According to their debugging guide, in the TypeScript repository:

• rename .vscode/launch.template.json to launch.json
• add tests/cases/compiler/foo.ts
• change "${fileBasenameNoExtension}" to foo.ts
• set a breakpoint somewhere in TypeScript's source code
• from the menu "Run - Debugging", or press F5
• while debugging, tsc will evaluate global .d.ts files before the targeted test file
• Debug.formatXXX(value) from src/compiler/debug.ts can be used to print out enum values
• use the "WATCH" section to "see" value of interest

Debug Linter in VSCode

It's easy to debug Linter for a npm project somewhere else with CodeLLDB.

In .vscode/launch.json, change config fields to your need:

• cwd: absolute path to the npm project
• args: arguments passed to linter

{
  "type": "lldb",
  "request": "launch",
  "name": "Debug Oxlint",
  "cargo": {
    "env": {
      "RUSTFLAGS": "-g"
    },
    "args": ["build", "--bin=oxlint", "--package=oxlint"],
    "filter": {
      "name": "oxlint",
      "kind": "bin"
    }
  },
  "cwd": "PATH-TO-TEST-PROJECT", 
  "args": ["--ARGS-TO-OXLINT"] 
}

Open VS Code Debugging panel and select Debug Oxlint, then start debugging.

The debug process will be launched with specified cwd, like running linter in testing project and attaching debugger into it.