Konsist #1526
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| /* | ||
| * Copyright (c) 2023 New Vector Ltd | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.element.android.app | ||
|
|
||
| import androidx.compose.runtime.Composable | ||
| import com.lemonappdev.konsist.api.KoModifier | ||
| import com.lemonappdev.konsist.api.Konsist | ||
| import com.lemonappdev.konsist.api.ext.list.constructors | ||
| import com.lemonappdev.konsist.api.ext.list.modifierprovider.withoutModifier | ||
| import com.lemonappdev.konsist.api.ext.list.modifierprovider.withoutOverrideModifier | ||
| import com.lemonappdev.konsist.api.ext.list.parameters | ||
| import com.lemonappdev.konsist.api.ext.list.properties | ||
| import com.lemonappdev.konsist.api.ext.list.withAllAnnotationsOf | ||
| import com.lemonappdev.konsist.api.ext.list.withAllParentsOf | ||
| import com.lemonappdev.konsist.api.ext.list.withNameEndingWith | ||
| import com.lemonappdev.konsist.api.ext.list.withReturnType | ||
| import com.lemonappdev.konsist.api.ext.list.withTopLevel | ||
| import com.lemonappdev.konsist.api.ext.list.withoutName | ||
| import com.lemonappdev.konsist.api.ext.list.withoutNameEndingWith | ||
| import com.lemonappdev.konsist.api.verify.assertFalse | ||
| import com.lemonappdev.konsist.api.verify.assertTrue | ||
| import io.element.android.libraries.architecture.Presenter | ||
| import io.element.android.libraries.designsystem.preview.PreviewsDayNight | ||
| import org.junit.Test | ||
|
|
||
| class KonsistTest { | ||
|
|
||
| @Test | ||
| fun `Classes extending 'Presenter' should have 'Presenter' suffix`() { | ||
| Konsist.scopeFromProject() | ||
| .classes() | ||
| .withAllParentsOf(Presenter::class) | ||
| .assertTrue { | ||
| it.name.endsWith("Presenter") | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `Functions with '@PreviewsDayNight' annotation should have 'Preview' suffix`() { | ||
| Konsist | ||
| .scopeFromProject() | ||
| .functions() | ||
| .withAllAnnotationsOf(PreviewsDayNight::class) | ||
| .assertTrue { | ||
| it.hasNameEndingWith("Preview") && | ||
| it.hasNameEndingWith("LightPreview").not() && | ||
| it.hasNameEndingWith("DarkPreview").not() | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `Top level function with '@Composable' annotation starting with a upper case should be placed in a file with the same name`() { | ||
| Konsist | ||
| .scopeFromProject() | ||
| .functions() | ||
| .withTopLevel() | ||
| .withoutModifier(KoModifier.PRIVATE) | ||
| .withoutNameEndingWith("Preview") | ||
| .withAllAnnotationsOf(Composable::class) | ||
| .withoutName( | ||
| // Add some exceptions... | ||
| "OutlinedButton", | ||
| "TextButton", | ||
| "SimpleAlertDialogContent", | ||
| ) | ||
| .assertTrue( | ||
| additionalMessage = | ||
| """ | ||
| Please check the filename. It should match the top level Composable function. If the filename is correct: | ||
| - consider making the Composable private or moving it to its own file | ||
| - at last resort, you can add an exception in the Konsist test | ||
| """.trimIndent() | ||
| ) { | ||
| if (it.name.first().isLowerCase()) { | ||
| true | ||
| } else { | ||
| val fileName = it.containingFile.name.removeSuffix(".kt") | ||
| fileName == it.name | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `Data class state MUST not have default value`() { | ||
|
There was a problem hiding this comment. Should we at least allow a default There was a problem hiding this comment. This idea is to help the developer remember (by not compiling the code otherwise) that all the fields in the state should be provided when created by the presenter. So I think it's safer to enforce this for all the params. |
||
| Konsist | ||
| .scopeFromProject() | ||
| .classes() | ||
| .withNameEndingWith("State") | ||
| .withoutName( | ||
| "CameraPositionState", | ||
| ) | ||
| .constructors | ||
| .parameters | ||
| .assertTrue { parameterDeclaration -> | ||
| parameterDeclaration.defaultValue == null && | ||
| // Using parameterDeclaration.defaultValue == null is not enough apparently, | ||
| // Also check that the text does not contain an equal sign | ||
| parameterDeclaration.text.contains("=").not() | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `Function which creates Presenter in test MUST be named 'createPresenterName'`() { | ||
| Konsist | ||
| .scopeFromTest() | ||
| .functions() | ||
| .withReturnType { it.name.endsWith("Presenter") } | ||
| .withoutOverrideModifier() | ||
| .assertTrue { functionDeclaration -> | ||
| functionDeclaration.name == "create${functionDeclaration.returnType?.name}" | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `no field should have 'm' prefix`() { | ||
|
|
||
| Konsist | ||
| .scopeFromProject() | ||
| .classes() | ||
| .properties() | ||
| .assertFalse { | ||
| val secondCharacterIsUppercase = it.name.getOrNull(1)?.isUpperCase() ?: false | ||
| it.name.startsWith('m') && secondCharacterIsUppercase | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Add some Konsist tests. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't detekt already checking this (or maybe it checks something similar?)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, Detekt is checking class name / filename, but not Composable function name / filename