Generates redacted `toString()` implementations for classes, allowing selective property redaction via a `@Redacted` annotation. Supports custom annotations and replacement strings, enabling flexible redaction configurations.
A multiplatform Kotlin compiler plugin that generates redacted toString() implementations.
Inspired by the auto-value-redacted extension for AutoValue.
Include the gradle plugin in your project, define a @Redacted annotation, and apply it to any
properties that you wish to redact.
@Retention(SOURCE)
@Target(PROPERTY)
annotation class Redacted
data class User(val name: String, @Redacted val phoneNumber: String)
When you call toString() any @Redacted properties are hidden:
User(name=Bob, phoneNumber=██)
If your annotation is applied to the class, then toString() will emit a single replacement string:
@Retention(SOURCE)
@Target(CLASS)
annotation class Redacted
@Redacted
data class SensitiveData(val ssn: String, val birthday: String)
SensitiveData(██)
Apply the gradle plugin.
plugins {
id("dev.zacsweers.redacted") version <version>
}
And that's it! The default configuration will add the multiplatform -annotations artifact (which has a
@Redacted annotation you can use) and wire it all automatically. Just annotate what you want to
redact.
You can configure custom behavior with properties on the redacted extension.
redacted {
// Define custom annotations. The -annotations artifact won't be automatically added to
// dependencies if you define your own!
// Note that these must be in the format of a string where packages are delimited by '/' and
// classes by '.', e.g. "kotlin/Map.Entry"
redactedAnnotations.add("dev/zacsweers/redacted/annotations/Redacted")
unredactedAnnotations.add()
enabled =
replacementString =
}
Snapshots of the development version are available in Sonatype's snapshots repository.
The compiler plugin itself supports all multiplatform project types. The first-party annotations artifact is also multiplatform and supports all common JVM, JS, and native targets.
FIR diagnostics can render in the IDE under the following conditions:
kotlin.k2.only.bundled.compiler.plugins.enabled registry key must be set to false.In situations where it is desirable to redact everything and opt-out on certain properties, two options are provided:
Class redaction
For one-off classes that may contain a large number of fields that should be redacted, you can augment the @Redacted
class behavior:
@Redacted
data class User(@Unredacted val name: String, val phoneNumber: String, val ssn: String)
User(name=Bob, phoneNumber=██, ssn=██)
Supertype redaction
For situations where you need to enforce that an API only accepts redacted inputs, you can apply @Redacted to a
parent interface.
@Redacted
interface RedactedObject
data class User(@Unredacted val name: String, val phoneNumber: String, val ssn: String) : RedactedObject
User(name=Bob, phoneNumber=██, ssn=██)
Copyright (C) 2018 Zac Sweers
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
https:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
Surfaced from shared tags and platforms — no rankings paid for.