Bug Horn 🔊

A VS Code extension that plays a 'bug horn' sound whenever an error appears in your terminal. Perfect for catching errors when you're multitasking!

Features

🎵 Automatically plays a sound when bug horn errors are detected
⚙️ Configurable error patterns to match
🔊 Adjustable volume control
🎮 Easy toggle on/off
🧪 Test sound command to verify it's working

Installation

Open VS Code
Press Ctrl+P to open Quick Open
Paste the following command and press Enter:
```
ext install ayushsharaf.bug-horn
```
Done! The extension will activate automatically.

Commands

Bug Horn: Toggle Error Sound - Enable/disable the sound
Bug Horn: Test Sound - Play a random sound from your collection
Bug Horn: Add Custom Sound - Choose audio files from your computer to add to the extension
Bug Horn: Open Custom Sounds Folder - Open the directory where your custom sounds are stored

Access commands via Command Palette (Ctrl+Shift+P or Cmd+Shift+P)

Configuration

Open VS Code settings and search for "Bug Horn" to configure:

`bugHorn.enabled`

Type: boolean
Default: true
Description: Enable/disable the bug horn on bug horn errors

`bugHorn.volume`

Type: number
Default: 0.5
Range: 0.0 to 1.0
Description: Volume level for the bug horn

`bugHorn.errorPatterns`

Type: array

Default:

[
  "error:",
  "Error:",
  "ERROR:",
  "fail:",
  "FAIL:",
  "Failed",
  "fatal:",
  "FATAL:",
  "Exception",
  "Traceback"
]

Description: Patterns to detect errors in terminal output

Audio Player Requirements

The extension uses system audio players to play sounds:

Linux: Requires paplay (PulseAudio), aplay (ALSA), or ffplay (FFmpeg)
macOS: Uses built-in afplay
Windows: Uses PowerShell's SoundPlayer

Installing Audio Players (Linux)

If you don't have an audio player installed:

# For Ubuntu/Debian (PulseAudio)
sudo apt-get install pulseaudio-utils

# For ALSA
sudo apt-get install alsa-utils

# For FFmpeg
sudo apt-get install ffmpeg

Packaging the Extension

To package and install the extension:

Install vsce (VS Code Extension Manager):
```
npm install -g @vscode/vsce
```
Package the extension:
```
vsce package
```
Install the .vsix file:
- Open VS Code
- Go to Extensions (Ctrl+Shift+X)
- Click the "..." menu → "Install from VSIX"
- Select the generated .vsix file

Publishing (Optional)

To publish to the VS Code Marketplace:

Create a publisher account at https://marketplace.visualstudio.com/
Update publisher in package.json
Run:
```
vsce publish
```

How It Works

The extension monitors all terminal output using VS Code's onDidWriteTerminalData event
When terminal data is written, it checks against configured error patterns
If an error pattern is matched, it plays the sound file
The sound is played using system audio players (platform-specific)

Troubleshooting

Sound not playing?

Check sound files exist: Make sure you have added custom audio files via the "Bug Horn: Add Custom Sound" command.
Test the sound: Use the "Bug Horn: Test Sound" command (it will pick one at random from your custom sounds)
Check audio player: Ensure you have a compatible audio player installed (see requirements)
Check system volume: Make sure your system volume is not muted
Check extension logs: Open Output panel → select "Bug Horn Error"

Too many false positives?

Adjust the bugHorn.errorPatterns setting to be more specific to your needs.

Sound too loud/quiet?

Adjust the bugHorn.volume setting (0.0 to 1.0).

Development

Project Structure

Bug Horn/
├── extension.js          # Main extension code
├── package.json          # Extension manifest
└── README.md            # This file

Testing

Open the extension folder in VS Code
Press F5 to start debugging
Test in the Extension Development Host window

License

MIT License - Feel free to use and modify!

Contributing

Contributions are welcome! Feel free to:

Add new features
Improve error detection
Add support for more audio formats
Report bugs or issues

Changelog

1.0.0

Initial release
Bug Horn error detection
Configurable error patterns
Volume control
Toggle command
Test sound command

Made with ❤️ for developers who want to hear their bugs!

Bug Horn

ayushsharaf