[JEWEL] Update Detekt and enable checks for public surface documentation #3395
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
faogustavo
requested review from
DanielSouzaBertoldi,
daaria-s,
nebojsa-vuksic,
rock3r and
wellingtoncosta
Comment on lines
+18
to
+19
| KtPsiFactory(root.project) | ||
| .createPhysicalFile(fileName = root.name, text = root.modifiedText ?: root.text) |
Collaborator
There was a problem hiding this comment.
Don't we need to remove this copy after the autocorrect is done running?
| Finding( | ||
| Entity.from(declaredFunction), | ||
| "Function ${declaredFunction.name} is missing property $prop.", | ||
| suppressReasons = listOfNotNull("Auto correct".takeIf { autoCorrect }), |
Collaborator
There was a problem hiding this comment.
nit: create a const val with the "Auto correct" string
|
|
||
| private val functionsToCheck: List<String> by config(defaultValue = listOf("equals", "hashCode", "toString")) | ||
|
|
||
| @Configuration("only check classes annotated with these annotations") |
Collaborator
There was a problem hiding this comment.
What's up with this @Configuration annotation?
DanielSouzaBertoldi
force-pushed
the
gv/bump-detekt
branch
from
7c9e4cc to
38bdbb8
Compare
- The initial idea of this PR was basically to start using the existing detekt rules to ensure we add public documentation. They are: - OutdatedDocumentation - UndocumentedPublicClass - UndocumentedPublicFunction - UndocumentedPublicProperty - But, when one of these conditions matches, the version 1.x from detekt considers it a failure and crashes the run - In this initial moment, my goal was to enable as "warning" level and reuse that information to log in the PR in case it's related to any touched code - However, some features like setting the minimum version to "break" is only added in the 2.x version of detekt
DanielSouzaBertoldi
force-pushed
the
gv/bump-detekt
branch
from
38bdbb8 to
ac9a0fc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
JewelBaseRuleandJewelRuleSetProvider.initNote
TL;DR; The work is like 60~65% done. We need to revisit the documentation for v2 and update our config file to ensure we have everything under control. After wrapping up the detekt, we will need to get the report and combine with the changes in the PR to identify which entries the PR could resolve.