55 lines
2.2 KiB
Markdown
55 lines
2.2 KiB
Markdown
# rust_autobadges
|
|
  
|
|
Runs cargo-tarpaulin to generate coverage and automatically create a badges/ folder with the generated coverage.svg, test.svg and version.svg
|
|
|
|
# Usage
|
|
|
|
```
|
|
Usage: rust_autobadges [OPTIONS]
|
|
|
|
Options:
|
|
-s, --skip-clean
|
|
Skip the cargo clean that tarpaulin would run, see tarpaulin --skip-clean for more documentation
|
|
-t, --no-test
|
|
Dont generate the test:failing/passing badge
|
|
-c, --no-coverage
|
|
Don't run the coverage and dont generate the coverage:(percent) badge
|
|
-v, --no-version
|
|
Don't run the version tag check and dont generage the version:(number) badge
|
|
--version-color <VERSION_COLOR>
|
|
The color used to use on the version badge [default: orange]
|
|
--failing-color <FAILING_COLOR>
|
|
The color used to indicate failure on the test badges [default: red]
|
|
--success-color <SUCCESS_COLOR>
|
|
The color used to indicate success on the badges [default: green]
|
|
--high-coverage-color <HIGH_COVERAGE_COLOR>
|
|
The color used on a high coverage [default: green]
|
|
--mid-coverage-color <MID_COVERAGE_COLOR>
|
|
The color used on a mid coverage [default: orange]
|
|
--low-coverage-color <LOW_COVERAGE_COLOR>
|
|
The color used on a low coverage [default: red]
|
|
--high-coverage-percent <HIGH_COVERAGE_PERCENT>
|
|
The percent indicating a high coverage [default: 1]
|
|
--mid-coverage-percent <MID_COVERAGE_PERCENT>
|
|
The percent indicating a mid coverage [default: 0.8]
|
|
-o, --output <OUTPUT>
|
|
The output directory where all the badges will be saved [default: badges]
|
|
-h, --help
|
|
Print help
|
|
-V, --version
|
|
Print version
|
|
```
|
|
|
|
# Future Features
|
|
* Only run tests
|
|
* Clean the badges folder
|
|
* Have a better indication of the actions of tarpaulin run
|
|
* (optionnal) Save info of the previous run to allow a progress bar
|
|
|
|
# TODO
|
|
* Better error handling
|
|
* Structs to allow centralisation of pb/error handling/.close()
|
|
* Better alignment
|
|
* (consideration) A config file to avoid passing so many arguments and have a better CI
|
|
* Having a coverage above 0% ? (even if testing something that runs tests require some smart)
|