feature-flag-remover

Let's remove unused feature flag-related code!

This repository provides only the core API (annotations). The actual removal logic is implemented in the Plugin repository.

Requirement

• Kotlin 2.2.21+
• Java 21+
• Gradle 9.2+

Setup

plugins {
  kotlin("jvm") version "2.2.21"
  id("io.github.t45k.feature-flag-remover") version "1.0.2"
}

repositories {
  mavenCentral()
  // Add Jitpack as the API is distributed via Jitpack
  maven { url = uri("https://jitpack.io") }
}

dependencies {
  implementation("com.github.t45k:feature-flag-remover:1.0.2")
}

Note on Jitpack: You must add the jitpack.io URL to your repositories block because feature-flag-remover API is distributed via Jitpack.

Usage

There are two annotations to mark removing targets; RemoveAfterRelease and RemoveElseClauseAfterRelease.

RemoveAfterRelease

Please use RemoveAfterRelease to remove the entire target statement.

fun main() {
    @RemoveAfterRelease("feature")
    val isReleased = true

    // You want to remove this entire if-statement
    @RemoveAfterRelease("feature")
    if (!isRelease) {
        beforeRelease() // You want to call beforeReleases instead of afterRelease until the feature is release
        return
    }

    // You need this afterRelease call after release
    afterRelease()
}

This will be

fun main() {
    // You need this afterRelease call after release
    afterRelease()
}

You can use multiple feature names in a signle annotation when the target is required by all the multiple features.

fun main() {
    @RemoveAfterRelease("feature", "feature2")
    val isReleased = true
}

When execute feature feature flag removal, this code will be

fun main() {
    @RemoveAfterRelease("feature2")
    val isReleased = true
}

RemoveElseClauseAfterRelease

Please use RemoveAfterRelease when you want to remove else-clause of annotated if-statement though keeping then-clause.

fun main() {
    @RemoveAfterRelease("feature")
    val isReleased = true

    // You want to keep then-clause
    @RemoveElseClausAfterRelease("feature")
    if (isRelease) {
        afterRelease()
    } else {
        beforeRelease()
    }
}

This will be

fun main() {
    afterRelease()
}

Execute removal

You can execute by ./gradlew removeFeatureFlag --feature feature_name --no-configuration-cache command. Currently, this command doesn't support configuration cache.

you can refer to test code