Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add plugin installation guide #60

Merged
merged 1 commit into from
Mar 2, 2025
Merged

docs: Add plugin installation guide #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ A fat JAR of the CLI is available on [Maven Central](https://repo1.maven.org/mav
java -jar path/to/kotlin-formatter-$version-all.jar [OPTIONS] [FILES...]
```

## Idea Plugin Usage
## IntelliJ IDEA Plugin Usage

A properties file can be used to configure the plugin for each project. The properties file should be named `kotlin-formatter.properties` and placed in the `.idea` of the project. The following properties are supported:

Expand All @@ -92,3 +92,6 @@ Changes to these config require an IDE restart to take effect.

To enable formatting of files on save, navigate to "Settings" > "Tools" > Actions on Save", activate the "Reformat code" checkbox, and ensure that the "Kotlin" file type is selected.
Make sure "Optimize imports" is NOT enabled for the "Kotlin" file type.

## IntelliJ IDEA Plugin Installation
[Download from JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26482-kotlin-formatter)