Repository files navigation

This linter plugin forSublimeLinter 3 provides an interface toCFLint. It will be used with files that have theCFML syntax.

SublimeLinter 3 must be installed in order to use this plugin. IfSublimeLinter 3 is not installed, please follow the instructionshere.

Before using this plugin, you must ensure thatCFLint andSublimeText-CFML are installed on your system.

To installCFLint, do the following:

1. Download and install latestJava SE 8+JRE, orJDK if you plan to build it yourself.
2. Download latestCFLint standalone JAR (CFLint-1.2.0-all.jar or newer) from theGitHub releases orMaven repository. Alternatively, build it yourself usingthese instructions. This is the JAR file that will be provided tojar_file in the settings.

To installSublimeText-CFML, do the following:

1. Follow the instructions fromjcberquist/sublimetext-cfml.

Please usePackage Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

1. Within Sublime Text, bring up theCommand Palette and typeinstall. Among the commands you should seePackage Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

2. When the plugin list appears, typecflint. Among the entries, you should seeSublimeLinter-contrib-CFLint. If that entry is not highlighted, use the keyboard or mouse to select it.

For general information on howSublimeLinter 3 works with settings, please seeSettings. For information on standard linter settings, please seeLinter Settings.

Once you have installed both the SublimeLinter 3 and SublimeLinter-contrib-CFLint plugins you will need to edit the CFLint settings.

Preferences > Package Settings > SublimeLinter > Settings

You will see a CFLint section under the user settings (SublimeLinter.sublime-settings -- User):

"linters": {    "cflint": {        "@disable": false,        "args": [],        "aux_config_dirs": [],        "config_file_name": "cflintrc.xml",        "excludes": [],        "jar_file": ""    }},

Add the full path to your CFLint JAR file and optionally add config file information:

• jar_file (required): This must contain the absolute path to theCFLint-*-all.jar file.
• config_file_name (optional): This must contain just the file name for theCFLint config file. [default:.cflintrc]
• aux_config_dirs (optional): An array of paths that will act as auxiliary directories in which to search for the config file if not found for the file being linted.

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latestmaster.
3. Commit and push the topic branch.
4. Make a pull request.
5. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

• Indent is 4 spaces.
• Code should pass flake8 and pep257 linters.
• Vertical whitespace helps readability, don’t be afraid to use it.
• Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!