|
| 1 | +# jacoco-method-filter — Default Rules & HowTo (Scala + Java) |
| 2 | +# |
| 3 | +# This file defines which methods should be annotated as *Generated so JaCoCo ignores them. |
| 4 | +# One rule per line. |
| 5 | +# |
| 6 | +# ───────────────────────────────────────────────────────────────────────────── |
| 7 | +# HOW TO USE (quick) |
| 8 | +# 1) Replace YOUR.PACKAGE.ROOT with your project’s package root (e.g., com.example.app). |
| 9 | +# 2) Start with the CONSERVATIVE section only. |
| 10 | +# 3) If clean, enable STANDARD. Use AGGRESSIVE only inside DTO/auto‑generated packages. |
| 11 | +# 4) Keep rules narrow (by package), prefer flags (synthetic/bridge) for compiler artifacts, |
| 12 | +# and add `id:` labels so logs are easy to read. |
| 13 | +# |
| 14 | +# ───────────────────────────────────────────────────────────────────────────── |
| 15 | +# ALLOWED SYNTAX (cheat sheet) |
| 16 | +# |
| 17 | +# General form: |
| 18 | +# <FQCN_glob>#<method_glob>(<descriptor_glob>) [FLAGS and PREDICATES...] |
| 19 | +# |
| 20 | +# FQCN_glob (dot form; $ allowed for inner classes): |
| 21 | +# Examples: *.model.*, com.example.*, * |
| 22 | +# |
| 23 | +# method_glob (glob on method name): |
| 24 | +# Examples: copy | $anonfun$* | get* | *_$eq |
| 25 | +# |
| 26 | +# descriptor_glob (JVM descriptor in (args)ret). You may omit it entirely. |
| 27 | +# • Omitting descriptor ⇒ treated as "(*)*" (any args, any return). |
| 28 | +# • Short/empty forms "", "()", "(*)" normalize to "(*)*". |
| 29 | +# Examples: |
| 30 | +# (I)I # takes int, returns int |
| 31 | +# (Ljava/lang/String;)V # takes String, returns void |
| 32 | +# () or (*) or omitted # any args, any return |
| 33 | +# |
| 34 | +# FLAGS (optional) — space or comma separated: |
| 35 | +# public | protected | private | synthetic | bridge | static | abstract |
| 36 | +# |
| 37 | +# PREDICATES (optional): |
| 38 | +# ret:<glob> # match return type only (e.g., ret:V, ret:I, ret:Lcom/example/*;) |
| 39 | +# id:<string> # identifier shown in logs/reports |
| 40 | +# name-contains:<s> # method name must contain <s> |
| 41 | +# name-starts:<s> # method name must start with <s> |
| 42 | +# name-ends:<s> # method name must end with <s> |
| 43 | +# |
| 44 | +# Notes |
| 45 | +# - Always use dot-form (com.example.Foo) for class names. |
| 46 | +# - Comments (# …) and blank lines are ignored. |
| 47 | +# |
| 48 | +# ───────────────────────────────────────────────────────────────────────────── |
| 49 | +# QUICK EXAMPLES |
| 50 | +# |
| 51 | +# Simple wildcards |
| 52 | +# *#*(*) |
| 53 | +# → Match EVERY method in EVERY class (any package). Useful only for diagnostics. |
| 54 | +# "(*)" normalizes to "(*)*" ⇒ any args, any return. |
| 55 | +# *.dto.*#*(*) |
| 56 | +# → Match every method on any class under any package segment named "dto". |
| 57 | +# Good when you treat DTOs as generated/boilerplate. |
| 58 | + |
| 59 | +# Scala case class helpers |
| 60 | +# *.model.*#copy(*) |
| 61 | +# → Matches Scala case-class `copy` methods under `*.model.*`. |
| 62 | +# Hides boilerplate clones with any parameter list and any return. |
| 63 | +# *.model.*#productArity() |
| 64 | +# → Matches zero-arg `productArity` (case-class/Product API). |
| 65 | +# *.model.*#productElement(*) |
| 66 | +# → Matches `productElement(int)` (or any descriptor form) on case classes. |
| 67 | +# *.model.*#productPrefix() |
| 68 | +# → Matches `productPrefix()`; returns the case class' constructor name. |
| 69 | + |
| 70 | +# Companion objects and defaults |
| 71 | +# *.model.*$*#apply(*) |
| 72 | +# → Matches companion `apply` factories under `*.model.*` (any args). |
| 73 | +# BE CAREFUL: can hide real factory logic; keep the package scope narrow. |
| 74 | +# *.model.*$*#unapply(*) |
| 75 | +# → Matches extractor `unapply` methods in companions under `*.model.*`. |
| 76 | +# *#*$default$*(*) |
| 77 | +# → Matches Scala-generated default-argument helpers everywhere. |
| 78 | +# Safe to keep enabled; they’re compiler-synthesized. |
| 79 | + |
| 80 | +# Anonymous / synthetic / bridge |
| 81 | +# *#$anonfun$* |
| 82 | +# → Matches any method whose name contains `$anonfun$` (Scala lambdas). |
| 83 | +# Consider adding `synthetic` and/or a package scope in real configs. |
| 84 | +# *#*(*):synthetic # any synthetic |
| 85 | +# → Matches ANY method marked `synthetic` (compiler-generated). |
| 86 | +# Powerful; scope by package to avoid hiding intentional glue code. |
| 87 | +# *#*(*):bridge # any bridge |
| 88 | +# → Matches Java generic bridge methods the compiler inserts. |
| 89 | +# Usually safe globally, but scoping is still recommended. |
| 90 | + |
| 91 | +# Setters / fluent APIs |
| 92 | +# *.dto.*#*_$eq(*) |
| 93 | +# → Matches Scala var setters in DTO packages (e.g., `name_=(...)`). |
| 94 | +# Good for excluding trivial field writes. |
| 95 | +# *.builder.*#with*(*) |
| 96 | +# → Matches builder-style fluent setters (`withXxx(...)`) in builder pkgs. |
| 97 | +# Treats chainable configuration as boilerplate. |
| 98 | +# *.client.*#with*(*) ret:Lcom/api/client/* |
| 99 | +# → Like above but ONLY when the return type matches your client package. |
| 100 | +# The `ret:` predicate protects real logic that returns other types. |
| 101 | + |
| 102 | +# Return-type constraints |
| 103 | +# *.jobs.*#*(*):ret:V |
| 104 | +# → Any method under `*.jobs.*` returning `void` (`V`). Often orchestration. |
| 105 | +# *.math.*#*(*):ret:I |
| 106 | +# → Any method under `*.math.*` returning primitive int (`I`). |
| 107 | +# *.model.*#*(*):ret:Lcom/example/model/* |
| 108 | +# → Any method under `*.model.*` that returns a type in `com.example.model`. |
| 109 | +# Handy when the *return type* uniquely identifies boilerplate. |
| 110 | + |
| 111 | +# ───────────────────────────────────────────────────────────────────────────── |
| 112 | +# GLOBALS RULES |
| 113 | +# ───────────────────────────────────────────────────────────────────────────── |
| 114 | +# ** all case class boilerplate |
| 115 | + |
| 116 | +# Scala case class helpers |
| 117 | +*#canEqual(*) id:case-canequal |
| 118 | +*#equals(*) id:case-equals |
| 119 | +*#apply(*) id:case-apply |
| 120 | +*#unapply(*) id:case-unapply |
| 121 | +*#hashCode(*) id:case-hashcode |
| 122 | +*#copy(*) id:case-copy |
| 123 | +*#copy$default$*(*) id:case-copy-defaults |
| 124 | +*#productElement() id:case-prod-element |
| 125 | +*#productArity() id:case-prod-arity |
| 126 | +*#productPrefix() id:case-prod-prefix |
| 127 | +*#productIterator() id:case-prod-iterator |
| 128 | +*#tupled() id:case-tupled |
| 129 | +*#curried() id:case-curried |
| 130 | +*#toString() id:case-tostring |
| 131 | +*#name() id:case-name |
| 132 | +*#groups() id:case-groups |
| 133 | +*#optionalAttributes() id:case-optionalAttributes |
| 134 | + |
| 135 | +# Companion objects, constructors, and static definitions |
| 136 | +*$#<init>(*) id:gen-ctor # constructors |
| 137 | +*$#<clinit>() id:gen-clinit # static initializer blocks |
| 138 | + |
| 139 | +# Companion objects and defaults |
| 140 | +*$*#apply(*) id:comp-apply |
| 141 | +*$*#unapply(*) id:comp-unapply |
| 142 | +*$*#toString(*) id:comp-tostring |
| 143 | +*$*#readResolve(*) id:comp-readresolve |
| 144 | + |
| 145 | +# anonymous class created by a macro expansion |
| 146 | +*$macro$*#$anonfun$inst$macro$* id:macro-inst |
| 147 | +*$macro$*#inst$macro$* id:macro-inst |
| 148 | + |
| 149 | +# lambda |
| 150 | +*#* synthetic name-contains:$anonfun$ id:scala-anonfun |
| 151 | + |
| 152 | +# ───────────────────────────────────────────────────────────────────────────── |
| 153 | +# DIRECT RULES |
| 154 | +# ───────────────────────────────────────────────────────────────────────────── |
0 commit comments