allow long lines in block comments and whole strings #84
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
jflinchbaugh
commented
Nov 22, 2024
| <!-- Allow longer lines in comments. --> | ||
| <property name="ignorePattern" value="^ \*.*"/> | ||
| <!-- Allow longer lines in block comments and whole string literals --> | ||
| <property name="ignorePattern" value='^ +\*|"[^"]{100,}"'/> |
There was a problem hiding this comment.
fix: allow 1 or more space in block comments, so it works for block comments at any level.
new: if the line is mostly a string of more than 100 characters, then leave it. these are often test inputs.
There was a problem hiding this comment.
examples that are allowed now for line length:
/**
* javadoc comments for fields and methods, not just class-level
*/
strings without unnecessary breaks:
String id =
"pkg:hf-model/org/repo/path%2Fto%2Fmodel@commit-hash?classifier=format&sonatype_repository=huggingface.co&type=ext";
parameters in CSV format in data-driven tests:
@CsvSource({
"conan, cctz, 2.3, , , pkg:conan/[email protected]?sonatype_naming_authority=conan",
"bincrafters, cctz, 2.3, bincrafters, stable, pkg:conan/bincrafters/[email protected]?channel=stable&sonatype_naming_authority=bincrafters"
})
if it's a shorter string in a long parameter list or something, that could be wrapped sensibly, then it's still triggered.
bradcupit
approved these changes
Dec 5, 2024
madgetr
approved these changes
Dec 5, 2024
mattjohnson
approved these changes
Dec 5, 2024
mpuglin
approved these changes
Dec 5, 2024
jflinchbaugh
commented
Dec 5, 2024
| <groupId>com.puppycrawl.tools</groupId> | ||
| <artifactId>checkstyle</artifactId> | ||
| <version>8.42</version> | ||
| </dependency> |
There was a problem hiding this comment.
default checkstyle that comes with the plugin is fine.
jflinchbaugh
commented
Dec 5, 2024
| <dependency> | ||
| <groupId>com.sonatype</groupId> | ||
| <artifactId>checkstyle-checks</artifactId> | ||
| <version>15</version> | ||
| <version>20</version> |
There was a problem hiding this comment.
20 will be the next release.
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.
fix a bug: javadocs deeper than class-level were note allowed to go long like class-level docs would.
enhancement: long, contiguous strings are allowed without requiring introduction of messy breaks.