SpotlessCF

A CFML wrapper for the "Spotless" java library which provides code formatting over many many languages.

See Spotless on GitHub for more info.

Installation

1. Install this module. box install spotlessCF
2. Add the module's lib/ directory to your application's javaSettings.loadPaths:

this.javaSettings.loadPaths = [
    // ...
    expandPath( "/modules/spotlessCF/lib/spotless-lib-2.22.0/" )
];

Restart your app. The CF engine should "pick up" the spotless jar and load it into the application.

Configuration

There are two ways to configure spotlessCF module settings:

1. Using a .env file
2. Using Module Settings

Env File and commandbox-dotenv

# settings go here
SPOTLESS_SETTING=blabla

Module Settings

Add the following to config/ColdBox.cfc and update as necessary:

moduleSettings = {
    spotlessCF = {
        // settings go here
    }
}

API Docs

The spotlessCF class documentation is auto-generated via DocBox and hosted on Github Pages at michaelborn.github.io/spotlessCF/

Contributing

I could use help with this!

Thanks

Special thanks to the Spotless library. I could'na dunnit without ya. 😉