❗️Как проверять структуру Kotlin-кода на соответствие архитектуре и неймингу

Про инструменты для статического анализа Kotlin-кода я уже писал в отдельном посте. Но когда нужно проверить не стиль форматирования, а именно именование, расположение и иерархию классов, обычных линтеров недостаточно. Тут нужен инструмент, который умеет смотреть на проект целиком и анализировать код между файлами.

Для Kotlin такую задачу отлично решает библиотека Konsist. Проверки в ней выглядят как обычные Unit-тесты (поддерживается несколько тестовых JVM движков).

Например, в одном из проектов я добавил правила:
👉 Все классы, чьи имена заканчиваются на ViewModel, должны наследоваться от ViewModel (к сожалению, заставить использовать именно Jetpack ViewModel не получилось).
👉 Все свойства с типом MutableStateFlow<*> должны быть недоступны за пределами класса.

private var viewModels: List<KoClassDeclaration> = emptyList()

@BeforeTest
fun setup() {
    // Собираем все классы, чьи имена оканчиваются на ViewModel
    viewModels = Konsist
        .scopeFromProject()
        .classes()
        .withName { name -> name.endsWith("ViewModel") }
}

@Test
fun `Every ViewModel class extends from 'ViewModel'`() {
    viewModels.assertTrue { viewModel ->
        viewModel.hasParentWithName("ViewModel", indirectParents = true)
    }
}

@Test
fun `MutableStateFlow properties in ViewModel are not visible outside`() {
    viewModels
        .properties()
        .filter { property ->
            property.hasType { type ->
                type.hasNameMatching(Regex("MutableStateFlow<\\w+>"))
            }
        }
        .assertTrue { property ->
            property.hasPrivateModifier || property.hasProtectedModifier
        }
}

Правила можно делать любой сложности — от проверки нейминга до соответствия архитектуре.
Всё это запускается как обычные JVM-тесты и выполняется достаточно быстро ⚡️

❗️ konsist пока не достиг версии 1.0 но активно идёт к ней! Работает исправно и позволяет масштабировать правила расположения кода на всё команду!

#kotlin