org.codenarc.tool.GenerateCodeNarcRulesProperties.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 2011 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.tool

import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.codenarc.ruleregistry.PropertiesFileRuleRegistry

/**
 * Java application (main() method) that generates the 'codenarc-base-rules.properties' properties file.
 * This properties file contains  =  properties for all CodeNarc rules.
 *
 * @see org.codenarc.ruleregistry.PropertiesFileRuleRegistry
 *
 * @author Chris Mair
  */
class GenerateCodeNarcRulesProperties {

    protected static final String PROPERTIES_FILE = PropertiesFileRuleRegistry.PROPERTIES_FILE
    private static final Logger LOG = LoggerFactory.getLogger(GenerateCodeNarcRulesProperties)

    protected static String propertiesFile = PROPERTIES_FILE

    /**
     * Write out all current rules to the 'codenarc-base-rules.properties' properties file
     * @param args - command-line args (not used)
     */
    static void main(String[] args) {
        def sortedRules = GenerateUtil.createSortedListOfAllRules()
        LOG.debug("sortedRules=$sortedRules")
        def propertiesFile = new File(propertiesFile)
        propertiesFile.withWriter { writer ->
            writer.println '# CodeNarc Rules (see PropertiesFileRuleRegistry): ' + new Date()
            sortedRules.each { rule ->
                writer.println "${rule.name} = ${rule.class.name}"
            }
        }
        LOG.info("Finished writing ${sortedRules.size()} rules to $propertiesFile")
    }

}