ktlint/ktlint
Ktlint
ktlint is a linter and code formatter for Kotlin that checks source files against a built-in set of style rules and automatically rewrites them to match those rules. It operates by walking the Kotlin abstract syntax tree, detecting violations, and applying transformations directly at the node level before regenerating the source code from the modified tree.
The project ships a curated default rule set that requires no configuration to enforce consistent formatting, and provides a command-line interface for running linting and formatting in batch mode. Its rule-set-based plugin architecture allows loading independent rule sets as plugins, each defining their own lint checks and formatting actions, while a reporter abstraction layer outputs results through pluggable reporters in plain text, JSON, or other formats.
Users can extend ktlint with custom rule sets and reporters to add or replace linting and formatting behavior, enabling enforcement of project-specific coding standards. The project covers both linting—checking code against built-in style rules and reporting violations—and automatic formatting of Kotlin source files to match those rules without manual effort.
Features
- Kotlin Formatters - Formats Kotlin source files to match built-in style rules automatically.
- Kotlin Linters - Checks Kotlin source files against built-in style rules and reports violations without configuration.
- Linters - Checks Kotlin code against built-in style rules to catch violations and enforce conventions.
- Source Code Rewriting - Transforms the AST directly to fix violations, then regenerates source code from the modified tree.
- Configuration-Free Rule Sets - Ships a curated collection of style rules that require no configuration to enforce consistent formatting.
- Plugin-Based Architectures - Loads independent rule sets as plugins that each define their own lint checks and formatting actions.
- Syntax Traversal - Walks the Kotlin abstract syntax tree to detect style violations and apply node-level transformations.
- Custom Lint Rule Plugins - Loads user-defined rule sets and reporters to add or replace linting and formatting behavior.
- Command Line Interfaces - Provides a CLI that accepts file paths and options to run linting and formatting in batch mode.
- Custom Rule Development - Extends the linter with user-defined rule sets and reporters to enforce project-specific coding standards.
- Violation Reporters - Outputs results through pluggable reporters that format violations as plain text, JSON, or other formats.
