redacted-compiler-plugin

A multiplatform Kotlin compiler plugin that generates redacted

toString()

Inspired by the

auto-value-redacted

Usage

Include the gradle plugin in your project, define a

@Redacted

@Retention(SOURCE)
@Target(PROPERTY)
annotation class Redacted

data class User(val name: String, @Redacted val phoneNumber: String)

When you call

toString()

@Redacted

User(name=Bob, phoneNumber=██)

If your annotation is applied to the class, then

toString()

@Retention(SOURCE)
@Target(CLASS)
annotation class Redacted

@Redacted
data class SensitiveData(val ssn: String, val birthday: String)

SensitiveData(██)

Installation

Apply the gradle plugin.

plugins {
  id("dev.zacsweers.redacted") version 
}

And that's it! The default configuration will add the multiplatform

-annotations

@Redacted

You can configure custom behavior with properties on the

redacted

redacted {
  // Define a custom annotation. The -annotations artifact won't be automatically added to
  // dependencies if you define your own!
  redactedAnnotation = "dev.zacsweers.redacted.annotations.Redacted" // Default

  // Define whether or not this is enabled. Useful if you want to gate this behind a dynamic
  // build configuration.
  enabled = true // Default
  // Define a custom replacement string for redactions.
  replacementString = "██" // Default
}

Snapshots of the development version are available in Sonatype's

snapshots

Supported platforms

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.

Caveats

• Kotlin compiler plugins are not a stable API! Compiled outputs from this plugin should be stable, but usage in newer versions of kotlinc are not guaranteed to be stable.
• IDE support is not currently possible. See #8.

License

Copyright (C) 2018 Zac Sweers

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
   http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.