Gradle Checker Framework Plugin

Additional

Language
Groovy
Version
N/A
Created
Jun 2, 2017
Updated
Sep 24, 2018
Owner
Jared Burrows (jaredsburrows)
Contributors
Jared Burrows (jaredsburrows)
renatoathaydes
2
Activity
Badge
Generate
Download
Source code

Advertising

Gradle Checker Framework Plugin

This plugin configures JavaCompile tasks to use the Checker Framework.

Download

Release:

buildscript {
  repositories {
    jcenter()
  }

  dependencies {
    classpath "com.jaredsburrows:gradle-checker-framework-plugin:0.2.1"
  }
}

apply plugin: "com.jaredsburrows.checkerframework"

Release versions are available in the JFrog Bintray repository.

Snapshot:

buildscript {
  repositories {
    maven { url "https://oss.jfrog.org/artifactory/oss-snapshot-local/" }
  }

  dependencies {
    classpath "com.jaredsburrows:gradle-checker-framework-plugin:0.2.2-SNAPSHOT"
  }
}

apply plugin: "com.jaredsburrows.checkerframework"

Snapshot versions are available in the JFrog Artifactory repository.

Configuration

It is possible to configure the checkers you want to enable using the checkerFramework.checkers property.

For example:

checkerFramework {
  checkers = [
    "org.checkerframework.checker.units.UnitsChecker", 
    "org.checkerframework.checker.nullness.NullnessChecker"]
}

By default, only the NullnessChecker is enabled.

You can find out what checkers are available in the Checker Framework Manual.

License

Copyright (C) 2017 Jared Burrows

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.