com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation
Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard
There is a newer version: 10.18.1
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2020 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle.checks;

import java.util.regex.Pattern;

import com.puppycrawl.tools.checkstyle.StatelessCheck;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

/**
 * 
 * Checks for {@code TODO:} comments. Actually it is a generic
 * 
 * regular expression matcher on Java comments. To check for other patterns
 * in Java comments, set the {@code format} property.
 * 
 * 
 * Using {@code TODO:} comments is a great way to keep track of tasks that need to be done.
 * Having them reported by Checkstyle makes it very hard to forget about them.
 * 
 * 
 * 
 * Property {@code format} - Specify pattern to match comments against.
 * Default value is {@code "TODO:"}.
 * 
 * 
 * 
 * To configure the check:
 * 
 *  * <module name="TodoComment"/>
 * 
 * 
 * Example:
 * 
 *  * i++; // TODO: do differently in future   // violation
 * i++; // todo: do differently in future   // OK
 * 
 * 
 * To configure the check for comments that contain {@code TODO} and {@code FIXME}:
 * 
 *  * <module name="TodoComment">
 *   <property name="format" value="(TODO)|(FIXME)"/>
 * </module>
 * 
 * 
 * Example:
 * 
 *  * i++;   // TODO: do differently in future   // violation
 * i++;   // todo: do differently in future   // OK
 * i=i/x; // FIXME: handle x = 0 case         // violation
 * i=i/x; // FIX :  handle x = 0 case         // OK
 * 
 *
 * @since 3.0
 */
@StatelessCheck
public class TodoCommentCheck
        extends AbstractCheck {

    /**
     * A key is pointing to the warning message text in "messages.properties"
     * file.
     */
    public static final String MSG_KEY = "todo.match";

    /**
     * Specify pattern to match comments against.
     */
    private Pattern format = Pattern.compile("TODO:");

    @Override
    public boolean isCommentNodesRequired() {
        return true;
    }

    /**
     * Setter to specify pattern to match comments against.
     *
     * @param pattern
     *        pattern of 'todo' comment.
     */
    public void setFormat(Pattern pattern) {
        format = pattern;
    }

    @Override
    public int[] getDefaultTokens() {
        return getRequiredTokens();
    }

    @Override
    public int[] getAcceptableTokens() {
        return getRequiredTokens();
    }

    @Override
    public int[] getRequiredTokens() {
        return new int[] {TokenTypes.COMMENT_CONTENT };
    }

    @Override
    public void visitToken(DetailAST ast) {
        final String[] lines = ast.getText().split("\n");

        for (String line : lines) {
            if (format.matcher(line).find()) {
                log(ast, MSG_KEY, format.pattern());
            }
        }
    }

}