Testing#
SonarAnalyzer.CSharp#
Themerr-jellyfin uses SonarAnalyzers.CSharp to spot Bugs, Vulnerabilities, and Code Smells in the project. This is run automatically as part of the build process.
The config file for SonarAnalyzers.CSharp is .editorconfig
.
StyleCop.Analyzers#
Themerr-jellyfin uses StyleCop.Analyzers to enforce consistent code styling. This is run automatically as part of the build process.
The config file for StyleCop.Analyzers is .editorconfig
.
Sphinx#
Themerr-jellyfin uses Sphinx for documentation building. Sphinx, along with other required python dependencies are included in the ./docs/requirements.txt file. Python is required to build sphinx docs. Installation and setup of python will not be covered here.
The config file for Sphinx is docs/source/conf.py
. This is already included in the root of the repo and should not
be modified.
- Test with Sphinx
cd docs make html
Alternatively
cd docs sphinx-build -b html source build
- Lint with rstcheck
rstcheck -r .
Unit Testing#
Themerr-jellyfin uses xUnit for unit testing.
- Test with xUnit
dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat=opencover --logger "console;verbosity=detailed"