44 lines (29 loc) · 2.57 KB

Ktlint IntelliJ Plugin

Formats code with ktlint after IntelliJ IDEA formatting or on save of file.

Ktlint is an anti-bikeshedding linter/formatter for Kotlin code based on the Kotlin Coding Conventions, Android Kotlin Style Guide, and other best practices.

Installation

Install via Settings > Plugins > Marketplace and search for "ktlint".
For beta versions, add the plugin repository: Settings > Plugins > ⚙️ > Manage plugin repositories and add https://plugins.jetbrains.com/plugins/list?channel=beta&pluginId=com.nbadal.ktlint.
Manual install: download the plugin from the JetBrains Marketplace.

Usage

Configure in Preferences > Tools > KtLint.
Ktlint is configured via .editorconfig (see Ktlint configuration).

Compatibility

IntelliJ IDEA Platform compatibility is defined by pluginSinceBuild / pluginUntilBuild in gradle.properties.
Default ktlint version is defined in gradle/libs.versions.toml.

Project structure

This repo is a multi-module project:

ktlint-plugin - IntelliJ plugin code.
ktlint-lib - Relocates ktlint artifacts and ships multiple ruleset versions.

Development and maintenance

See CONTRIBUTING.md for contribution, local development, and ruleset/version maintenance. Release and publishing steps are in MAINTAINERS.md.

Plugin based on the IntelliJ Platform Plugin Template.