SublimeLinter-contrib-CFLint
SublimeLinter plugin for Adobe ColdFusion, using CFLint.
Details
Installs
- Total 2K
- Win 985
- Mac 444
- Linux 105
Oct 6 | Oct 5 | Oct 4 | Oct 3 | Oct 2 | Oct 1 | Sep 30 | Sep 29 | Sep 28 | Sep 27 | Sep 26 | Sep 25 | Sep 24 | Sep 23 | Sep 22 | Sep 21 | Sep 20 | Sep 19 | Sep 18 | Sep 17 | Sep 16 | Sep 15 | Sep 14 | Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | Aug 23 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
SublimeLinter-contrib-CFLint
This linter plugin for SublimeLinter 3 provides an interface to CFLint. It will be used with files that have the CFML syntax.
Installation
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Linter installation
Before using this plugin, you must ensure that CFLint and SublimeText-CFML are installed on your system.
To install CFLint, do the following:
- Download and install latest Java SE 8+ JRE, or JDK if you plan to build it yourself.
- Download latest CFLint standalone JAR (
CFLint-1.2.0-all.jar
or newer) from the GitHub releases or Maven repository. Alternatively, build it yourself using these instructions. This is the JAR file that will be provided tojar_file
in the settings.
To install SublimeText-CFML, do the following:
- Follow the instructions from jcberquist/sublimetext-cfml.
Plugin installation
Please use Package 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:
Within Sublime Text, bring up the Command Palette and type
install
. 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.When the plugin list appears, type
cflint
. Among the entries, you should seeSublimeLinter-contrib-CFLint
. If that entry is not highlighted, use the keyboard or mouse to select it.
Settings
For general information on how SublimeLinter 3 works with settings, please see Settings. For information on standard linter settings, please see Linter Settings.
Plugin-specific 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 the CFLint 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.
Contributing
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
master
. - Commit and push the topic branch.
- Make a pull request.
- 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!