Exclude files which are excluded by jacoco (#21)

* version bump

* wip

* Make tests work at least

* Cleaning up tests even further

* WIP

* WIP

* Improving coverage

* WIP

* Optimize imports

* reformat

* Fix only knowing the last projects exclusions.

* WIP

* Exclude all generated code by default.

* All tests are working again now

* All tests are working again now

* Improved coverage a tiny bit.

* reformat/optimize

* Updated README.md

* Adding some other test for increasing the branch coverage

* Trying to improve coverage for these branches.

* Improving code coverage

* reformat

---------

Co-authored-by: Steven Van Ingelgem <[email protected]>

Author: svaningelgem

.github/dependabot.yml

@@ -9,7 +9,7 @@ updates:
     ignore:
       # Ignore patch updates for Maven plugins to reduce noise
       - dependency-name: "org.apache.maven.plugins:*"
-        update-types: ["version-update:semver-patch"]
+        update-types: [ "version-update:semver-patch" ]
 
   - package-ecosystem: "github-actions"
     directory: "/"

README.md

@@ -1,8 +1,10 @@
 # JaCoCo Console Reporter Maven Plugin
 
-A custom Maven plugin that generates a textual tree-like coverage report from JaCoCo's execution data files, displaying coverage metrics (Class %, Method %, Branch %, Line %) for packages, source files, and the entire project.
+A custom Maven plugin that generates a textual tree-like coverage report from JaCoCo's execution data files, displaying
+coverage metrics (Class %, Method %, Branch %, Line %) for packages, source files, and the entire project.
 
 ## Features
+
 - Reads coverage data from `jacoco.exec` files
 - Analyzes class files from the project's build output directory
 - Outputs a hierarchical console-based report with coverage metrics
@@ -12,14 +14,19 @@ A custom Maven plugin that generates a textual tree-like coverage report from Ja
 - Automatic scanning for `jacoco.exec` files across modules
 - Support for custom JaCoCo execution file patterns
 - Combined weighted coverage score based on customizable weights
+- Exclude target directory to ignore generated files
 
 ## Prerequisites
+
 - Maven 3.x
 - JaCoCo plugin configured in your project to generate `jacoco.exec`
 
 ## Installation
+
 Add the plugin to your project's pom.xml:
+
 ```xml
+
 <build>
     <plugins>
         <plugin>
@@ -40,7 +47,9 @@ Add the plugin to your project's pom.xml:
 ```
 
 ## Usage
+
 Run the plugin after tests:
+
 ```bash
 mvn verify
 ```
@@ -49,23 +58,25 @@ Ensure the JaCoCo plugin has executed beforehand to generate jacoco.exec.
 
 ## Configuration
 
-| Parameter             | Description                                               | Default Value                            |
-|-----------------------|-----------------------------------------------------------|------------------------------------------|
-| `jacocoExecFile`      | Path to the JaCoCo execution data file                    | `${project.build.directory}/jacoco.exec` |
-| `classesDirectory`    | Directory containing compiled classes                     | `${project.build.outputDirectory}`       |
-| `deferReporting`      | Defer reporting until the end (for multi-module projects) | `true`                                   |
-| `showFiles`           | Whether to show individual source files in the report     | `false`                                  |
-| `showTree`            | Whether to show the tree structure in the report          | `true`                                   |
-| `showSummary`         | Whether to show the summary information                   | `true`                                   |
-| `scanModules`         | Automatically scan for exec files in project modules      | `false`                                  |
-| `baseDir`             | Base directory for module scanning                        | `${project.basedir}`                     |
-| `additionalExecFiles` | Additional exec files to include in the report            | `[]`                                     |
-| `weightClassCoverage` | Weight for class coverage in combined score               | `0.1`                                    |
-| `weightMethodCoverage`| Weight for method coverage in combined score              | `0.1`                                    |
-| `weightBranchCoverage`| Weight for branch coverage in combined score              | `0.4`                                    |
-| `weightLineCoverage`  | Weight for line coverage in combined score                | `0.4`                                    |
+| Parameter                     | Description                                               | Default Value                            |
+|-------------------------------|-----------------------------------------------------------|------------------------------------------|
+| `jacocoExecFile`              | Path to the JaCoCo execution data file                    | `${project.build.directory}/jacoco.exec` |
+| `classesDirectory`            | Directory containing compiled classes                     | `${project.build.outputDirectory}`       |
+| `deferReporting`              | Defer reporting until the end (for multi-module projects) | `true`                                   |
+| `showFiles`                   | Whether to show individual source files in the report     | `false`                                  |
+| `showTree`                    | Whether to show the tree structure in the report          | `true`                                   |
+| `showSummary`                 | Whether to show the summary information                   | `true`                                   |
+| `scanModules`                 | Automatically scan for exec files in project modules      | `false`                                  |
+| `baseDir`                     | Base directory for module scanning                        | `${project.basedir}`                     |
+| `additionalExecFiles`         | Additional exec files to include in the report            | `[]`                                     |
+| `weightClassCoverage`         | Weight for class coverage in combined score               | `0.1`                                    |
+| `weightMethodCoverage`        | Weight for method coverage in combined score              | `0.1`                                    |
+| `weightBranchCoverage`        | Weight for branch coverage in combined score              | `0.4`                                    |
+| `weightLineCoverage`          | Weight for line coverage in combined score                | `0.4`                                    |
+| `ignoreFilesInBuildDirectory` | Ignore autogenerated files in build directory             | `true`                                   |
 
 ## Default Output
+
 ```text
 [INFO] Overall Coverage Summary
 [INFO] Package                                    │ Class, %         │ Method, %        │ Branch, %        │ Line, %
@@ -85,6 +96,7 @@ Ensure the JaCoCo plugin has executed beforehand to generate jacoco.exec.
 ```
 
 ## Output with all options on
+
 ```text
 [INFO] Overall Coverage Summary
 [INFO] Package                                    │ Class, %         │ Method, %        │ Branch, %        │ Line, %
@@ -119,6 +131,7 @@ This will wait with generating the report until the last module in the build.
 If your JaCoCo plugin uses a non-default location for the execution data file:
 
 ```xml
+
 <plugin>
     <groupId>io.github.svaningelgem</groupId>
     <artifactId>jacoco-console-reporter</artifactId>
@@ -135,6 +148,7 @@ If your JaCoCo plugin uses a non-default location for the execution data file:
 You can configure which parts of the report are displayed:
 
 ```xml
+
 <plugin>
     <groupId>io.github.svaningelgem</groupId>
     <artifactId>jacoco-console-reporter</artifactId>
@@ -156,6 +170,7 @@ You can configure which parts of the report are displayed:
 You can adjust the weights used to calculate the combined coverage score:
 
 ```xml
+
 <plugin>
     <groupId>io.github.svaningelgem</groupId>
     <artifactId>jacoco-console-reporter</artifactId>
@@ -170,6 +185,56 @@ You can adjust the weights used to calculate the combined coverage score:
 </plugin>
 ```
 
+### Excluding Files from Coverage
+
+The plugin supports excluding specific files or packages from coverage reports. There are two ways to configure
+exclusions:
+
+1. **Using JaCoCo Exclusions**: The plugin automatically respects exclusion patterns defined in your JaCoCo plugin
+   configuration:
+
+   ```xml
+   <plugin>
+       <groupId>org.jacoco</groupId>
+       <artifactId>jacoco-maven-plugin</artifactId>
+       <configuration>
+           <excludes>
+               <exclude>com/example/generated/**/*</exclude>
+               <exclude>**/*Controller.class</exclude>
+               <exclude>com/example/model/*</exclude>
+           </excludes>
+       </configuration>
+   </plugin>
+   ```
+
+2. **Automatically Exclude Build Directory Files**: By default, the plugin will ignore files in the build directory,
+   which are typically auto-generated. You can disable this with:
+
+   ```xml
+   <plugin>
+       <groupId>io.github.svaningelgem</groupId>
+       <artifactId>jacoco-console-reporter</artifactId>
+       <configuration>
+           <ignoreFilesInBuildDirectory>false</ignoreFilesInBuildDirectory>
+       </configuration>
+   </plugin>
+   ```
+
+#### Exclusion Pattern Syntax
+
+The exclusion pattern for JaCoCo is:
+
+- `*` matches any character except path separators
+- `**` matches any directory
+- File paths use `/` as separator regardless of the operating system
+- Patterns without the `.class` suffix will automatically match class files
+
+For example:
+
+- `com/example/model/*` - Excludes all files directly in the model package
+- `com/example/generated/**/*` - Excludes all files in generated and its subpackages
+- `**/*Controller.class` - Excludes all files ending with "Controller.class" in any package
+
 ## Implementation Details
 
 The plugin works by:
@@ -181,6 +246,7 @@ The plugin works by:
 5. Calculating coverage metrics (class, method, branch, line) for each node
 6. Generating a tree-like report to the console
 7. Computing a weighted combined coverage score
+8. Applying exclusion patterns to filter out specific files or packages
 
 ## Contributing
 

docs/gpg.md

@@ -1,15 +1,17 @@
-
-
-
 ## Generate keys
+
 ```bash
 gpg --gen-key
 ```
+
 ## List them
+
 ```bash
 gpg --list-keys
 ```
+
 Output is like:
+
 ```text
 $ gpg --list-secret-keys --keyid-format=long
 /home/steven/.gnupg/pubring.kbx
@@ -21,29 +23,37 @@ ssb   rsa3072/3D2ADE7187466D99 2025-02-22 [E] [expires: 2027-02-22]
 ```
 
 ## Upload them
+
 ```bash
 gpg --keyserver keyserver.ubuntu.com --send-keys 99CEEF7F4D5085C2
 ```
 
 ## Show the public key
+
 ```bash
 gpg --armor --export 99CEEF7F4D5085C2
 ```
+
 Output:
+
 ```text
 -----BEGIN PGP PUBLIC KEY BLOCK-----
 [...]
 -----END PGP PUBLIC KEY BLOCK-----
 ```
 
 ## Set the GPG key in your github profile
+
 URL: https://github.com/settings/keys
 
 ## Export the private key
+
 ```bash
 gpg --armor --export-secret-key [email protected]
 ```
+
 Output:
+
 ```text
 -----BEGIN PGP PRIVATE KEY BLOCK-----
 [...]

jacoco-console-reporter/src/main/java/io/github/svaningelgem/CharsetDetector.java

@@ -10,7 +10,8 @@
 public class CharsetDetector {
     static CharsetDetector instance = null;
 
-    private CharsetDetector() { }
+    private CharsetDetector() {
+    }
 
     public static CharsetDetector getInstance() {
         if (instance == null) {

jacoco-console-reporter/src/main/java/io/github/svaningelgem/Defaults.java

@@ -23,6 +23,7 @@ public class Defaults {
     final String divider;
 
     static Defaults instance = null;
+
     public static Defaults getInstance() {
         if (instance == null) {
             instance = new Defaults();
@@ -71,6 +72,6 @@ public Defaults(Charset currentCharset) {
     @NotNull String formatCoverage(double covered, double total) {
         if (total <= 0) return " ***** (0/0)";
         double percentage = covered / total * 100;
-        return String.format("%5.2f%% (%d/%d)", percentage, (int)covered, (int)total);
+        return String.format("%5.2f%% (%d/%d)", percentage, (int) covered, (int) total);
     }
 }

jacoco-console-reporter/src/main/java/io/github/svaningelgem/DirectoryNode.java

@@ -43,8 +43,8 @@ public boolean shouldInclude() {
         return !sourceFiles.isEmpty() || subdirectories.values().stream().anyMatch(DirectoryNode::shouldInclude);
     }
 
-    private <T extends FileSystemNode> void printNodes(org.apache.maven.plugin.logging.Log log, String prefix,
-                            String format, String packagePath, boolean showFiles, @NotNull List<T> nodes, boolean extraCheck) {
+    <T extends FileSystemNode> void printNodes(org.apache.maven.plugin.logging.Log log, String prefix,
+                                               String format, String packagePath, boolean showFiles, @NotNull List<T> nodes, boolean extraCheck) {
         for (int i = 0; i < nodes.size(); i++) {
             boolean isLast = (i == nodes.size() - 1) && extraCheck;
             FileSystemNode node = nodes.get(i);
@@ -53,13 +53,12 @@ private <T extends FileSystemNode> void printNodes(org.apache.maven.plugin.loggi
         }
     }
 
-    private @NotNull String determineNewPrefix(@NotNull String oldPrefix, boolean isLast) {
+    @NotNull String determineNewPrefix(@NotNull String oldPrefix, boolean isLast) {
         String prefix = oldPrefix;
 
         if (prefix.endsWith(Defaults.getInstance().corner)) {
             prefix = prefix.substring(0, prefix.length() - Defaults.getInstance().corner.length()) + Defaults.getInstance().lastDirSpace;
-        }
-        else if (prefix.endsWith(Defaults.getInstance().tee)) {
+        } else if (prefix.endsWith(Defaults.getInstance().tee)) {
             prefix = prefix.substring(0, prefix.length() - Defaults.getInstance().tee.length()) + Defaults.getInstance().verticalLine;
         }