phpmetrix/readme.md

phpmetrix for Node.js is a wrapper around phpmetrics that allows for integration with build systems like Grunt, Gulp and more!

## phpmetrix

> phpmetrix is a node wrapper around phpmetrics that provides integration with build systems like
> [Grunt](http://gruntjs.com/), [Gulp](http://gulpjs.com/) and more.

[![npm](https://img.shields.io/npm/v/phpmetrix.svg?style=flat)](https://www.npmjs.com/package/phpmetrix)
[![Build Status](https://travis-ci.org/dcarrith/phpmetrix.svg?branch=master)](https://travis-ci.org/dcarrith/phpmetrix)
[![Dependency Status](https://david-dm.org/dcarrith/phpmetrix.svg)](https://david-dm.org/dcarrith/phpmetrix)
[![devDependency Status](https://david-dm.org/dcarrith/phpmetrix/dev-status.svg)](https://david-dm.org/dcarrith/phpmetrix#info=devDependencies)
[![Coverage Status](https://coveralls.io/repos/github/dcarrith/phpmetrix/badge.svg?branch=master)](https://coveralls.io/github/dcarrith/phpmetrix?branch=master)
[![npm](https://img.shields.io/npm/l/express.svg)]()

```sh
$ npm i -g phpmetrix
$ phpmetrix path/to/config.yml
```

### Node

```js
var phpmetrix = require('phpmetrix').phpmetrix

phpmetrix(['path/to/config.yml'], function (err, stdout, stderr) {
  if (err) throw new Error(err)

  process.stdout.write(stdout)
  process.stderr.write(stderr)

  // success!
})
```

### NPM

```json
{
  "scripts": {
    "pretest": "phpmetrix path/to/config.yml"
  },
  "devDependencies": { }
}
```

```sh
$ npm test
```

### Grunt


```js
module.exports = function (grunt) {
  require('phpmetrix').gruntPlugin(grunt)

  grunt.initConfig({
    phpmetrix: {
      config: 'path/to/config.yml',
      options: {
        phpCmd: '/usr/local/bin/php', // Defaults to php
        phpmetricsCmd: '/usr/local/bin/phpmetrics', // Defaults to phpmetrics
        stdout: true,
        stderr: true
      }
    }
  })

  grunt.registerTask('test', ['phpmetrix'])

}
```

```sh
$ grunt test
```

### Gulp

The same options that can be used in Grunt can be used in Gulp too.

```js
var gulp = require('gulp')
var phpmetrics = require('phpmetrix').phpmetrics

gulp.task('phpmetrix', function (cb) {
  phpmetrix(['path/to/config.yml'], function (err, stdout, stderr) {
    if (err) {
      cb(err)
      process.exit(1)
    }
    cb()
  })
})

gulp.task('test', ['phpmetrix'])
```

```sh
$ gulp test
```

#### License

[MIT](http://opensource.org/licenses/MIT) © [David Carrithers](https://github.com/dcarrith)