com.cflint.plugins.core.FileCaseChecker Maven / Gradle / Ivy

Go to download

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

A static code analysis tool for ColdFusion (in the spirit of FindBugs and Lint). With CFLint, you are able to analyze your ColdFusion code base for code violations.

There is a newer version: 1.5.0

Show newest version

package com.cflint.plugins.core;

import com.cflint.BugInfo;
import com.cflint.BugList;
import com.cflint.plugins.CFLintScannerAdapter;

import ro.fortsoft.pf4j.Extension;

@Extension
public class FileCaseChecker extends CFLintScannerAdapter {

    @Override
    public void startFile(final String fileName, final BugList bugs) {
        String actualFileName = fileName;
        final String separator = System.getProperty("file.separator");
        final int seperatorPosition = fileName.lastIndexOf(separator);

        if (seperatorPosition >= 0) {
            actualFileName = fileName.substring(seperatorPosition + 1);
        }

        if (actualFileName.contains(".cfm")) {
            if (Character.isUpperCase(actualFileName.charAt(0))) {
                bugs.add(new BugInfo.BugInfoBuilder().setLine(1).setMessageCode("FILE_SHOULD_START_WITH_LOWERCASE")
                        .setFilename(fileName)
                        .setMessage("File " + actualFileName
                                + " starts with an upper case letter. Only components (.cfc files) should start with an upper case letter.")
                        .build());
            }
        }
    }
}