Grunt wrapper for cfpathcheck
cfpathcheck is a static code analysis utility for finding incorrect/missing file paths and unused imported taglib namespaces in cfml (Adobe ColdFusion/Lucee/Railo/OpenBD) files.
The grunt-cfpathcheck plugin for grunt integrates this analysis into the grunt process.
This plugin requires Grunt.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-cfpathcheck --save-devOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-cfpathcheck');In your project's Gruntfile, add a section named cfpathcheck to the data object passed into grunt.initConfig().
grunt.initConfig({
cfpathcheck: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})Type: String
Default value: console
The preferred reporter style that will be used in stdout.
Type: String
Default value: undefined
The path to the desired output file containing the checkstyle-compatible result data.
In this example, the default options are used to output analysis results to stdout, without saving the results to a file.
grunt.initConfig({
cfpathcheck: {
options: {},
files: {
'src': '..'
},
},
})In this example, custom options are used to output checkstyle-compatible xml to stdout and write the results to a file as well.
grunt.initConfig({
cfpathcheck: {
options: {
reporter: 'checkstyle',
outFile: 'path/to/results.xml',
},
files: {
'src': '..'
},
},
})In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
See CHANGELOG.
| Release | Min Node ver. | Support |
|---|---|---|
| 1.x | 4.0.0 | Obsolete |
| 2.x | 6.0.0 | Obsolete |
| 3.x | 8.0.0 | Obsolete |
| 4.x | 12.0.0 | Obsolete |
| 5.x | 12.0.0 | Obsolete |
| 6.x | 12.17.0 | Obsolete |
| 7.x | 14.13.0 | Obsolete |
| 8.x | 14.17.0 | Obsolete |
| 9.x | 16.14.0 | Obsolete |
| 10.x | 18.0.0 | Maintenance |
| 11.x | 20.0.0 | Current |
Copyright (c) 2015-2019 Tim Beadle. Licensed under the MIT license.