VineBoomErrors

Plays the Vine boom sound effect when your badly-written code generates errors.

Features

• Play the Vine boom sound effect command to play the Vine boom... on command.
• When new errors are found through linting or static analysis because of your lackluster, maidenless craftmanship, the Vine boom sound effect will be played for each of them individually.

Configuration

• vineBoomErrors.playBoomOnError
  • If true, plays the Vine boom sound effect when an error is produced by a linter or static analysis.
  • Default: true
• vineBoomErrors.soundEffectLocation
  • If left blank, uses the Vine boom sound stored in the extension directory. You can put a path to another sound file to change the sound played.
  • Default: ""
• vineBoomErrors.delay
  • The time, in milliseconds, to space apart each Vine boom.
  • Allowable values: non-negative
  • Default: 100
• vineBoomErrors.players
  • The command-line players to play the Vine boom effect with. Uses the first one found to be present, searching from first to last. If left blank, uses the player list supplied by player-sounder. Must be compatible with MP3s.
  • Default: [] ("mplayer", "mpv", "ffplay", "cvlc", "play", "mpg123", and "mpg321" from player-sounder as of version 1.0.0.)
• vineBoomErrors.playerOptions
  • Command-line options to supply to the players. Keys are the names of the players and must be the same as in vineBoomErrors.players. At a minimum, any options that close the player after playing and prevent it from opening any windows are required if that is not the default behavior. Uses the player options supplied by player-sounder by default. Any options supplied here will superceed those supplied by player-sounder.
  • Default: {} (ffplay: ["-nodisp", "-autoexit"] and cvlc: ["--play-and-exit"] from player-sounder as of version 1.0.0.)
• vineBoomErrors.minimumSeverity
  • The minimum diagnostic severity level at which to play the Vine boom. Choosing an option also chooses all of the options before it.
  • Allowable values: "Error", "Warning", "Information", "Hint"
  • Default: "Error"

How to build

Make sure you have Node.js and vsce installed on your system.

Run the following command(s) within the project directory.

vsce package

Installation

VineBoomErrors can be installed directly from the VSCode Marketplace.

Alternatively you could download the latest .vsix package from RELEASES, or compile from source, and install it manually, which can be done either in the extensions side tab, or by running the following command(s):

code --install-extension <package name goes here>

Make sure to reload or restart Visual Studio Code after installing.

Release Notes

• Switched to my own audio library player-sounder that fixes the problems I had with play-sound.
• Reloading is no longer neccessary to update which player is being used.
• Fixed weirdness with how the configuration was loaded, resulting in the above.
• Changed how the player list and player options configurations were loaded to account for player-sounder's defaults. The player list now uses player-sounder's when empty, but the user supplied list when not. The player options uses player-sounder's, overwriting any entries present in the user supplied options with the user's values. I reccommend checking to see if yours is configured correctly after these changes.

1.0.0

• Switched from play-sound to find-exec for playing audio files as play-sound didn't offer much in terms of functionality, and most of what it offered had to be overwritten anyways.
• Added ability to configure which audio players to use.
• Added ability to configure what arguments are used with which audio players.
• Configuration changes are now loaded live and only one remains that still requires reloading.
• Added ability to configure at which error severity level to play the Vine boom.

0.1.0

• Initial release.

Copyright

The logo is derived from Vine's logo © 2018 Twitter, Inc.