watanavex / chikuwa

Danger Plugin for reporting Android build errors and warnings

danger-chikuwa

Danger Plugin for reporting Android build errors and warnings

Installation

Add this line to your Gemfile:

gem danger-chikuwa

Usage

Redirect the standard and error output of the command line build to a text file. Change the build flavor as needed.

$ ./gradlew assembleDebug 2>&1 | tee build.log

Add a line to your Dangerfile.

chikuwa.report "build.log"

Optionally supports inline comments.

chikuwa.inline_mode = true

Here is a sample repository.
watanavex/android-check-for-chikuwa#5

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.

What is Chikuwa?

Chikuwa is my family❤️

chikuwa's Issues

[Feature Request] Consider adding more information to non-inlined comments

First of all great tool! 💪🏻

We are aiming to use this just for errors. The most common case for us is when production code is altered but the author is forgetting to refactor unit-tests based on the changes of production code. In that case a non-inlined comment will be posted to PR since the unit-tests have not been altered yet. This comment though contains very little information in regards to where the error is located.

So it would be nice to maybe:

• Include the filename & maybe line/column where the compilation error is located
• Add a hyperlink to the above so it would point to a VSC-valid link which the author of the PR can use to navigate to the error as quick as possible

I will use this to better demonstrate what I'm thinking about. So the comment could be:

MainActivity.kt#L24 Unresolved reference: chikuwa

Inline-comment configuration is call-order-sensitive

The following will not enable inline-comments:

chikuwa.report build_log_filename
chikuwa.inline_mode = true

but this will:

chikuwa.inline_mode = true
chikuwa.report build_log_filename

So it seems that chikuwa.inline_mode = true needs to be first in call-order in order to work, but it's not made clear in the documentation.