commit | 1b8c4c99965608c7923a41e2254a0552ca14193c | [log] [tgz] |
---|---|---|
author | Paul Dingemans <paul-dingemans@users.noreply.github.com> | Thu Sep 04 16:50:05 2025 +0200 |
committer | GitHub <noreply@github.com> | Thu Sep 04 16:50:05 2025 +0200 |
tree | 98daae7b37b26945b4adfcbc89966b2ad1f25fc9 | |
parent | ff55bc1ea57d98f3918a36645158f74093658425 [diff] |
Simplify creation of a custom ruleset (#3118) * Simplify and document the build file so that it is more convenient to be used to start a new project for a custom ruleset * Modify the ktlint version in the build file during the release process * Improve documentation * Remove outdated comment in NoVarRuleTest.kt Closes #3048
.editorconfig
supportplain
, json
, html
and checkstyle
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.
User guide
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.