refactor: add replaceWith field in Compatibility annotation

lppedd · Nov 10, 2020 · d4dbb5e · d4dbb5e
1 parent 3d163d0
commit d4dbb5e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/main/kotlin/com/github/lppedd/cc/CCExtensions.kt b/src/main/kotlin/com/github/lppedd/cc/CCExtensions.kt
@@ -36,7 +36,10 @@ import kotlin.math.min
 
 // region LookupImpl
 
-@Compatibility(minVersionForRemoval = "193.5096.12")
+@Compatibility(
+ minVersionForRemoval = "193.5096.12",
+ replaceWith = "LookupImpl#setLookupFocusDegree(LookupFocusDegree)",
+)
 internal fun LookupImpl.setLookupFocusDegree(focusDegree: String) {
  // Unfortunately this is required to maintain compatibility with versions prior to 193.5096.
  // setLookupFocusDegree and LookupFocusDegree don't exist in those versions.

diff --git a/src/main/kotlin/com/github/lppedd/cc/annotation/Compatibility.kt b/src/main/kotlin/com/github/lppedd/cc/annotation/Compatibility.kt
@@ -13,5 +13,11 @@ internal annotation class Compatibility(
  * The minimum supported IDE version that is required
  * for removing the annotated element.
  */
- val minVersionForRemoval: String,
+ val minVersionForRemoval: String = "?",
+
+ /**
+ * A suggestion for replacing the annotated element
+ * when it's time to remove it.
+ */
+ val replaceWith: String = "",
 )