Skip to content

[compiler] Allow empty deprecationReasons #6729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 6, 2025
Merged

[compiler] Allow empty deprecationReasons #6729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7803195
Allow empty descriptions and/or deprecationReasons
martinbonnin Oct 3, 2025
219f21a
Keep descriptions untouched
martinbonnin Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion libraries/apollo-ast/src/commonMain/kotlin/com/apollographql/apollo/ast/SDLWriter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ open class SDLWriter(
}

internal fun SDLWriter.writeDescription(description: String?) {
if (!description.isNullOrBlank()) {
if (description != null) {
write("\"\"\"${description.encodeToGraphQLTripleQuoted()}\"\"\"\n")
}
}
Expand Down
11 changes: 4 additions & 7 deletions ...lo-compiler/src/main/kotlin/com/apollographql/apollo/compiler/codegen/java/helpers/Doc.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
package com.apollographql.apollo.compiler.codegen.java.helpers


import com.apollographql.apollo.compiler.internal.applyIf
import com.apollographql.apollo.compiler.codegen.java.JavaClassNames
import com.apollographql.apollo.compiler.codegen.java.L
import com.apollographql.apollo.compiler.codegen.java.S
import com.apollographql.apollo.compiler.internal.applyIf
import com.apollographql.apollo.compiler.ir.IrEnum
import com.squareup.javapoet.AnnotationSpec
import com.squareup.javapoet.FieldSpec
import com.squareup.javapoet.MethodSpec
import com.squareup.javapoet.TypeSpec
Expand All @@ -28,21 +25,21 @@ internal fun FieldSpec.Builder.maybeAddDescription(description: String?): FieldS
}

internal fun TypeSpec.Builder.maybeAddDeprecation(deprecationReason: String?): TypeSpec.Builder {
if (deprecationReason.isNullOrBlank()) {
if (deprecationReason == null) {
return this
}

return addJavadoc("$L\n", deprecationReason).addAnnotation(deprecatedAnnotation())
}

internal fun FieldSpec.Builder.maybeAddDeprecation(deprecationReason: String?): FieldSpec.Builder {
if (deprecationReason.isNullOrBlank()) {
if (deprecationReason == null) {
return this
}

return addJavadoc("$L\n", deprecationReason).addAnnotation(deprecatedAnnotation())
}

internal fun MethodSpec.Builder.maybeSuppressDeprecation(enumValues: List<IrEnum.Value>): MethodSpec.Builder = applyIf(enumValues.any { !it.deprecationReason.isNullOrBlank() }) {
internal fun MethodSpec.Builder.maybeSuppressDeprecation(enumValues: List<IrEnum.Value>): MethodSpec.Builder = applyIf(enumValues.any { it.deprecationReason != null }) {
addAnnotation(suppressDeprecatedAnnotation())
}
18 changes: 9 additions & 9 deletions ...compiler/src/main/kotlin/com/apollographql/apollo/compiler/codegen/kotlin/helpers/KDoc.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,39 +47,39 @@ internal fun FunSpec.Builder.maybeAddDescription(description: String?): FunSpec.


internal fun TypeSpec.Builder.maybeAddDeprecation(deprecationReason: String?): TypeSpec.Builder {
if (deprecationReason.isNullOrBlank()) {
if (deprecationReason == null) {
return this
}

return addAnnotation(deprecatedAnnotation(deprecationReason))
}

internal fun PropertySpec.Builder.maybeAddDeprecation(deprecationReason: String?): PropertySpec.Builder {
if (deprecationReason.isNullOrBlank()) {
if (deprecationReason == null) {
return this
}

return addAnnotation(deprecatedAnnotation(deprecationReason))
}

internal fun ParameterSpec.Builder.maybeAddDeprecation(deprecationReason: String?): ParameterSpec.Builder {
if (deprecationReason.isNullOrBlank()) {
if (deprecationReason == null) {
return this
}

return addAnnotation(deprecatedAnnotation(deprecationReason))
}

internal fun FunSpec.Builder.maybeAddDeprecation(deprecationReason: String?): FunSpec.Builder {
if (deprecationReason.isNullOrBlank()) {
if (deprecationReason == null) {
return this
}

return addAnnotation(deprecatedAnnotation(deprecationReason))
}

internal fun TypeSpec.Builder.maybeAddRequiresOptIn(resolver: KotlinResolver, optInFeature: String?): TypeSpec.Builder {
if (optInFeature.isNullOrBlank()) {
if (optInFeature == null) {
return this
}

Expand All @@ -88,7 +88,7 @@ internal fun TypeSpec.Builder.maybeAddRequiresOptIn(resolver: KotlinResolver, op
}

internal fun PropertySpec.Builder.maybeAddRequiresOptIn(resolver: KotlinResolver, optInFeature: String?): PropertySpec.Builder {
if (optInFeature.isNullOrBlank()) {
if (optInFeature == null) {
return this
}

Expand All @@ -97,7 +97,7 @@ internal fun PropertySpec.Builder.maybeAddRequiresOptIn(resolver: KotlinResolver
}

internal fun ParameterSpec.Builder.maybeAddRequiresOptIn(resolver: KotlinResolver, optInFeature: String?): ParameterSpec.Builder {
if (optInFeature.isNullOrBlank()) {
if (optInFeature == null) {
return this
}

Expand All @@ -106,7 +106,7 @@ internal fun ParameterSpec.Builder.maybeAddRequiresOptIn(resolver: KotlinResolve
}

internal fun FunSpec.Builder.maybeAddRequiresOptIn(resolver: KotlinResolver, optInFeature: String?): FunSpec.Builder {
if (optInFeature.isNullOrBlank()) {
if (optInFeature == null) {
return this
}

Expand All @@ -123,7 +123,7 @@ internal fun requiresOptInAnnotation(annotation: ClassName): AnnotationSpec {
internal fun <T: Annotatable.Builder<*>> T.maybeAddOptIn(
resolver: KotlinResolver,
enumValues: List<IrEnum.Value>,
): T = applyIf(enumValues.any { !it.optInFeature.isNullOrBlank() }) {
): T = applyIf(enumValues.any { it.optInFeature != null }) {
val annotation = resolver.resolveRequiresOptInAnnotation() ?: return@applyIf
addAnnotation(requiresOptInAnnotation(annotation))
}
Expand Down
Loading