main.io.nlopez.compose.rules.ModifierWithoutDefault.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.19

// 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.util.definedInInterface
import io.nlopez.compose.core.util.isAbstract
import io.nlopez.compose.core.util.isActual
import io.nlopez.compose.core.util.isModifier
import io.nlopez.compose.core.util.isOpen
import io.nlopez.compose.core.util.isOverride
import io.nlopez.compose.core.util.lastChildLeafOrSelf
import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement
import org.jetbrains.kotlin.psi.KtFunction

class ModifierWithoutDefault : ComposeKtVisitor {

    override fun visitComposable(
        function: KtFunction,
        autoCorrect: Boolean,
        emitter: Emitter,
        config: ComposeKtConfig,
    ) {
        if (
            function.definedInInterface ||
            function.isActual ||
            function.isOverride ||
            function.isAbstract ||
            function.isOpen
        ) {
            return
        }

        with(config) {
            // Look for modifier params in the composable signature, and if any without a default value is found, error out.
            function.valueParameters.filter { it.isModifier }
                .filterNot { it.hasDefaultValue() }
                .forEach { modifierParameter ->
                    emitter.report(modifierParameter, MissingModifierDefaultParam, true)

                    // This error is easily auto fixable, we just inject ` = Modifier` to the param
                    if (autoCorrect) {
                        val lastToken = modifierParameter.node.lastChildLeafOrSelf() as LeafPsiElement
                        val currentText = lastToken.text
                        lastToken.rawReplaceWithText("$currentText = Modifier")
                    }
                }
        }
    }

    companion object {
        val MissingModifierDefaultParam = """
            This @Composable function has a modifier parameter but it doesn't have a default value.

            See https://mrmans0n.github.io/compose-rules/rules/#modifiers-should-have-default-parameters for more information.
        """.trimIndent()
    }
}