dlcov 4.0.0
dlcov: ^4.0.0 copied to clipboard
A CLI to add code coverage threshold (CI/CD, git hooks, etc.)
DLCOV - CLI to verify code coverage threshold (CI/CD, git hooks, etc.) #
Usage Example #
dlcov --coverage=80 --include-untested-files=true --lcov-gen="flutter test --coverage" --log=true
The command above does:
--coverage=80
Check if code coverage threshold is equal or greater than 80.0%--include-untested-files=true
Generate references to untested files (defalt equals "true")--lcov-gen="flutter test --coverage"
Generatelcov.info
through the command "flutter test --coverage", it can be used with "test_cov" for dart only for example, or others if you prefer.--log=true
Log every test coverage info in dlcov.log - Limit up to 1000 lines
Install #
pub global activate dlcov
or add as dev dependency to pubspec.yaml
dev_dependencies:
dlcov: 4.0.0
Uses
dlcov
, pub run dlcov
or pub global run dlcov
Verify if code coverage threshold is equal or greater than 80.0%
dlcov gen-refs && flutter test --coverage && dlcov -c 80
dlcov -c 80 --lcov-gen="flutter test --coverage"
dlcov -c 80 --lcov-gen="test_cov"
Parameters availables #
Long | Short | Mandatory | Default | Sample | Description |
---|---|---|---|---|---|
--coverage | -c | false | 0 | 80.0 | min coverage threshold |
--log | -l | false | false | true | Log every test coverage info in dlcov.log - Limit up to 1000 lines |
--exclude-suffix | -e | false | .g.dart,.freezed.dart | .g.dart | Remove generated or other files from test coverage results, separated by commas |
--include-untested-files | false | true | true | Get reports more coherent with reality, and do not ignore untested files during the analysis | |
--lcov-gen | false | "flutter test --coverage" | Generate lcov.info through the command "flutter test --coverage", it can be used with "test_cov" for dart only for example, or others if you prefer |
Command | Description |
---|---|
gen-refs | Generate tested and untested file references, it should be used before lcov.info file generation step. |
Github actions #
if the test coverage is less than 80, it stop the pipeline here, and abort the actions