-
Notifications
You must be signed in to change notification settings - Fork 112
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
1. Fixed a bug when adding extra spaces after the parameter name. 2. Fixed a bug when using comment-like text in string literals. #1301
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
128 changes: 128 additions & 0 deletions
128
qulice-checkstyle/src/main/java/com/qulice/checkstyle/MultiLineCommentCheck.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| * Copyright (c) 2011-2024 Qulice.com | ||
| * | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions | ||
| * are met: 1) Redistributions of source code must retain the above | ||
| * copyright notice, this list of conditions and the following | ||
| * disclaimer. 2) Redistributions in binary form must reproduce the above | ||
| * copyright notice, this list of conditions and the following | ||
| * disclaimer in the documentation and/or other materials provided | ||
| * with the distribution. 3) Neither the name of the Qulice.com nor | ||
| * the names of its contributors may be used to endorse or promote | ||
| * products derived from this software without specific prior written | ||
| * permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT | ||
| * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND | ||
| * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL | ||
| * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, | ||
| * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
| * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
| * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
| * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
| * OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
| package com.qulice.checkstyle; | ||
|
|
||
| import com.puppycrawl.tools.checkstyle.api.AbstractCheck; | ||
| import com.puppycrawl.tools.checkstyle.api.DetailAST; | ||
| import com.puppycrawl.tools.checkstyle.api.TokenTypes; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| /** | ||
| * Multi line comment checker. | ||
| * Used by the checkstyle process multiple times as a singleton. | ||
| * @since 0.23.1 | ||
| */ | ||
| public final class MultiLineCommentCheck extends AbstractCheck { | ||
| /** | ||
| * Pattern for check. | ||
| * It is not final as it is initialized from the configuration. | ||
| */ | ||
| private Pattern format = Pattern.compile("^$"); | ||
|
|
||
| /** | ||
| * The message to report for a match. | ||
| * It is not final as it is initialized from the configuration. | ||
| */ | ||
| private String message = ""; | ||
|
|
||
| /** | ||
| * Comment line. | ||
| * It is not final because the visitToken method is called many times | ||
| * during the class under test and the field is reinitialized with a new object. | ||
| */ | ||
| @SuppressWarnings("PMD.AvoidStringBufferField") | ||
| private StringBuilder text; | ||
|
|
||
| @Override | ||
| public boolean isCommentNodesRequired() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public int[] getDefaultTokens() { | ||
| return new int[]{ | ||
| TokenTypes.BLOCK_COMMENT_BEGIN, | ||
| TokenTypes.COMMENT_CONTENT, | ||
| TokenTypes.BLOCK_COMMENT_END, | ||
| }; | ||
| } | ||
|
|
||
| @Override | ||
| public int[] getAcceptableTokens() { | ||
| return this.getDefaultTokens(); | ||
| } | ||
|
|
||
| @Override | ||
| public int[] getRequiredTokens() { | ||
| return this.getDefaultTokens(); | ||
| } | ||
|
|
||
| @Override | ||
| public void visitToken(final DetailAST ast) { | ||
| if (ast.getType() == TokenTypes.BLOCK_COMMENT_BEGIN) { | ||
| this.text = new StringBuilder(ast.getText()); | ||
| } else if (ast.getType() == TokenTypes.COMMENT_CONTENT) { | ||
| this.text.append(ast.getText()); | ||
| } else { | ||
| this.text.append(ast.getText()); | ||
| final Matcher matcher = this.format.matcher(this.text.toString()); | ||
| if (matcher.matches()) { | ||
| this.log(ast, this.message); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The method is called from checkstyle to configure this class. | ||
| * The parameter is set from the checks.xml file | ||
| * <module name="com.qulice.checkstyle.MultiLineCommentCheck"/> and | ||
| * <property name="format" value=" this regexp "/> property | ||
| * | ||
| * @param fmt Validatig regexp. | ||
| */ | ||
| public void setFormat(final String fmt) { | ||
| this.format = Pattern.compile(fmt); | ||
| } | ||
|
|
||
| /** | ||
| * The method is called from checkstyle to configure this class. | ||
| * The parameter is set from the checks.xml file | ||
| * <module name="com.qulice.checkstyle.MultiLineCommentCheck"/> and | ||
| * <property name="message" value="First sentence in a comment should start with ....."/> | ||
| * property | ||
| * | ||
| * @param msg Error message. | ||
| */ | ||
| public void setMessage(final String msg) { | ||
| this.message = msg; | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@PeJetuz I understand why you need to add setters, but in general it is a bad practice.
I suggest to add at least some javadocs that would explain why we need them and why we can't remove them from the code base. It will preserve them from the future removal. The same is relevant for
SingleLineCommentCheckThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@volodya-lombrozo Thanks! I added a description in the comments to the methods.