https://github.com/laurentlb/stardbg

A standalone debugger for Starlark
https://github.com/laurentlb/stardbg

Last synced: 11 days ago
JSON representation

A standalone debugger for Starlark

• Host: GitHub
• URL: https://github.com/laurentlb/stardbg
• Owner: laurentlb
• License: apache-2.0
• Created: 2020-07-05T17:12:41.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-10T16:45:08.000Z (over 4 years ago)
• Last Synced: 2024-07-31T07:15:46.522Z (3 months ago)
• Language: JavaScript
• Size: 117 KB
• Stars: 21
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bazel - Stardbg - A standalone debugger for Starlark (Tooling / Starlark)

README

        
# Experimental debugger for Starlark

This is a standalone debugger for Starlark ,with a web-based UI. In theory, it

can be used to debug any Starlark code that uses the same debugging protocol. At

the moment, the only known compatible server is Bazel.

This is the first draft, there are lots of rough edges and known limitations.

![Screenshot](screenshot.png)

## Example of use

1. Run your normal Bazel command with `--experimental_skylark_debug`, e.g.

```

bazel build --experimental_skylark_debug //my:target

```

The command will hang until a debugger is attached.

2. In a different shell, run the debugger from the stardbg repository. Choose

  where you want your initial breakpoints using an absolute path and a line

  number, e.g.

```

bazel run :stardbg -- /home/myself/dir/my/BUILD.bazel:3

```

Of course, the file should be inside the repository you are debugging (a file

used by `//my:target`).

3. Open a browser at http://localhost:8080/

## Caveats

* A breakpoint will be effective only when the corresponding line is evaluated.

  Since Bazel aggressively caches the results, you may want to do a spurious

  change to a file to force a re-evaluation.

* At the moment, you need to kill and rerun the debugger each time you restart a

  debugging session. Also, reload the web page.

* Supported features: display of local variables (in each level of the

  stack trace), support for threads (you can choose which thread to debug,

  switch thread, etc.).

* Missing features: conditional breakpoints, evaluation of custom expressions.

  The visualization of values is very limited.

## Alternative

* The VS Code plugin for Bazel supports the same protocol: https://github.com/bazelbuild/vscode-bazel#using-the-starlark-debugger