grpc-java-api-checker

An Error Prone plugin that checks for usages of grpc-java APIs.

License	The Apache Software License, Version 2.0
Categories	Java Languages gRPC Net Networking
GroupId	com.github.jyane
ArtifactId	grpc-java-api-checker
Last Version	0.1
Release Date	Jan 28, 2018
Type	jar
Description	grpc-java-api-checker An Error Prone plugin that checks for usages of grpc-java APIs.
Project URL	https://github.com/jyane/grpc-java-api-checker
Source Code Management	https://github.com/jyane/grpc-java-api-checker

Download grpc-java-api-checker

Filename	Size
grpc-java-api-checker-0.1.pom
grpc-java-api-checker-0.1.jar	8 KB
grpc-java-api-checker-0.1-sources.jar	7 KB
grpc-java-api-checker-0.1-javadoc.jar	31 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.jyane/grpc-java-api-checker/ -->
<dependency>
    <groupId>com.github.jyane</groupId>
    <artifactId>grpc-java-api-checker</artifactId>
    <version>0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.jyane/grpc-java-api-checker/
implementation 'com.github.jyane:grpc-java-api-checker:0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.jyane/grpc-java-api-checker/
implementation ("com.github.jyane:grpc-java-api-checker:0.1")

Apache Buildr

'com.github.jyane:grpc-java-api-checker:jar:0.1'

Apache Ivy

<dependency org="com.github.jyane" name="grpc-java-api-checker" rev="0.1">
  <artifact name="grpc-java-api-checker" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.jyane', module='grpc-java-api-checker', version='0.1')
)

Scala SBT

libraryDependencies += "com.github.jyane" % "grpc-java-api-checker" % "0.1"

Leiningen

[com.github.jyane/grpc-java-api-checker "0.1"]

Dependencies

compile (2)

Group / Artifact	Type	Version
com.google.auto.service : auto-service Optional	jar	1.0-rc2
com.google.guava : guava Optional	jar	23.0

provided (1)

Group / Artifact	Type	Version
com.google.errorprone : error_prone_core	jar	2.2.0

test (2)

Group / Artifact	Type	Version
junit : junit	jar	4.12
com.google.errorprone : error_prone_test_helpers	jar	2.2.0

Project Modules

There are no modules declared in this project.

grpc-java-api-checker

An Error Prone plugin that checks for usages of grpc-java APIs that are annotated with @ExperimentalApi or @Internal.

NOTE: grpc-java-api-checker works with grpc-java version 1.10.0 or greater.

The error examples:

src/main/java/com/example/App.java:10: error: [GrpcInternal] @Internal should not be used in application code
    System.out.println(InternalStatus.MESSAGE_KEY);
                       ^
    (see https://github.com/grpc/grpc-java)

src/main/java/com/example/App.java:11: error: [GrpcExperimentalApi] @ExperimentalApi should not be used in application code
    System.out.println(Grpc.TRANSPORT_ATTR_REMOTE_ADDR);
                           ^
    (see "https://github.com/grpc/grpc-java/issues/1710")

Usage

Using the grpc-java-api-checker requires configuring your project to build with the Error Prone Java compiler. You can see the Error Prone documents here.

Examples

Maven

The example is here

cd examples/
mvn compile

Gradle

The example is here

cd examples/
./gradlew compileJava

Bazel

The example is here

cd examples/
bazel build //...

Build and Test

# Compile
mvn compile

# Test
mvn test

# Build
mvn build

# Publish to Local
mvn install

Versions

Version
0.1 Jan 28, 2018