https://github.com/jaredsburrows/gradle-checker-framework-plugin

Gradle plugin to use the Checker Framework for Java.
https://github.com/jaredsburrows/gradle-checker-framework-plugin

Last synced: over 1 year ago
JSON representation

Gradle plugin to use the Checker Framework for Java.

• Host: GitHub
• URL: https://github.com/jaredsburrows/gradle-checker-framework-plugin
• Owner: jaredsburrows
• License: apache-2.0
• Created: 2017-06-02T02:10:32.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T00:12:32.000Z (over 1 year ago)
• Last Synced: 2025-03-01T05:32:34.691Z (over 1 year ago)
• Language: Groovy
• Homepage:
• Size: 13 MB
• Stars: 9
• Watchers: 3
• Forks: 4
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Gradle Checker Framework Plugin

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

[![Build](https://github.com/jaredsburrows/gradle-checker-framework-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/jaredsburrows/gradle-checker-framework-plugin/actions/workflows/build.yml)

[![Twitter Follow](https://img.shields.io/twitter/follow/jaredsburrows.svg?style=social)](https://twitter.com/jaredsburrows)

This plugin configures `JavaCompile` tasks to use the [Checker Framework](https://checkerframework.org).

## Version Compatibility

| Plugin Version | Checker Framework | Android Gradle Plugin |

| --- | --- | --- |

| 0.2.2 | 2.4.0 | 3.2.1 |

## Download

**Release:**

```groovy

buildscript {

  repositories {

    jcenter()

  }

  dependencies {

    classpath 'com.jaredsburrows:gradle-checker-framework-plugin:0.2.2'

  }

}

apply plugin: 'com.jaredsburrows.checkerframework'

```

Release versions are available in the [JFrog Bintray repository](https://jcenter.bintray.com/com/jaredsburrows/gradle-checker-framework-plugin/).

**Snapshot:**

```groovy

buildscript {

  repositories {

    maven { url 'https://oss.jfrog.org/artifactory/oss-snapshot-local/' }

  }

  dependencies {

    classpath 'com.jaredsburrows:gradle-checker-framework-plugin:0.2.3-SNAPSHOT'

  }

}

apply plugin: 'com.jaredsburrows.checkerframework'

```

Snapshot versions are available in the [JFrog Artifactory repository](https://oss.jfrog.org/artifactory/libs-snapshot/com/jaredsburrows/gradle-checker-framework-plugin/).

## Configuration

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

For example:

```groovy

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](https://checkerframework.org/manual/#introduction).

## 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.