^{[ 🌐 📩 🔥 ]}

👾 vscode-tarantula

This add-on uses JoranHonig/tarantula to highlight the areas code that are most likely causing a failing test suite by utilizing the tarantula fault localisation algorithm.

• Text Editor code line highlighting
• Fault Localization Highscore view
• Tarantula raw output window

How To

This plugin looks for the test & test coverage output provided by solidity-coverage. To get this output, you need to run solidity-coverage with the --matrix option. This will make it output two files:

testMatrix.json - Contains information on which lines are covered by which tests.

mochaOutput.json - The plain test results as provided by the mocha testing framework

This plugin will automatically see when those files are created or changed, and update your code view.

If the test suite succeeded, then vscode shouldn't affect the editor at all. There is no bug breaking the test suite after all.

If the test suite failed however, then vscode-tarantula will give you two ways to find the reason why your test suite is failing.

1. It will highlight the lines which are suspect of breaking your test suite (the denser the background colour, the more suspect that line is)
2. You can use the window on the left to directly navigate to the lines which have the highest suspect rating.

Credits

• JoranHonig/tarantula
• Tarantula fault localisation Algorithm Paper
• Logo made by Freepik from www.flaticon.com

Release Notes

see CHANGELOG