# besu-errorprone-checks

**Repository Path**: hyperledger/besu-errorprone-checks

## Basic Information

- **Project Name**: besu-errorprone-checks
- **Description**: Besu
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-09-03
- **Last Updated**: 2025-01-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Besu custom error-prone checks
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/hyperledger/besu-errorprone-checks/blob/main/LICENSE)
[![Discord](https://img.shields.io/discord/905194001349627914?logo=Hyperledger&style=plastic)](https://discord.gg/hyperledger)
[![Twitter Follow](https://img.shields.io/twitter/follow/HyperledgerBesu)](https://twitter.com/HyperledgerBesu)

This repository contains custom error-prone checks for [Hyperledger Besu](https://github.com/hyperledger/besu/).

## Usage
These [custom error-prone checks](https://errorprone.info/docs/plugins) are used in the Besu codebase. To use these checks in your project:

1. Add the following repository definition to your gradle file:
```groovy
  repositories {
    maven {
        url 'https://hyperledger.jfrog.io/hyperledger/besu-maven'
        content { includeGroupByRegex('org\\.hyperledger\\..*') }
    }
  }
```
2. Add the following dependency to your gradle file:
```groovy
dependencies {
    errorprone("org.hyperledger.errorpronechecks:besu-errorprone-checks:1.0.0")
}
```

The creation of custom errorprone checkers was largely derived from:
* https://github.com/tbroyer/gradle-errorprone-plugin
* https://errorprone.info/docs/installation
* https://github.com/google/error-prone/wiki/Writing-a-check

To allow for debugging from within intellij, the following must be added to the VM args
in the run/debug configuration (this assumes your gradle cache is at the default location under
your home):
`-Xbootclasspath/p:${HOME}/.gradle/caches/./modules-2/files-2.1/com.google.errorprone/javac/9+181-r4173-1/bdf4c0aa7d540ee1f7bf14d47447aea4bbf450c5/javac-9+181-r4173-1.jar`