refs/heads/upstream/master - third_party/github/pinterest/ktlint

commit	a4b37db8b911990d4e91deaa7b3d99564763b51f	[log] [tgz]
author	renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>	Fri Sep 26 16:26:20 2025 +0200
committer	GitHub <noreply@github.com>	Fri Sep 26 16:26:20 2025 +0200
tree	0199c6eea60457239e920cf5b45c64b3f22444d4
parent	cb306df4d437b4199ee822f22e6c9be4ff7127af [diff]

tree: 0199c6eea60457239e920cf5b45c64b3f22444d4

README.md

Key features

No configuration required
Built-in Rule sets
Built-in formatter
.editorconfig support
Several built-in reporters: plain, json, html and checkstyle
Executable jar
Allows extension with custom rule sets and reporters

Quick start

Follow steps below for a quick start with latest ktlint release.

Step 1: Install with brew
```
brew install ktlint
```
See download and verification from GitHub or other package managers for alternative ways of installing ktlint. Or, use one of the integrations like maven and gradle plugins.
Step 2: Lint and format your code
All files with extension .kt and .kts in the current directory and below will be scanned. Problems will be fixed automatically when possible.
```
ktlint --format
# or
ktlint -F
```
See cli usage for a more extensive description on using ktlint.

Documentation

User guide

Legal

This project is not affiliated with nor endorsed by JetBrains.
All code, unless specified otherwise, is licensed under the MIT license.
Copyright (c) 2019 Pinterest, Inc.
Copyright (c) 2016-2019 Stanley Shyiko.