README.md

Formatter Plugin

The plugin helps to format source code of your project and warns about issues. It makes use of the spotless plugin and applies bitfunk flavoured default configuration.

Features

As this plugin wraps spotless, it offers the same features with bitfunk project configuration. For kotlin it's using ktlint and Markdown is using prettier.

Supported source files:

• Kotlin (.kt)
• Kotlin Gradle (.kts)
• Markdown (.md)

Installation

Add the following to your project root build.gradle/build.gradle.kts file:

plugins {
    id("eu.bitfunk.gradle.plugin.quality.formatter")
}

Usage

To check source code formatting

./gradlew spotlessCheck

For applying source code formatting

./gradlew spotlessApply