Kotlin Keywords escaped in Class and Property names about kotlinpoet HOT 6 CLOSED

Their classname includes backticks. I think this is working as expected as backticks aren't allowed as part of a name.

I would not rely on TypeSpec.toString() for a class name as we can change that format over time and it could possible include things like type parameters or wildcards. Instead, do a subtype check for ClassName and then extract the package name and simple names and combine them manually.

from kotlinpoet.

Yeah just a typo

from kotlinpoet.

As part of the behavior check with other words, changing the word data in the package name to info (As an example) gives this result:

public object ComAttafitamimKabinLocalEntitiesInfoGenderKotlinStringAdapter :
      ColumnAdapter<Gender, String> {
    override fun decode(databaseValue: String): Gender = enumValueOf(databaseValue)

    override fun encode(`value`: Gender): String = value.name
  }
  
private val comAttafitamimKabinLocalEntitiesInfoGenderKotlinStringAdapter:
      ColumnAdapter<Gender, String> = ComAttafitamimKabinLocalEntitiesInfoGenderKotlinStringAdapter

Which is accepted by the compiler

from kotlinpoet.

By further investigation, I found out that the escaping is returned from TypeName.toString() which is created by calling KSType.toTypeName() or KSClassDeclaration.toClassName()

As a workaround, I'm removing "``" from the output of toString()

from kotlinpoet.

To Reproduce
Simply generate a class or property with the word "Data" in its name

Can you please include the actual code you're executing? The following unit test passes for me (note that data inside the package name is indeed escaped, which is expected):

@Test fun nameIncludesData() {
  val source = FileSpec.builder("com.squareup.data", "TestData")
    .addType(TypeSpec.classBuilder("TestData").build())
    .build()
  assertThat(source.toString()).isEqualTo("""
    package com.squareup.`data`

    public class TestData

    """.trimIndent())
}

And just to confirm, are you actually using version 1.6.0 of the library, or 1.16.0? 1.16.0 is the latest.

from kotlinpoet.

@Egorand I misspelled the version, it is 1.16.0 indeed.
Your code in the unit test works fine for me too, as I mentioned in my third comment, the backticks come from TypeName.toString().

@JakeWharton I didn't use TypeSpec, but rather TypeName, but I agree that it isn't safe to rely on toString(). I will consider using a combination of ClassName and typeParameters in the future to get the full name, including generics.

I close the issue since it's the expected behavior, thank you for the quick reply!

from kotlinpoet.