Merge pull request 'Small improvements' (#44) from smaller-improvements into main

Reviewed-on: #44

README.md

@@ -56,6 +56,7 @@ already, install the `llvm-tools-preview`:
 
 ```sh
 rustup component add llvm-tools-preview
+cargo install grcov --locked
 ```
 
 After that, you can simply run `coverage.py` to test the project with coverage. You can optionally

coverage.py

@@ -7,16 +7,26 @@ import webbrowser
 
 _LOGGER = logging.getLogger()
 
-def generate_cov_report(open_report: bool):
+
+def generate_cov_report(open_report: bool, format: str):
     logging.basicConfig(level=logging.INFO)
     os.environ["RUSTFLAGS"] = "-Cinstrument-coverage"
     os.environ["LLVM_PROFILE_FILE"] = "target/coverage/%p-%m.profraw"
     _LOGGER.info("Executing tests with coverage")
     os.system("cargo test")
+
+    out_path = "./target/debug/coverage"
+    if format == "lcov":
+        out_path = "./target/debug/lcov.info"
     os.system(
-        "grcov . -s . --binary-path ./target/debug/ -t html --branch --ignore-not-existing "
-        "-o ./target/debug/coverage/"
+        f"grcov . -s . --binary-path ./target/debug/ -t {format} --branch --ignore-not-existing "
+        f"-o {out_path}"
     )
+    if format == "lcov":
+        os.system(
+            "genhtml -o ./target/debug/coverage/ --show-details --highlight --ignore-errors source "
+            "--legend ./target/debug/lcov.info"
+        )
     if open_report:
         coverage_report_path = os.path.abspath("./target/debug/coverage/index.html")
         webbrowser.open_new_tab(coverage_report_path)
@@ -30,8 +40,14 @@ def main():
     parser.add_argument(
         "--open", action="store_true", help="Open the coverage report in a browser"
     )
+    parser.add_argument(
+        "--format",
+        choices=["html", "lcov"],
+        default="html",
+        help="Choose report format (html or lcov)",
+    )
     args = parser.parse_args()
-    generate_cov_report(args.open)
+    generate_cov_report(args.open, args.format)
 
 
 if __name__ == "__main__":