Skip to content

Update CodePathTracerRule docs to match new API #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
takahirom merged 1 commit into from
Sep 4, 2025
Merged

Update CodePathTracerRule docs to match new API #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions code-path-tracer/src/main/kotlin/io/github/takahirom/codepathtracer/CodePathTracerRule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ object DefaultFilter {
* Usage:
* ```
* @get:Rule
* val codePathTracerRule = CodePathTracerRule.builder()
* .packageIncludes("io.github.takahirom.codepathtracer")
* .methodExcludes("toString", "hashCode", "equals")
* .build()
* val codePathTracerRule = CodePathTracer.Builder()
* .filter { event -> event.className.contains("MyClass") }
* .formatter { event -> "Custom: ${event.methodName}" }
* .asJUnitRule()
*
* // Or with custom filter/formatter
* val customRule = CodePathTracerRule.builder()
* val customRule = CodePathTracer.Builder()
* .filter { event ->
* event.className.startsWith("com.example") &&
* event.depth < 5
* }
* .formatter { event ->
* "${" ".repeat(event.depth)}${event.fullMethodName}(${event.args.size})"
* }
* .build()
* .asJUnitRule()
Comment thread
takahirom marked this conversation as resolved.
* ```
*/
class CodePathTracerRule internal constructor(
Expand Down
Loading