Rename PreviewParameterProvider subclasses to the PreviewParam suffix

The `Provider` suffix reads as a dependency provider rather than as preview data, and it collides with the real providers in the codebase — `StringProvider`, `PickerProvider`, the login feature's `AccountProvider` — so the name says nothing about which of the two a class is. `PreviewParam` says it. 195 classes are renamed, along with the 185 files named after them, the konsist rule that enforces the convention, the presentation-class file templates and the onboarding documentation. This cannot be split. `Konsist.scopeFromProduction()` scans the whole project, so flipping the assertion before every class has moved leaves the rule red, and a rule that accepted either suffix during a transition would be exactly the kind of compatibility layer this convention change is meant to remove. Two judgement calls in the rule itself. The `name.endsWith("PreviewProvider")` exclusion is dropped: its only job was to reject a redundant `Preview` before `Provider`, and the new suffix already contains it; no class currently ends with `PreviewProvider`, so removing it changes nothing today. And `EditableAvatarViewUriProvider` is renamed rather than deleted from the exclusion list even though no such class exists in this repository, since it presumably comes from the modules overlaid for the enterprise build. Nothing keyed off the old suffix: no snapshot filename contains a provider class name, so no Paparazzi image changes, and the Kover variants match on `*Presenter`, `*State` and `*ViewKt`, so coverage bounds are unaffected.
2026-11-03 06:55:41 +00:00 · 2026-08-17 17:40:33 +03:00
parent 12791406ca
commit 03c330ee07
388 changed files with 495 additions and 476 deletions
@@ -132,7 +132,7 @@ data class AttachmentThumbnailInfo(

@PreviewsDayNight
@Composable
-internal fun AttachmentThumbnailPreview(@PreviewParameter(AttachmentThumbnailInfoProvider::class) data: AttachmentThumbnailInfo) = ElementPreview {
+internal fun AttachmentThumbnailPreview(@PreviewParameter(AttachmentThumbnailInfoPreviewParam::class) data: AttachmentThumbnailInfo) = ElementPreview {
    AttachmentThumbnail(
        info = data,
        modifier = Modifier
@@ -11,7 +11,7 @@ package io.element.android.libraries.matrix.ui.components
 import androidx.compose.ui.tooling.preview.PreviewParameterProvider
 import io.element.android.libraries.matrix.api.media.MediaSource

-open class AttachmentThumbnailInfoProvider : PreviewParameterProvider<AttachmentThumbnailInfo> {
+open class AttachmentThumbnailInfoPreviewParam : PreviewParameterProvider<AttachmentThumbnailInfo> {
    override val values: Sequence<AttachmentThumbnailInfo>
        get() = sequenceOf(
            anAttachmentThumbnailInfo(type = AttachmentThumbnailType.Image),
@@ -158,7 +158,7 @@ fun CreateDmConfirmationBottomSheet(
@Composable
 internal fun CreateDmConfirmationBottomSheetPreview(
    @PreviewParameter(
-        CreateDmConfirmationBottomSheetStateProvider::class
+        CreateDmConfirmationBottomSheetStatePreviewParam::class
    ) state: CreateDmConfirmationBottomSheetState
 ) = ElementPreview(fillMaxSize = true) {
    CreateDmConfirmationBottomSheet(
@@ -174,7 +174,7 @@ data class CreateDmConfirmationBottomSheetState(
    val isUserIdentityUnknown: Boolean,
 )

-class CreateDmConfirmationBottomSheetStateProvider : PreviewParameterProvider<CreateDmConfirmationBottomSheetState> {
+class CreateDmConfirmationBottomSheetStatePreviewParam : PreviewParameterProvider<CreateDmConfirmationBottomSheetState> {
    override val values = sequenceOf(
        CreateDmConfirmationBottomSheetState(matrixUser = aMatrixUser(), isUserIdentityUnknown = false),
        CreateDmConfirmationBottomSheetState(matrixUser = aMatrixUser(), isUserIdentityUnknown = true),
@@ -79,6 +79,6 @@ fun MatrixUserHeader(

@PreviewsDayNight
@Composable
-internal fun MatrixUserHeaderPreview(@PreviewParameter(MatrixUserProvider::class) matrixUser: MatrixUser) = ElementPreview {
+internal fun MatrixUserHeaderPreview(@PreviewParameter(MatrixUserPreviewParam::class) matrixUser: MatrixUser) = ElementPreview {
    MatrixUserHeader(matrixUser)
 }
@@ -24,7 +24,7 @@ import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.user.DisplayedStatus
 import io.element.android.libraries.matrix.api.user.MatrixUser

-open class MatrixUserProvider : PreviewParameterProvider<MatrixUser> {
+open class MatrixUserPreviewParam : PreviewParameterProvider<MatrixUser> {
    override val values: Sequence<MatrixUser>
        get() = sequenceOf(
            aMatrixUser(),
@@ -33,7 +33,7 @@ open class MatrixUserProvider : PreviewParameterProvider<MatrixUser> {
        )
 }

-open class MatrixUserWithAvatarProvider : PreviewParameterProvider<MatrixUser?> {
+open class MatrixUserWithAvatarPreviewParam : PreviewParameterProvider<MatrixUser?> {
    override val values: Sequence<MatrixUser?>
        get() = sequenceOf(
            aMatrixUser(displayName = USER_NAME_JOHN_DOE),
@@ -46,6 +46,6 @@ fun MatrixUserRow(

@PreviewsDayNight
@Composable
-internal fun MatrixUserRowPreview(@PreviewParameter(MatrixUserProvider::class) matrixUser: MatrixUser) = ElementPreview {
+internal fun MatrixUserRowPreview(@PreviewParameter(MatrixUserPreviewParam::class) matrixUser: MatrixUser) = ElementPreview {
    MatrixUserRow(matrixUser)
 }
@@ -16,7 +16,7 @@ import io.element.android.libraries.matrix.ui.model.SelectRoomInfo
 import kotlinx.collections.immutable.ImmutableList
 import kotlinx.collections.immutable.persistentListOf

-class SelectRoomInfoProvider : PreviewParameterProvider<SelectRoomInfo> {
+class SelectRoomInfoPreviewParam : PreviewParameterProvider<SelectRoomInfo> {
    override val values: Sequence<SelectRoomInfo>
        get() = sequenceOf(
            aSelectRoomInfo(roomId = RoomId("!room1:domain")),
@@ -51,7 +51,7 @@ fun SelectedRoom(
@PreviewsDayNight
@Composable
 internal fun SelectedRoomPreview(
-    @PreviewParameter(SelectRoomInfoProvider::class) roomInfo: SelectRoomInfo
+    @PreviewParameter(SelectRoomInfoPreviewParam::class) roomInfo: SelectRoomInfo
 ) = ElementPreview {
    SelectedRoom(
        roomInfo = roomInfo,
@@ -62,7 +62,7 @@ internal fun SelectedRoomPreview(
@PreviewsDayNight
@Composable
 internal fun SelectedRoomRtlPreview(
-    @PreviewParameter(SelectRoomInfoProvider::class) roomInfo: SelectRoomInfo
+    @PreviewParameter(SelectRoomInfoPreviewParam::class) roomInfo: SelectRoomInfo
 ) = CompositionLocalProvider(
    LocalLayoutDirection provides LayoutDirection.Rtl,
 ) {
@@ -44,7 +44,7 @@ fun SelectedUser(

@PreviewsDayNight
@Composable
-internal fun SelectedUserPreview(@PreviewParameter(MatrixUserWithAvatarProvider::class) user: MatrixUser) = ElementPreview {
+internal fun SelectedUserPreview(@PreviewParameter(MatrixUserWithAvatarPreviewParam::class) user: MatrixUser) = ElementPreview {
    SelectedUser(
        matrixUser = user,
        canRemove = true,
@@ -210,7 +210,7 @@ private fun SpaceRoomItemScaffold(

@Composable
@PreviewsDayNight
-internal fun SpaceRoomItemViewPreview(@PreviewParameter(SpaceRoomProvider::class) spaceRoom: SpaceRoom) = ElementPreview {
+internal fun SpaceRoomItemViewPreview(@PreviewParameter(SpaceRoomPreviewParam::class) spaceRoom: SpaceRoom) = ElementPreview {
    SpaceRoomItemView(
        spaceRoom = spaceRoom,
        showUnreadIndicator = spaceRoom.state == CurrentUserMembership.INVITED,
@@ -17,7 +17,7 @@ import io.element.android.libraries.matrix.api.room.RoomType
 import io.element.android.libraries.matrix.api.spaces.SpaceRoom
 import io.element.android.libraries.previewutils.room.aSpaceRoom

-class SpaceRoomProvider : PreviewParameterProvider<SpaceRoom> {
+class SpaceRoomPreviewParam : PreviewParameterProvider<SpaceRoom> {
    override val values: Sequence<SpaceRoom> = sequenceOf(
        aSpaceRoom(
            roomType = RoomType.Room,
@@ -35,7 +35,7 @@ import io.element.android.libraries.matrix.api.timeline.item.event.VoiceMessageT
 import kotlinx.collections.immutable.persistentListOf
 import kotlinx.collections.immutable.persistentMapOf

-open class InReplyToDetailsProvider : PreviewParameterProvider<InReplyToDetails> {
+open class InReplyToDetailsPreviewParam : PreviewParameterProvider<InReplyToDetails> {
    override val values: Sequence<InReplyToDetails>
        get() = sequenceOf(
            aMessageContent(
@@ -99,7 +99,7 @@ open class InReplyToDetailsProvider : PreviewParameterProvider<InReplyToDetails>
        }
 }

-class InReplyToDetailsDisambiguatedProvider : InReplyToDetailsProvider() {
+class InReplyToDetailsDisambiguatedPreviewParam : InReplyToDetailsPreviewParam() {
    override val values: Sequence<InReplyToDetails>
        get() = sequenceOf(
            aMessageContent(
@@ -114,7 +114,7 @@ class InReplyToDetailsDisambiguatedProvider : InReplyToDetailsProvider() {
        }
 }

-class InReplyToDetailsInformativeProvider : InReplyToDetailsProvider() {
+class InReplyToDetailsInformativePreviewParam : InReplyToDetailsPreviewParam() {
    override val values: Sequence<InReplyToDetails>
        get() = sequenceOf(
            RedactedContent,
@@ -126,7 +126,7 @@ class InReplyToDetailsInformativeProvider : InReplyToDetailsProvider() {
        }
 }

-class InReplyToDetailsOtherProvider : InReplyToDetailsProvider() {
+class InReplyToDetailsOtherPreviewParam : InReplyToDetailsPreviewParam() {
    override val values: Sequence<InReplyToDetails>
        get() = sequenceOf(
            InReplyToDetails.Loading(eventId = EventId("\$anEventId")),
@@ -236,7 +236,7 @@ private fun ReplyToNotFoundContent(

@PreviewsDayNight
@Composable
-internal fun InReplyToViewPreview(@PreviewParameter(provider = InReplyToDetailsProvider::class) inReplyTo: InReplyToDetails) = ElementPreview {
+internal fun InReplyToViewPreview(@PreviewParameter(provider = InReplyToDetailsPreviewParam::class) inReplyTo: InReplyToDetails) = ElementPreview {
    InReplyToView(
        inReplyTo = inReplyTo,
        hideImage = false,
@@ -134,7 +134,7 @@ private fun RowScope.SecondaryText(
@PreviewsDayNight
@Composable
 internal fun SenderNamePreview(
-    @PreviewParameter(SenderNameDataProvider::class) senderNameData: SenderNameData,
+    @PreviewParameter(SenderNameDataPreviewParam::class) senderNameData: SenderNameData,
 ) = ElementPreview {
    SenderName(
        senderId = senderNameData.userId,
@@ -20,7 +20,7 @@ data class SenderNameData(
    val senderNameMode: SenderNameMode,
 )

-open class SenderNameDataProvider : PreviewParameterProvider<SenderNameData> {
+open class SenderNameDataPreviewParam : PreviewParameterProvider<SenderNameData> {
    override val values: Sequence<SenderNameData>
        get() = sequenceOf(
            SenderNameMode.Timeline(mainColor = Color.Red),
@@ -30,7 +30,7 @@ sealed interface LoadingRoomState {
    data class Loaded(val room: JoinedRoom) : LoadingRoomState
 }

-open class LoadingRoomStateProvider : PreviewParameterProvider<LoadingRoomState> {
+open class LoadingRoomStatePreviewParam : PreviewParameterProvider<LoadingRoomState> {
    override val values: Sequence<LoadingRoomState>
        get() = sequenceOf(
            LoadingRoomState.Loading,