Reports

This module will gather HTML reports generated by other XTDMake modules in a fancy HTML interface. This interface allows to navigates from report to report for all declared modules.

The generated html code is fully static, allowing user to view it directly in a web browser without any web server installed.

Prerequisites

Although there is no actual prerequisites to use this module, it’s designed to work with other XTDMake’s module that generates HTML reports. If none of them then are loaded, Report module will work but won’t display any valuable information.

Generated Targets

reports

run all code quality targets for all modules

reports-clean

clean all generated code quality reports

reports-update

(internal use) update report static interface with available generated code quality targets

reports-show

opens report interface in default web-browser (ie: sensible-browser)

Dependencies

Generated interface

HTML : reports/interface/index.html

Try live example: https://psycofdj.github.io/xtdcpp/master/

Bellow few screnn shots :

Graph history

Report module also provides a graph generator tools that allow to keep track of the code quality measurements in time.

usage: graph [-h] --report-dir REPORT_DIR --history-dir HISTORY_DIR --output-dir OUTPUT_DIR --build-label BUILD_LABEL [--max-items MAX_ITEMS] [--random]

optional arguments:
  -h, --help                show this help message and exit
  --report-dir REPORT_DIR   path to xtdmake reports
  --history-dir HISTORY_DIR path to history output
  --output-dir OUTPUT_DIR   path to javascript output
  --build-label BUILD_LABEL name of current build
  --max-items MAX_ITEMS     maximum number of build to keep in graph
  --random                  internal use

Note

This tool not run automatically by XTDMake since it has no way to know when to pin a new “release”. It’s designed to be run in your continuous integration process.

Example of generated graph :