Add warning to not implement sprout-generated visitor interfaces (#1413)

partiql · Apr 4, 2024 · 679af95 · 679af95 · github-actions · Apr 5, 2024
1 parent d059c81
commit 679af95
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,8 @@ Thank you to all who have contributed!
 ## [Unreleased]
 
 ### Added
+- partiql-ast: adds warning not to implement `AstVisitor` interface directly. Please extend `AstBaseVisitor` instead.
+- partiql-plan: adds warning not to implement `PlanVisitor` interface directly. Please extend `PlanBaseVisitor` instead.
 
 ### Changed
 - Change `StaticType.AnyOfType`'s `.toString` to not perform `.flatten()`

diff --git a/...out/src/main/kotlin/org/partiql/sprout/generator/target/kotlin/poems/KotlinVisitorPoem.kt b/...out/src/main/kotlin/org/partiql/sprout/generator/target/kotlin/poems/KotlinVisitorPoem.kt
@@ -183,6 +183,7 @@ class KotlinVisitorPoem(symbols: KotlinSymbols) : KotlinPoem(symbols) {
                     addFunction(visit)
                 }
             }
+            .addKdoc("WARNING: This interface should not be implemented or extended by code outside of this library. Please extend [$baseVisitorName].")
             .build()
         return FileSpec.builder(visitorPackageName, visitorName).addType(visitor).build()
     }