refactor: configure disable rules and remove pre-commit-hook #1127
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
Thanks for opening this pull request!
|
azlekov
changed the title
Codecov Report
@@ Coverage Diff @@
## master #1127 +/- ##
=========================================
Coverage 65.28% 65.28%
Complexity 2218 2218
=========================================
Files 122 122
Lines 9957 9957
Branches 1337 1337
=========================================
Hits 6500 6500
Misses 2945 2945
Partials 512 512 Continue to review full report at Codecov.
|
mtrezza
changed the title
|
🎉 This pull request has been released in version 2.0.1 |
|
🎉 This pull request has been released in version 2.0.1 |
2 similar comments
|
🎉 This pull request has been released in version 2.0.1 |
|
🎉 This pull request has been released in version 2.0.1 |
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.
New Pull Request Checklist
Issue Description
Looks like for contributors is hard to use spotless.
Wildcard imports
Contributors need to have setup ktlint on their IDEs to cover few particular formatting rules. One of these rules is for wildcard imports. On many projects this rule is disabled, as by default the IDE behaviour optimise the code using wildcard when needed, while ktlint enforce not to use the wildcard import and the build fail.
Spotless pre-commit hook
To use Spotless pre-commit hook, contributors must have configured
bashon their machines in order to give permissions to the hook to be executed. This was done using a custom Gradle task which generated the hook.Related issue: #1126, #1125
Closes: #1126
Closes: #1125
Approach
Wildcard imports
My suggestion is to disable this rule in order to simplify the contributors work. This rule is not crucial.
Details how to configure the ktlint and the IDE can be found here
Spotless pre-commit hook
Because using of pre-commit hook requires additional technical knowledge, effort and configuration over the contributor machine and because it's already documented in
CONTRIBUTING.mdhow to manually run the spotless my suggestion is to just remove the Gradle task, so there's no confusion because of misconfigurations.TODOs before merging
Add testsAdd changes to documentation (guides, repository pages, in-code descriptions)