com.pinterest.ktlint.rule.engine.internal.EditorConfigGenerator.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ktlint-rule-engine Show documentation

An anti-bikeshedding Kotlin linter with built-in formatter.

There is a newer version: 1.5.0

package com.pinterest.ktlint.rule.engine.internal

import com.pinterest.ktlint.rule.engine.api.EditorConfigOverride
import com.pinterest.ktlint.rule.engine.core.api.Rule
import com.pinterest.ktlint.rule.engine.core.api.editorconfig.CODE_STYLE_PROPERTY
import com.pinterest.ktlint.rule.engine.core.api.editorconfig.CodeStyleValue
import com.pinterest.ktlint.rule.engine.core.api.editorconfig.EditorConfig
import java.nio.file.FileSystem
import java.nio.file.FileSystems
import java.nio.file.Path

/**
 * Generates a Kotlin section content for the `.editorconfig` file. The set of properties is based on the properties used by the given set
 * of [Rule]s. The default values for missing properties are based on the given [CodeStyleValue].
 */
internal class EditorConfigGenerator(
    private val fileSystem: FileSystem = FileSystems.getDefault(),
    private val editorConfigLoaderEc4j: EditorConfigLoaderEc4j,
) {
    /**
     * Method loads merged `.editorconfig` content using [filePath], and then, by querying the set of [Rule]s generates Kotlin section
     * (default is `[*.{kt,kts}]`) content including expected default values.
     *
     * @return Kotlin section editorconfig content. For example:
     * ```properties
     * final-newline = true
     * indent-size = 4
     * ```
     */
    fun generateEditorconfig(
        rules: Set,
        codeStyle: CodeStyleValue,
        filePath: Path,
    ): String =
        editorConfig(rules, codeStyle, filePath)
            .map { "${it.name} = ${it.sourceValue}" }
            .distinct()
            .sorted()
            .joinToString(separator = System.lineSeparator())

    private fun editorConfig(
        rules: Set,
        codeStyle: CodeStyleValue,
        filePath: Path,
    ): EditorConfig {
        val usedEditorConfigProperties =
            rules
                .map { it.usesEditorConfigProperties }
                .flatten()
                .toSet()
        return loadEditorConfig(codeStyle, filePath)
            .filterBy(usedEditorConfigProperties.plus(DEFAULT_EDITOR_CONFIG_PROPERTIES))
    }

    private fun loadEditorConfig(
        codeStyle: CodeStyleValue,
        filePath: Path,
    ) = EditorConfigLoader(
        fileSystem = fileSystem,
        editorConfigLoaderEc4j = editorConfigLoaderEc4j,
        editorConfigOverride = EditorConfigOverride.from(CODE_STYLE_PROPERTY to codeStyle.name),
    ).load(filePath = filePath)
}