Grunt wrapper for cfpathcheck
> 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.
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:
``shell`
npm install grunt-cfpathcheck --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-cfpathcheck');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
cfpathcheck: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
`$3
#### options.reporter
Type:
Default value: The preferred reporter style that will be used in stdout.
#### options.outFile
Type:
Default value: The path to the desired output file containing the checkstyle-compatible result data.
$3
#### Default Options
In this example, the default options are used to output analysis results to stdout, without saving the results to a file.
js
grunt.initConfig({
cfpathcheck: {
options: {},
files: {
'src': '..'
},
},
})
`#### Custom Options
In this example, custom options are used to output checkstyle-compatible xml to stdout and write the results to a file as well.
js
grunt.initConfig({
cfpathcheck: {
options: {
reporter: 'checkstyle',
outFile: 'path/to/results.xml',
},
files: {
'src': '..'
},
},
})
``| 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 |