grunt-phploc
v0.1.3
Published
Grunt plugin for running phploc.
Readme
grunt-phploc 
Grunt plugin for running phploc.
Getting Started
This plugin requires Grunt 0.4.0.
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:
- Install this grunt plugin with the following command:
npm install grunt-phploc --save-dev- Install phploc (preferably with composer)
composer install- Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-phloc');The "phploc" task
Overview
In your project's Gruntfile, add a section named phploc to the data object passed into grunt.initConfig().
grunt.initConfig({
phploc: {
default: {
dir: 'src'
}
options: {
// Options go here.
},
},
});Target Properties
dir
Type: String or Array
The directory where phploc should be run.
Options
options.bin
Type: String Default: 'phploc'
The executable binary.
options.names
Type: String Default: *.php
A comma-separated list of file names to check.
options.namesExclude
Type: Array Default: undefined
A comma-separated list of file names to exclude.
options.countTests
Type: Boolean Default: false
Count PHPUnit test case classes and test methods.
options.exclude
Type: String Default: false
Exclude a directory from code analysis.
options.logCSV
Type: String Default: undefined
Write result in CSV format to file.
options.logXML
Type: String Default: undefined
Write result in XML format to file.
options.progress
Type: Boolean Default: false
Show progress bar.
options.quiet
Type: Boolean Default: false
Do not output any message.
options.verbose
Type: Boolean Default: false
Increase the verbosity of messages.
options.ansi
Type: Boolean Default: false
Force ANSI output.
options.noansi
Type: Boolean Default: false
Disable ANSI output.
options.nointeraction
Type: Boolean Default: false
Do not ask any interactive question.
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
(Nothing yet)