Add file annotations rule #714
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
t-kameyama
force-pushed
the
issue_689
branch
2 times, most recently
from
764119a to
797749d
Compare
t-kameyama
force-pushed
the
issue_689
branch
4 times, most recently
from
b1b8560 to
33b22a2
Compare
romtsn
reviewed
May 26, 2020
| @@ -30,6 +37,7 @@ class AnnotationRule : Rule("annotation") { | |||
| "Multiple annotations should not be placed on the same line as the annotated construct" | |||
| const val annotationsWithParametersAreNotOnSeparateLinesErrorMessage = | |||
| "Annotations with parameters should all be placed on separate lines prior to the annotated construct" | |||
| const val fileAnnotationsShouldBeSeparated = "File annotations should be separated from packages with a blank line" | |||
There was a problem hiding this comment.
Following up from #747, I think the wording should be a bit different, cause there's not necessarily a package coming after a file annotation (e.g. in .kts files). So maybe change it to from file contents or something like that.
romtsn
reviewed
May 26, 2020
| if (lineNumber != null && nextLineNumber != null) { | ||
| val diff = nextLineNumber - lineNumber | ||
| if (diff < 2) { | ||
| emit(0, fileAnnotationsShouldBeSeparated, true) |
There was a problem hiding this comment.
Hm, what if there's a license header above the file annotation, then I guess 0 offset is not correct anymore? According to codestyle, there can be something on top of the annotation.
romtsn
approved these changes
May 26, 2020
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Fixes #689