Frege Gradle Plugin

Simplifies setting up your Frege project. This container is part of the Frege IDE.

Documentation

Head over to the Frege IDE docs website.

Installation

You need java >= 11 and gradle >= 7.

git clone https://github.com/tricktron/frege-gradle-plugin.git
./gradlew publishToMavenLocal

How to Use

1. Specify the frege compiler release, version, main module and repl module file in your build.gradle:

plugins
{
    id 'ch.fhnw.thga.frege' version '4.1.0-alpha'
}

frege 
{
    version    = '3.25.84'
    release    = '3.25alpha'
    mainModule = 'examples.HelloFrege' // see runFrege task
    replModule = 'examples.HelloFrege' // see replFrege task
}

Then run

gradle initFrege
gradle runFrege

See the Frege Releases for all available versions.

Optional configuration parameters inside build.gradle:

• compilerDownloadDir: defaults to <projectRoot>/lib
• mainSourceDir : defaults to <projectRoot>/src/main/frege
• outputDir : defaults to <projectRoot>/build/classes/frege/main
• testOutputDir : defaults to <projectRoot>/build/classes/frege/test
• compilerFlags : defaults to ['-O', '-make']
• compileItems : defaults to []
• testModules : defaults to []

Added Tasks

• setupFrege: Downloads the specified version of the Frege compiler.
• initFrege: Creates a default HelloFrege.fr example file under mainSourceDir/examples/HelloFrege.fr. Alternatively, you can specify the location on the command line with --mainModule=my.mod.HelloFrege.
• compileFrege: Compiles all your *.fr files in mainSourceDir to outputDir. Alternatively, you can also specify the compile items by with the compileItems property. Then only the specified compile items and its dependencies get compiled. E.g.: compileItems = [ 'my.mod.Mod1', my.mod.Mod2' ].
• compileTestFrege: Same as compileFrege but compiles all your *.fr files in mainSourceDir to testOutputDir. Used by the testFrege task.
• runFrege: Runs the Frege module specified by mainModule. Alternatively you can also pass the main module by command line, e.g: gradle runFrege --mainModule=my.mod.Name.
• testFrege: Tests all QuickCheck properties defined in the specified testModules. You can pass test args on the command line, e.g: gradle testFrege --args="-v -n 1000 -p pred1. Run gradle testFrege --args=-h to see all options.
• replFrege: Takes care of all project dependencies of the specified replModule and prints the command to start the Frege REPL and load the replModule. E.g.: (echo :l <path to replModule.fr> && cat) | java -cp <your-correct-classpath-with-all-dependencies> frege.repl.FregeRepl. On Unix you can even further automate starting the repl and loading the module with the following one-liner: eval $(./gradlew -q replFrege).

Dependencies

Dependencies can be configured as expected in your build.gradle file, using the frege scope, e.g.:

repositories {
    # Add your Frege repo here
}

dependencies {
    frege 'org.frege-lang:fregefx:0.8.2-SNAPSHOT'
}

Build Cache

The compileFrege task supports incremental builds from build cache. Enable the build cache by setting org.gradle.caching=true in your gradle.properites.

How to Contribute

Try to add another task, e.g. docFrege to the FregePluginFunctionalTest.java file and try to make the test pass.