chore: add ktlint for linting and formatting #75
Merged
Conversation
This file contains hidden or 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
stevensJourney
previously approved these changes
Oct 29, 2024
stevensJourney
approved these changes
Oct 29, 2024
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.
Description
To maintain consistency of code formatting between different developer machines we need to introduce a formatter. There appears to be a standard library for dealing with this - ktlint. This PR includes ktlint into the project by using the gradle plugin kotlinter. The .editorconfig with klint will maintain consistency between different developer machines by enforcing standard rules and formatting.
The formatter was run and linting fixes are included in this PR.
A lint check is added to the github actions build step.
To enable klint in Android studio (or any other intellij IDE) for automatic formatting and to see linting errors install the ktlint plugin.