Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 2.38 KB

README.md

File metadata and controls

74 lines (54 loc) · 2.38 KB
Raw

Dafny Gradle Plugin

This plugin offers tight integration of the Dafny verification-aware programming language with Java: automatically verifying Dafny source code and compiling it to Java source code, which the Java plugin will then build together with any hand-written Java in the project. It also provides a robust approach to distributing and managing Dafny dependencies through Gradle-supported repositories such as Maven Central.

Installation

The Dafny Gradle plugin is applied using the org.dafny.dafny plugin ID. For example:

plugins {
    id("org.dafny.dafny").version("0.1.0")
}

dafny {
    dafnyVersion.set("4.1.0")
}

dependencies {
    implementation("org.dafny:DafnyRuntime:4.1.0")
}

Documentation

The plugin provides two tasks:

  • verifyDafny, which verifes all Dafny code under the src/main/dafny directory.
  • translateDafnyToJava, which translates Dafny code verified by verifyDafny to Java code, and ensures the result is also compiled together with the main Java source set.

Both tasks are executed automatically as dependencies of tasks from the Java plugin, but can be executed manually as well.

The plugin also embeds the built Dafny code in the resulting Jar file, and automatically discovers any Dafny code embedded in this way in the project's dependencies, making them available to the Dafny tool as libraries. This allows Dafny projects to define Dafny dependencies and distribute themselves as libraries through Gradle-supported repositories such as Maven central. For details see this example.

Projects can also configure command-line options to pass to the Dafny CLI in the dafny extension:

dafny {
    dafnyVersion.set("4.1.0")
  
    optionsMap.put("unicode-char", false)
    optionsMap.put("isolate-assertions", true)
}

Note there is no support for different Dafny CLI options on a per-file basis. We recommend organizing Dafny source into subprojects with the same set of options instead.

Known Limitations

  • The collection of Dafny files to verify or translate is not yet configurable.
  • The plugin only supports a main source set, and only integrates with Java code in the Java plugin's main source set.
  • The Dafny CLI is only resolved through the current PATH, and there is no support for bootstrapping it.

License

This library is licensed under the Apache 2.0 License.