Adds editorconfig for current code style #5727
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericdecanini
changed the title
ericdecanini
requested review from
a team and
fedrunov
and removed request for
a team
bmarty
approved these changes
Apr 13, 2022
| ij_properties_key_value_delimiter = equals | ||
| ij_properties_spaces_around_key_value_delimiter = false | ||
|
|
||
| [.editorconfig] |
| # From https://github.com/pinterest/ktlint#custom-ktlint-specific-editorconfig-properties | ||
| # default IntelliJ IDEA style, same as alphabetical, but with "java", "javax", "kotlin" and alias imports in the end of the imports list | ||
| ij_kotlin_imports_layout=*,java.**,javax.**,kotlin.**,^ | ||
| [*] |
There was a problem hiding this comment.
what was the command to generate this file OOI?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Draft for testing with the linter on the CI
Type of change
Content
Adds an
.editorconfigfile reflecting the current code styleMotivation and context
Closes #5729
In order to make incremental changes to our current code style, it's best for us to have an initial editorconfig that reflects our current code style that we then make changes to later.
An issue encountered when doing this is there are areas of the project that don't follow even the current code style for reasons such as indentation, wrapping, etc.
Instead of changing these files which would result in a massive diff, I opted for disabling these rules temporarily from the linter for the duration we undergo this code style change.
The editorconfig file found here is one extracted from Android Studio preferences reflecting the current code style. It includes settings for other languages too other than Kotlin. At first I thought we didn't need this and removed them but this resulted in a bug where XML files were unintentionally formatted differently so I decided to keep them all
Screenshots / GIFs
N/A
Tests
The main test here in that the linter passes. See that we have no changes to our autoformatter for different file types (kotlin, xml)
I also tested the app doesn't crash on boot
Tested devices
Checklist