Private API

This page lists non-exported (internal) symbols of CoveragePostprocessing.


From CoveragePostprocessing

_clean_stale_cov_files!

CoveragePostprocessing._clean_stale_cov_files!Function
_clean_stale_cov_files!(source_dirs)

Internal helper that removes stale .cov files from source_dirs.

If multiple runs are detected (PID suffix in filenames), this function keeps the PID with the largest number of .cov files and removes the others.

_collect_and_move_cov_files!

CoveragePostprocessing._collect_and_move_cov_files!Function
_collect_and_move_cov_files!(source_dirs, dest_dir) -> Vector{String}

Internal helper that moves all .cov files from source_dirs into dest_dir.

Returns a vector of destination paths for the moved files.

_count_cov_files

_generate_coverage_reports!

CoveragePostprocessing._generate_coverage_reports!Function
_generate_coverage_reports!(source_dirs, coverage_dir, root_dir, worst_n_files, max_uncovered_lines)

Internal helper that generates coverage reports from .cov files.

Arguments

  • source_dirs::Vector{String}: Directories to scan for .cov files.
  • coverage_dir::String: Destination directory for reports.
  • root_dir::String: Project root directory for path resolution.
  • worst_n_files::Int: Maximum number of lowest-covered files to list in the report.
  • max_uncovered_lines::Int: Maximum number of uncovered lines to display in the report.

Writes:

  • coverage/lcov.info
  • coverage/cov_report.md

_get_pid_suffix

CoveragePostprocessing._get_pid_suffixFunction
_get_pid_suffix(cov_file_path) -> String

Internal helper that extracts the PID suffix from a .cov file path.

Arguments

  • cov_file_path::String: Path to a .cov file (e.g., src/foo.jl.12345.cov)

Returns

  • String: The PID suffix (e.g., "12345"), or empty string if no suffix found.

_reset_coverage_dir

CoveragePostprocessing._reset_coverage_dirFunction
_reset_coverage_dir(coverage_dir, cov_storage_dir)

Internal helper that recreates the coverage/ directory structure.

This function removes coverage_dir (recursively) if it already exists, then creates cov_storage_dir.