README

grunt-cfpathcheck

Grunt wrapper for cfpathcheck

About grunt-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.

Getting Started

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-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-cfpathcheck');

The "cfpathcheck" task

Overview

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.
    },
  },
})

Options

options.reporter

Type: String Default value: console

The preferred reporter style that will be used in stdout.

options.outFile

Type: String Default value: undefined

The path to the desired output file containing the checkstyle-compatible result data.

Usage Examples

Default Options

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': '..'
    },
  },
})

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.

grunt.initConfig({
  cfpathcheck: {
    options: {
      reporter: 'checkstyle',
      outFile: 'path/to/results.xml',
    },
    files: {
      'src': '..'
    },
  },
})

Contributing

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.

Release History

See CHANGELOG.

grunt-cfpathcheckdeprecated

Usage no npm install needed!