Language-specific Guidelines
We highly recommend that you develop using Visual Studio. Build, test, and deployment scripts are written in bash to provide the widest flexibility.
C# Testing
For C#, the .NET Core 2.1 framework for the widest flexibility.
Tests are written using the xUnit test framework. All tests appear in Visual Studio when using the .NET Core Test Explorer plugin. No additional configuration is required.
A testing script (test.sh) is included in the scripts folder to run tests during the automated build/test/deploy process.
Javascript Testing
Tests are written using the Karma test framework.
A testing script (test.sh) is included in the scripts folder to run tests during the automated build/test/deploy process.
Code Coverage
The goal for the this project is 100% code coverage at all times. Code coverage files are generated as a separate step following the build an dtest processes.
Code coverage can be viewed in Visual Studio by using the Coverlet plugin.
Tips and Tricks
Using Breakpoints: Currently to both use the extension and code debugging breakpoints, you need to disable the gutter coverage and enable the line coverage via the settings (coverage-gutters.showGutterCoverage and coverage-gutters.showLineCoverage respectively).
To view code coverage in HTML you need to install genhtml. Instructions vary by disto, but on Ubuntu for example:
sudo apt-get update -y
sudo apt-get install -y lcovDocumentation
Documentation is automatically generated from C# code comments (not Javascript). Code comments should follow the Microsoft XML comments format.