main.io.nlopez.compose.rules.UnstableCollections.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common Show documentation

Jetpack Compose Rules

There is a newer version: 0.4.22

// Copyright 2023 Nacho Lopez
// SPDX-License-Identifier: Apache-2.0
package io.nlopez.compose.rules

import io.nlopez.compose.core.ComposeKtConfig
import io.nlopez.compose.core.ComposeKtVisitor
import io.nlopez.compose.core.Emitter
import io.nlopez.compose.core.report
import io.nlopez.compose.core.util.isTypeUnstableCollection
import org.jetbrains.kotlin.psi.KtFunction
import java.util.*

class UnstableCollections : ComposeKtVisitor {

    override fun visitComposable(
        function: KtFunction,
        autoCorrect: Boolean,
        emitter: Emitter,
        config: ComposeKtConfig,
    ) {
        for (param in function.valueParameters.filter { it.isTypeUnstableCollection }) {
            val variableName = param.nameAsSafeName.asString()
            val type = param.typeReference?.text ?: "List/Set/Map"
            val message = createErrorMessage(
                type = type,
                rawType = type.replace(DiamondRegex, ""),
                variable = variableName,
            )
            emitter.report(param.typeReference ?: param, message)
        }
    }

    companion object {
        private val DiamondRegex by lazy { Regex("<.*>\\??") }
        private val String.capitalized: String
            get() = replaceFirstChar { if (it.isLowerCase()) it.titlecase(Locale.getDefault()) else it.toString() }

        fun createErrorMessage(type: String, rawType: String, variable: String) = """
            The Compose Compiler cannot infer the stability of a parameter if a $type is used in it, even if the item type is stable.
            You should use Kotlinx Immutable Collections instead: `$variable: Immutable$type` or create an `@Immutable` wrapper for this class: `@Immutable data class ${variable.capitalized}$rawType(val items: $type)`

            See https://mrmans0n.github.io/compose-rules/rules/#avoid-using-unstable-collections for more information.
        """.trimIndent()
    }
}