xaizek / uncov (License: AGPLv3+) (since 2018-12-07)
Uncov(er) is a tool that collects and processes code coverage reports.
<root> / docs / uncov / 07-configuration.md (3f8fc4c46b8fdc0693673704eab90773b44b4929) (1,415B) (mode 100644) [raw]
CONFIGURATION
=============

Location and format
-------------------

Configuration is read from **\<repository-directory\>/uncov.ini** file.  If it
doesn't exist or contains invalid data (e.g., duplicated keys), default settings
remain intact.

The file has regular ini-format and can contain either comments that start with
**;** or key-value pairs like **tab-size = 2** (with or without spaces).

Values are interpreted according to types of their keys.  Keys with values that
are not convertible to corresponding types are ignored.

Available settings
------------------

Format of each entry below:

    <option> (<type>, [app:] <default value>)

    <description>

**low-bound** (floating point, 70)

Percentage boundary between low and medium coverage levels.  Normalized to be in
the [0, 100] range.  If **low-bound > hi-bound**, their values are swapped.

**hi-bound** (floating point, 90)

Percentage boundary between medium and high coverage levels.  Normalized to be
in the [0, 100] range.  If **low-bound > hi-bound**, their values are swapped.

**tab-size** (integer, 4)

Width of tabulation in spaces.

**min-fold-size** (integer, **uncov**: 3, **uncov-web**: 4)

Minimal number of lines to be folded.

**fold-context** (integer, 1)

Number of visible lines above and below changes.

**diff-show-lineno** (boolean, **uncov**: false, **uncov-web**: true)

Whether line numbers are displayed in diffs.
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/uncov

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/uncov

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master