Skip to content
billtudor edited this page Nov 13, 2014 · 24 revisions

CFLint


A static code analysis tool for ColdFusion (in the spirit of FindBugs and Lint)

Can you use it today? Functional? Yes Mature, flawless? No, you can help:

  • Report an issue
  • Join the mailing list on Nabble CFLint

To build, it is recommended you read the build-instructions.

See the Jenkins/Hudson plugin here.

Someone has created a SublimeLinter plugin here.

Ray Camden created a CFBuilder plugin here and blogs about CFLint here.

Quick Start

cflint --folder <somefolder> 
open cflint-result.html in your browser

Usage

cflint --folder c:\source\cfmx
cflint-ui
cflint --help

Requirements/Dependencies

You will need to have:
      A JDK (not JRE) installed because you also 
      Maven (apache-maven-3.2.3.zip) from org.apapche
  gpg4Win.zip	[PGP software]-should you require GPG 
  log4j configured on your machine

Ensure your Java is at a suitable version (minimum 1.6, 1.7 preferred) Ensure you have a Java SDK available (Maven can't build off a JRE alone) Install Win4GPG (or Mac equivalent) Create a PGP Certificate (Maven finds this automatically when building CFlint and requires it) note: Newer version of CFLint may not require this Install Maven (again alter the M2_HOME and/or M2 env.vars) (excellent instructions on the Maven site) Download and unzip CFLint.zip (from GitHub) or use Git to install Run mvn clean install

Check build output for errors - should see BUILD SUCCESSFUL at the end

Quick way to get a text file output:

    if you are using the cflint-ui.bat (or unix cflint-ui),
    cflint-ui.bat -textfile 
    example:
    cflint-ui.bat -textfile c:\temp\out.txt