Need help with redacted-compiler-plugin?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

ZacSweers
208 Stars 17 Forks Apache License 2.0 89 Commits 3 Opened issues

Description

A Kotlin compiler plugin that generates redacted toString() implementations.

Services available

!
?

Need anything else?

Contributors list

# 4,283
uber
reddit
archite...
hackern...
84 commits
# 231,300
picker-...
Kotlin
compile...
Gradle
2 commits
# 69,878
Shell
Android
Groovy
imagelo...
1 commit
# 106,747
Java
Shell
Android
Kotlin
1 commit
# 460,085
Kotlin
kotlin-...
spannab...
Android
1 commit

redacted-compiler-plugin

A multiplatform Kotlin compiler plugin that generates redacted

toString()
implementations.

Inspired by the

auto-value-redacted
extension for AutoValue.

Usage

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(██)

Installation

Apply the gradle plugin.

plugins {
  id("dev.zacsweers.redacted") 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 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
repository.

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.