https://github.com/zml2008/contract-validator

A simple compile-time validator for JetBrains @Contract annotations
https://github.com/zml2008/contract-validator

Last synced: 14 days ago
JSON representation

A simple compile-time validator for JetBrains @Contract annotations

• Host: GitHub
• URL: https://github.com/zml2008/contract-validator
• Owner: zml2008
• License: lgpl-3.0
• Created: 2021-06-07T04:47:33.000Z (over 3 years ago)
• Default Branch: trunk
• Last Pushed: 2024-11-20T20:03:15.000Z (about 1 month ago)
• Last Synced: 2024-11-20T21:19:22.275Z (about 1 month ago)
• Language: Java
• Homepage:
• Size: 374 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# @Contract Validator for JetBrains Annotations

![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/zml2008/contract-validator/ci.yaml?branch=trunk) [![LGPL v3.0 or later License](https://img.shields.io/badge/license-LGPL--3.0-blue)](COPYING.LESSER) [![Maven Central](https://img.shields.io/maven-central/v/ca.stellardrift/contract-validator?label=stable)](https://search.maven.org/search?q=g:ca.stellardrift%20AND%20a:contract-validator*) ![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/ca.stellardrift/contract-validator?label=dev&server=https%3A%2F%2Foss.sonatype.org)

This is a simple annotation processor to validate the syntax used for `@Contract` annotations.

This does not validate the contracts themselves.

## Usage

The contract validator requires Java 8 or later, and is published on maven central. It runs as an annotation processor at compile time.

### Gradle

```gradle

dependencies {

  annotationProcessor("ca.stellardrift:contract-validator:1.0.1")

}

```

### 

It should work, if you use another build tool feel free to help fill out this section

## License

`contract-validator` is released under the terms of the GNU Lesser General Public License version 3 or later.

## Contributing

Pull requests are accepted. Please open an issue to discuss any larger feature changes before starting. This helps ensure your design direction does not conflict with the goals of this tool.