uber/piranha

[PiranhaJava] Update sample project to show option for excluding additional EP checks

Open

#103 opened on Oct 21, 2020

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Java (2,143 stars) (178 forks)batch import
good first issuelegacy-java

Description

In the past we have made PR's to Piranha to support additional usage patterns.

While integrating Piranha with multiple java micro services in our organisation, we are noticing lots of Error prone reported violations on our micro-service project and it becomes a hard dependency to fix the violations before integrating Piranha.

For new projects, we can add Error Prone as a dependency from beginning and get going. But for existing services, fixing the error prone violations is becoming hard.

Question:

  1. is it possible to run Piranha without Error Prone as a mandatory dependency in build system?
  2. If not, is it possible to suppress the Error Prone violation as warning instead of build errors?
  3. iI it possible to exclude specific packages from Error Prone scan? (Like available configurations available in Jacoco/find bug and so on)

Contributor guide

Tech stack
java
Domain
tooling
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaMaven or GradleError PronePiranha
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the build configuration in the sample project (e.g., pom.xml or build.gradle). Review PR #32 for previous exclusion patterns. Check if Piranha supports optional Error Prone dependency. Provide guidance on how to exclude specific packages from Error Prone scanning in the sample project's documentation.