Accept --doctests for show-env and report

nextest-rs/nextest#1080 (comment)

CHANGELOG.md

@@ -10,6 +10,8 @@ Note: In this file, do not use the hard wrap in the middle of a sentence for com
 
 ## [Unreleased]
 
+- Support `--doctests` flag in `cargo llvm-cov report` and `cargo llvm-cov show-env`.
+
 ## [0.5.35] - 2023-10-18
 
 - Improve compile time.

README.md

@@ -412,6 +412,8 @@ cargo llvm-cov --no-report --features b
 cargo llvm-cov report --lcov # generate report without tests
 ```
 
+Note: To include coverage for doctests you also need to pass `--doctests` to `cargo llvm-cov report`.
+
 ### Get coverage of C/C++ code linked to Rust library/binary
 
 Set `CC`, `CXX`, `LLVM_COV`, and `LLVM_PROFDATA` environment variables to Clang/LLVM compatible with the LLVM version used in rustc, and run cargo-llvm-cov with `--include-ffi` flag.
@@ -445,6 +447,8 @@ cargo llvm-cov report --lcov # Generate report without tests.
 
 Note: cargo-llvm-cov subcommands other than `report` and `clean` may not work correctly in the context where environment variables are set by `show-env`; consider using normal `cargo`/`cargo-nextest` commands.
 
+Note: To include coverage for doctests you also need to pass `--doctests` to both `cargo llvm-cov show-env` and `cargo llvm-cov report`.
+
 ### Exclude file from coverage
 
 To exclude specific file patterns from the report, use the `--ignore-filename-regex` option.

docs/cargo-llvm-cov-report.txt

@@ -104,6 +104,12 @@ OPTIONS:
         --include-build-script
             Include build script in coverage report
 
+        --doctests
+            Including doc tests (unstable)
+
+            This flag is unstable. See <https://github.com/taiki-e/cargo-llvm-cov/issues/2> for
+            more.
+
     -q, --quiet
             Display one character per test instead of one line
 

src/cli.rs

@@ -510,6 +510,7 @@ impl Args {
             let flag = if doc { "--doc" } else { "--doctests" };
             match subcommand {
                 Subcommand::None | Subcommand::Test => {}
+                Subcommand::ShowEnv | Subcommand::Report if doctests => {}
                 Subcommand::Nextest => bail!("doctest is not supported for nextest"),
                 _ => unexpected(flag, subcommand)?,
             }

tests/test.rs

@@ -313,10 +313,12 @@ fn invalid_arg() {
                     .arg("--doc")
                     .assert_failure()
                     .stderr_contains("invalid option '--doc'");
-                cargo_llvm_cov(subcommand)
-                    .arg("--doctests")
-                    .assert_failure()
-                    .stderr_contains("invalid option '--doctests'");
+                if subcommand != "show-env" {
+                    cargo_llvm_cov(subcommand)
+                        .arg("--doctests")
+                        .assert_failure()
+                        .stderr_contains("invalid option '--doctests'");
+                }
             }
         }
         if !matches!(subcommand, "" | "nextest") {