https://github.com/rogalmic/vscode-bash-debug

Bash shell debugger extension for VSCode (based on bashdb)
https://github.com/rogalmic/vscode-bash-debug

Last synced: 8 days ago
JSON representation

Bash shell debugger extension for VSCode (based on bashdb)

• Host: GitHub
• URL: https://github.com/rogalmic/vscode-bash-debug
• Owner: rogalmic
• License: mit
• Created: 2016-10-28T09:08:41.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-08-18T23:27:12.000Z (over 1 year ago)
• Last Synced: 2025-01-05T06:39:51.206Z (16 days ago)
• Language: Shell
• Homepage:
• Size: 12.3 MB
• Stars: 231
• Watchers: 6
• Forks: 26
• Open Issues: 68
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# VS Code Bash Debug

A bash debugger GUI frontend based on awesome `bashdb` scripts (bashdb now included in package).

# Overview

This is a SIMPLE bashdb debugger frontend. Useful for learning bash shell usage and writing simple scripts.

Useful hint: shellcheck extension does a great job with finding common script errors before debugging.

## Usage

1. Select **Debug -> Add Configuration** to add custom debug configuration (drop-down, path-input, etc...)

1. Select **Debug -> Start Debugging (F5)** to start debugging

See https://code.visualstudio.com/docs/editor/debugging for general usage.

## Sample features

- Debugging auto-configuration via `launch.json`

[](https://raw.githubusercontent.com/rogalmic/vscode-bash-debug/gif/images/bash-debug-samp-launch-autoconfig.gif)

- Simple debugging in hello world application

[](https://raw.githubusercontent.com/rogalmic/vscode-bash-debug/gif/images/bash-debug-samp-hello-world.gif)

- Standard input handling via terminal

[](https://raw.githubusercontent.com/rogalmic/vscode-bash-debug/gif/images/bash-debug-samp-stdin-usage.gif)

- Pause support while script is running

[](https://raw.githubusercontent.com/rogalmic/vscode-bash-debug/gif/images/bash-debug-samp-pause-support.gif)

- Advanced "Watch" and "Debug console" usage

[](https://raw.githubusercontent.com/rogalmic/vscode-bash-debug/gif/images/bash-debug-samp-watch-advanced.gif)

- Conditional breakpoints usage

[](https://raw.githubusercontent.com/rogalmic/vscode-bash-debug/gif/images/bash-debug-samp-conditional-breakpoints.gif)

For Windows users:

- Install [Windows Subsystem for Linux](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)

- Terminal has problems with spaces in paths when powershell is used, use [WSL bash](https://github.com/Microsoft/vscode/issues/22317) instead. For beta WSL please read [this](https://github.com/rogalmic/vscode-bash-debug/issues/93)

- `pathBash` refers to BASH binary path in WSL filesystem, not path to `wsl.exe`/`bash.exe`

For macOS users:

- Read [here](https://github.com/rogalmic/vscode-bash-debug/wiki/macOS:-avoid-use-of--usr-local-bin-pkill) if your mac has `/usr/local/bin/pkill`.

- Install `bash` version `4.*` and set `pathBash` properly

## Dependencies

1. `bash` version `4.0` or later

2. `cat`, `mkfifo`, `rm`, `pkill`

## Limitations and known problems

* Use `terminalKind`@`launch.json` set to `integrated` or `external` for interactive scripts (using stdin)

* Currently debugger stops at first command

* `$0` variable shows path to bashdb

* Older `bash` versions ( `4.0` - `4.2` ) are not tested, but might work™

* `BASH_REMATCH` gets overwritten when stepping through code