main.io.nlopez.compose.rules.ModifierNaming.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.report
import io.nlopez.compose.core.util.isModifier
import org.jetbrains.kotlin.psi.KtFunction

class ModifierNaming : ComposeKtVisitor {

    override fun visitComposable(
        function: KtFunction,
        autoCorrect: Boolean,
        emitter: Emitter,
        config: ComposeKtConfig,
    ) {
        // If there is a modifier param, we bail
        val modifiers = function.valueParameters.filter { with(config) { it.isModifier } }

        // If there are no modifiers, or more than one, we don't care as much about the naming
        if (modifiers.isEmpty()) return

        val count = modifiers.size
        if (count == 1) {
            if (modifiers.first().name?.equals("modifier") != true) {
                emitter.report(modifiers.first(), ModifiersAreSupposedToBeCalledModifierWhenAlone)
                return
            }
        } else {
            for (modifier in modifiers) {
                val valid = modifier.name?.lowercase()?.endsWith("modifier") ?: false
                if (!valid) {
                    emitter.report(modifier, ModifiersAreSupposedToEndInModifierWhenMultiple)
                }
            }
        }
    }

    companion object {
        val ModifiersAreSupposedToBeCalledModifierWhenAlone = """
            Modifier parameters should be called `modifier`.

            See https://mrmans0n.github.io/compose-rules/rules/#naming-modifiers-properly for more information.
        """.trimIndent()
        val ModifiersAreSupposedToEndInModifierWhenMultiple = """
            Modifier parameters should be called `modifier` or end in `Modifier` if there are more than one in the same @Composable.

            See https://mrmans0n.github.io/compose-rules/rules/#naming-modifiers-properly for more information.
        """.trimIndent()
    }
}