Skip to content
New issue

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

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

Already on GitHub? # to your account

Add .editorconfig property ij_kotlin_indent_before_arrow_on_new_line #2838

Merged
merged 2 commits into from
Oct 19, 2024

Conversation

paul-dingemans
Copy link
Collaborator

Description

Add .editorconfig property ij_kotlin_indent_before_arrow_on_new_line

When ij_kotlin_indent_before_arrow_on_new_line is enabled, the arrow in a when-entry should be indented when it starts on a new line.

  • For intellij_idea and android_studio keep formatting same as the ugly but default IDEA formatting. Note that the closing curly brace is de-indented compared to arrow. For those code styles this property needs to be set to true to keep formatting compatible with default IDEA Formatting when using IDEA version 2024.2 or above.
  • For ktlint_official code style apply a more consistent formatting by indenting the entire block body (including closing curly brace) relative to the indented arrow.

Closes #2808

Checklist

Before submitting the PR, please check following (checks which are not relevant may be ignored):

  • Commit message are well written. In addition to a short title, the commit message also explain why a change is made.
  • At least one commit message contains a reference Closes #<xxx> or Fixes #<xxx> (replace<xxx> with issue number)
  • Tests are added
  • KtLint format has been applied on source code itself and violations are fixed
  • PR title is short and clear (it is used as description in the release changelog)
  • PR description added (background information)

Documentation is updated. See difference between snapshot and release documentation

  • Snapshot documentation in case documentation is to be released together with a code change
  • Release documentation in case documentation is related to a released version of ktlint and has to be published as soon as the change is merged to master

Determines whether an arrow in a when-entry should be indented when it starts on a new line. For code styles `intellij_idea` and `android_studio` this property needs to be set to `true` to keep formatting compatible with default IDEA Formatting when using IDEA version `2024.2` or above.

Closes #2808
When `ij_kotlin_indent_before_arrow_on_new_line` enabled:
* For `intellij_idea` and `android_studio` keep formatting same as the ugly but default IDEA formatting. Note that the closing curly brace is de-indented compared to arrow.
* For `ktlint_official` code style apply a more consistent formatting by indenting the entire block body (including closing curly brace) relative to the indented arrow.
@paul-dingemans paul-dingemans added this to the 1.4.0 milestone Oct 19, 2024
@paul-dingemans paul-dingemans merged commit 11f01c1 into master Oct 19, 2024
20 checks passed
@paul-dingemans paul-dingemans deleted the 2808 branch October 19, 2024 14:45
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

intellij_idea style contradicts IntelliJ formatting for indentaton within when
1 participant