Custom Report
=============

Generate Custom Report
----------------------

.. code-block:: console

    verissimo.sh <COMPILATION ARGS> <RULESET ARGS> [<RULESET FILTER ARGS>] [<LINT ARGS>] [<BASELINE ARGS>] [<EXIT CODE ARGS>] [<AUTOCORRECT ARGS>] <CUSTOM REPORT ARGS>

Arguments Description
~~~~~~~~~~~~~~~~~~~~~

.. include:: compilation-args.rst

.. include:: ruleset-args.rst

.. include:: ruleset-filter-args.rst

.. include:: lint-args.rst

.. include:: baseline-args.rst

.. include:: exit-code-args.rst

.. include:: autocorrect-args.rst

.. include:: custom-report-args.rst

Examples
~~~~~~~~

-  Generate a custom report from a custom template ftl file:

.. code-block::

   verissimo.sh -cmd .dvt/default.build -all -gen_custom_report custom_report.txt.ftl

- Generate a custom report using a predefined template:

.. code-block::

    verissimo.sh -cmd .dvt/default.build -all -gen_custom_report FAILURES_TEXT

Generate Custom Report from HTML Report
---------------------------------------

.. code-block:: console

    verissimo.sh <HTML REPORT LOCATION ARGS> | <MERGE ARGS> | <DIFF ARGS> | <COMPARE ARGS> [<EXIT CODE ARGS>] <CUSTOM REPORT ARGS>

Arguments Description
~~~~~~~~~~~~~~~~~~~~~

HTML Report Location Arguments
""""""""""""""""""""""""""""""

.. code-block:: console
    :caption: <HTML REPORT LOCATION ARGS>

    -html_report_location <dir>

.. code-block:: console
    :caption: <HTML REPORT LOCATION ARGS> Description

    -html_report_location <dir>        Destination directory for the HTML lint report.

.. include:: exit-code-args.rst

.. include:: merge-args.rst

.. include:: diff-args.rst

.. include:: compare-args.rst

.. include:: custom-report-args.rst

Examples
~~~~~~~~

-  Generate a custom report from a HTML report using a predefined template:

.. code-block::

    verissimo.sh -html_report_location report_location -gen_custom_report FAILURES_TEXT

-  Generate a custom report from the result of a diff operation between HTML reports:

.. code-block::

    verissimo.sh -diff /path/to/report1/verissimo_html_report -diff /path/to/report2/verissimo_html_report report_location -gen_custom_report custom_report.txt.ftl

Generate Custom Report Template
-------------------------------

.. code-block:: console

    verissimo.sh <CUSTOM REPORT TEMPLATE ARGS>

Arguments Description
~~~~~~~~~~~~~~~~~~~~~

.. include:: custom-report-template-args.rst

Examples
~~~~~~~~

-  Generate a predefined custom report template:

.. code-block::

    verissimo.sh -gen_custom_report_ftl AUTOCORRECT_EDITS_TEXT