# Danger PMD

Danger plugin for PMD formatted xml file. This plugin is inspired from https://github.com/kazy1991/danger-findbugs.

## Installation

    $ gem install danger-pmd

## Usage

    Methods and attributes from this plugin are available in
    your `Dangerfile` under the `pmd` namespace.

<blockquote>Running PMD with its basic configuration
<pre>
pmd.report
</pre>
</blockquote>

<blockquote>Running PMD with a specific Gradle task or report file
<pre>
pmd.gradle_task = 'app:pmd' #defalut: pmd
pmd.report_file = "app/build/reports/pmd/pmd.xml"
pmd.report
</pre>
</blockquote>

<blockquote>Running PMD with an array of report files
<pre>
pmd.report_files = ["modules/**/build/reports/pmd/pmd.xml", "app/build/reports/pmd/pmd.xml"]
pmd.report
</pre>
</blockquote>

<blockquote>Running PMD without running a Gradle task
<pre>
pmd.skip_gradle_task = true
pmd.report
</pre>
</blockquote>

#### Attributes

`gradle_task` - Custom Gradle task to run.
This is useful when your project has different flavors.
Defaults to "pmd".

`skip_gradle_task` - Skip Gradle task.
If you skip Gradle task, for example project does not manage Gradle.

`report_file` - Location of report file
If your pmd task outputs to a different location, you can specify it here.
Defaults to "app/build/reports/pmd/pmd.xml".

`report_files` - Location of report files
If your pmd task outputs to a different location, you can specify it here.
Defaults to ["app/build/reports/pmd/pmd.xml]".

#### Methods

`report` - Calls PMD task of your Gradle project, send comment and return PMD issues.
It fails if `gradlew` cannot be found inside current directory.
It fails if `report_file` or `report_files` cannot be found inside current directory.

`gradle_task` - A getter for `gradle_task`, returning Gradle task report.

`skip_gradle_task` - A getter for `skip_gradle_task`.

`report_file` - A getter for `report_file`.

`report_files` - A getter for `report_files`.

## Development

1. Clone this repo
2. Run `bundle install` to setup dependencies.
3. Run `bundle exec rake spec` to run the tests.
4. Use `bundle exec guard` to automatically have tests run as you make changes.
5. Make your changes.