Frege Gradle Plugin
Simplifies setting up your Frege project.
Installation
You need java >= 11
.
git clone https://github.com/tricktron/frege-gradle-plugin.git
./gradlew publishToMavenLocal
How to Use
- Specify the frege compiler release, version, main module and repl source file in your
build.gradle
:
frege {
version = '3.25.84'
release = '3.25alpha'
mainModule = 'my.mod.Name' // see runFrege task
replSource = 'Name.fr' // see replFrege task
}
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/main/frege
- compilerFlags: defaults to ['-O', '-make']
Added Tasks
- setupFrege: Downloads the specified version of the Frege compiler.
- compileFrege: All your
*.fr
files inmainSourceDir
get compiled tooutputDir
. - 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
. - replFrege: Takes care of all project dependencies of the specified filename by
replSource
and prints the command to start the Frege REPL, e.g:java -cp <your-correct-classpath-with-all-dependencies> frege.repl.FregeRepl
. Afterwards you can load your file into the repl with:l <absolute path to replSource>
.
Dependencies
Dependencies can be configured as expected in your build.gradle
file, using the implementation
scope, e.g.:
repositories {
# Add your Frege repo here
}
dependencies {
implementation '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. fregeDoc
to the FregePluginFunctionalTest.java file and try to make the test pass.