Add ktlint plugin code styling and formatting

[G10xy]

Description

Based on the issue #279 I already used ktlint plugin, in order to mantain a standard about code style and formatting.
Please have check, give it a try.
You can find in the Grandle task at the sub-task formatting.
By running ktlintFormat, the code will be automatically restyled and, in case of .* imports, it will generate a txt file reporting the error.

Some link about:
https://reflectoring.io/code-format-with-ktlint/
https://www.baeldung.com/kotlin/ktlint-code-formatting

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Dependency update / replacement

How Has This Been Tested?

I run ktlintFormat and checked that it reported all problems about importing and automatically formatting the code style.
I also tested it with gradle check and gradle build and it worked fine everytime.

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have made corresponding changes to the documentation if necessary
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[codecov]

Codecov Report

Merging #281 (267636a) into master (2fa6004) will decrease coverage by 0.15%.
Report is 1 commits behind head on master.
The diff coverage is 39.13%.

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #281      +/-   ##
============================================
- Coverage     35.88%   35.74%   -0.15%     
  Complexity      348      348              
============================================
  Files           101      101              
  Lines          3035     3047      +12     
  Branches        184      184              
============================================
  Hits           1089     1089              
- Misses         1826     1838      +12     
  Partials        120      120              

Files	Coverage Δ
...e/src/main/kotlin/social/bigbone/JsonSerializer.kt	100.00% <100.00%> (ø)
...igbone/src/main/kotlin/social/bigbone/api/Range.kt	100.00% <100.00%> (ø)
...n/kotlin/social/bigbone/api/entity/Conversation.kt	36.36% <100.00%> (ø)
...rc/main/kotlin/social/bigbone/api/entity/Filter.kt	57.69% <ø> (ø)
...rc/main/kotlin/social/bigbone/api/entity/Marker.kt	44.44% <100.00%> (ø)
...n/kotlin/social/bigbone/api/entity/MastodonList.kt	61.53% <100.00%> (ø)
...ain/kotlin/social/bigbone/api/entity/StatusEdit.kt	27.58% <100.00%> (ø)
...kotlin/social/bigbone/api/method/AccountMethods.kt	75.94% <100.00%> (ø)
...n/social/bigbone/api/method/FeaturedTagsMethods.kt	94.73% <ø> (ø)
...n/kotlin/social/bigbone/nodeinfo/NodeInfoClient.kt	33.33% <ø> (ø)
... and 9 more

[andregasser]

Hello @G10xy
Thanks a lot for this PR. As we are already using detekt (with detekt-formatting enabled) in this project, we should either continue using detekt-formatting or switch this off and start using ktlint instead.

detekt wraps ktlint formatting rules already:

Reference: https://detekt.dev/docs/intro

Not sure how to continue with this. At the moment, I'm having an issue that I want detekt to alert on wildcard imports. But somehow, I cannot make this work. Eventually, this works better with pure ktlint?

Best regards,
André

[andregasser]

After doing a bit of research, I think we should keep detekt as a tool for code analysis, but use ktlint Gradle plugin for linting.
Especially after reading this: detekt/detekt#5997

I have added two minor comments to your PR. Would be great, if you could fix this.
Also, we need to disable detekt-formatting entirely, which means, we need to remove the declarations of it from various places:

• Gradle version catalog file (gradle/libs.versions.toml)
• Gradle kotlin convention file (buildSrc/src/main/groovy/bigbone.kotlin-conventions.gradle), lines 7-9
• Remove the formatting rules from the detekt config file (config/detekt/detekt.yml)

detekt as a tool should remain in place, we just want to remove the detekt-formatting functionality.

[G10xy]

After doing a bit of research, I think we should keep detekt as a tool for code analysis, but use ktlint Gradle plugin for linting. Especially after reading this: detekt/detekt#5997

I have added two minor comments to your PR. Would be great, if you could fix this. Also, we need to disable detekt-formatting entirely, which means, we need to remove the declarations of it from various places:

* Gradle version catalog file (`gradle/libs.versions.toml`)

* Gradle kotlin convention file (`buildSrc/src/main/groovy/bigbone.kotlin-conventions.gradle`), lines 7-9

* Remove the formatting rules from the detekt config file (`config/detekt/detekt.yml`)

detekt as a tool should remain in place, we just want to remove the detekt-formatting functionality.

Thanks, I honestly did not know so deeply about.

[andregasser]

Everything looks good! Thank you very much 👍