Skip to content

marczinusd/hestia

Repository files navigation

Hestia

Hestia master Coverage Maintainability Rating Technical Debt

WIP application that can analyze a project's code quality by looking at statistics from git and code coverage.

Included in the project is:

  • Shared model for git / coverage statistics
  • Console runner for easily repeatable analysis runs
  • Persistence with EFCore targeting Sqlite
  • Simple web API to serve statistics
  • Angular-based web client here: marczinusd/hestia-ui

General usage

The easiest way to generate reports for your project is via the console runner, which can be invoked with make -- run-console --configPath "yourConfig.json". An example json config file along with a schema can be found under src/Hestia.ConsoleRunner/config.json.

The console runner will then persist the results into a Sqlite instance that can be served through the REST service, which can be started with make run-webservice. Do note that the service is currently configured for CORS only on localhost.

Build

Run make build or build manually by running dotnet build src/Hestia/Hestia.sln.

Build thesis

With LaTeX installed run make build_thesis.

Test

Run make test or test using dotnet CLI by running dotnet test src/Hestia/Hestia.sln.

Cover

Run make cover or generate manually by running dotnet test src/Hestia/Hestia.sln /p:CollectCoverage=true /p:CoverletOutput=TestResults/ /p:CoverletOutputFormat=lcov

About

Tool to generate and organize code quality metrics from git stats and coverage reports

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published