https://github.com/k4zy/danger-findbugs

FindBugs plugin for Danger
https://github.com/k4zy/danger-findbugs

danger danger-plugin

Last synced: 4 months ago
JSON representation

FindBugs plugin for Danger

• Host: GitHub
• URL: https://github.com/k4zy/danger-findbugs
• Owner: k4zy
• License: mit
• Created: 2017-05-07T14:13:52.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T22:29:04.000Z (over 1 year ago)
• Last Synced: 2024-02-29T04:12:51.106Z (4 months ago)
• Topics: danger, danger-plugin
• Language: Ruby
• Homepage:
• Size: 53.7 KB
• Stars: 9
• Watchers: 0
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-danger - danger-findbugs - Danger plugin for FindBugs formatted XML file. (Plugins / Ruby (danger))

README

        
# danger-findbugs

[![Gem Version](https://badge.fury.io/rb/danger-findbugs.svg)](https://badge.fury.io/rb/danger-findbugs)

Danger plugin for findbugs formatted xml file.

## Installation

    $ gem install danger-findbugs

## Usage

Checks on your gradle project's Java source files.

This is done using [finbugs](http://findbugs.sourceforge.net/)

Results are passed out as tables in markdown.

Running Findbugs with its basic configuration

  

findbugs.report



Running Findbugs with a specific gradle task or report_file

  

findbugs.gradle_task = "app:findbugs" #defalut: findbugs

findbugs.report_file = "app/build/reports/findbugs/findbugs.xml"

findbugs.report



#### Attributes

`gradle_module` - Custom gradle module to run.

This is useful when your project has different flavors.

Defaults to "app".

`gradle_modules` - Custom multiple gradle module to run.

Defaults to "[`gradle_module`]".

`gradle_task` - Custom gradle task to run.

This is useful when your project has different flavors.

Defaults to "findbugs".

`gradle_project` - Custom gradle project directory.

Defaults is repository's root directory.

`report_file` - Location of report file

If your findbugs task outputs to a different location, you can specify it here.

Defaults to "build/reports/findbugs_report.xml".

#### Methods

`report` - Calls findbugs task of your gradle project.

It fails if `gradlew` cannot be found inside current directory.

It fails if `report_file` cannot be found inside current directory.

`target_files` - A getter for current updated files

`exec_gradle_task` - Run gradle task

`gradlew_exists?` - Check gradlew file exists in current directory

`report_file_exist?` - Check report_file exists in current directory

`findbugs_report` - A getter for `gradle_task`, returning "findbugs" if value is nil.

`bug_issues` - A getter for `gradle_task`, returning "findbugs" if value is nil.

`send_inline_comment` - Send inline comment with danger's warn or fail method