org.codenarc.rule.formatting.ConsecutiveBlankLinesRule.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation

The CodeNarc project provides a static analysis tool for Groovy code.

There is a newer version: 3.5.0-groovy-4.0

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.codenarc.rule.formatting

import org.codenarc.rule.AbstractRule
import org.codenarc.rule.Violation
import org.codenarc.source.SourceCode

/**
 * Makes sure there are no consecutive lines that are either blank or whitespace only.
 *
 * @author Joe Sondow
 */
class ConsecutiveBlankLinesRule extends AbstractRule {

    String name = 'ConsecutiveBlankLines'
    int priority = 3

    /**
     * Apply the rule to the given source, writing violations to the given list.
     *
     * @param sourceCode the source to check
     * @param violations a list of Violations that may be added to. It can be an empty list
     */
    @Override
    void applyTo(SourceCode sourceCode, List violations) {
        List lines = sourceCode.getLines()
        for (int index = 1; index < lines.size(); index++) {
            String line = lines[index]
            if (line.trim().isEmpty() && lines[index - 1].trim().isEmpty()) {
                violations.add(createViolation(index, line, "File $sourceCode.name has consecutive blank lines"))
            }
        }
    }
}