$ mkdir my-project $ cd my-project $ gradle init --type basic --dsl groovy
From here on out you’ll use ./gradlew
instead of gradle
in your commands. gradlew
is the Gradle Wrapper which allows you to set a per-project Gradle version. This ensures all developers use the same Gradle version for the project, instead of whatever happens to be on their PATH
.
Also see Gradle’s Learning the Basics.
To include plugins from Gradle’s Plugin Portal you’ll use a plugins {}
block. This should be at the top of your build.gradle
.
plugins {
id 'dev.clojurephant.clojure' version '{clojurephant-version}'
// any additional plugins declared here
}
Also see Gradle’s Using Plugins.
group = 'my.example' // the group ID your artifacts should be published under
version = '0.1.0-SNAPSHOT' // the version your artifacts should be published under
No repositories are specified by default, so you must list any repositories you want to search for your dependencies.
Clojure projects commonly need both Maven Central and Clojars.
repositories {
mavenCentral()
maven {
name = 'Clojars' // name can be ommitted, but is helpful in troubleshooting
url = 'https://repo.clojars.org/'
}
}
Also see Gradle’s Declaring Repositories.
Unless you have a reason to do otherwise, use Gradle’s shorthand syntax <configuration> '<group>:<artifact>:<version>'
(e.g. implementation 'org.clojure:clojure:1.9.0'
) to specify dependencies.
Dependencies are put in different configurations (somewhat similar to Maven scopes). For Clojure’s purposes, the three main ones to be aware of are:
-
implementation
- dependencies of your main application code -
testImplementation
- dependencies of your test code -
devImplementation
- dependencies used only in the REPL
dependencies {
implementation 'org.clojure:clojure:{clojure-version}'
// due to how clojure.test is executed, a JUnit test engine (Jovial) is needed
testRuntimeOnly 'org.ajoberstar:jovial:{jovial-version}'
// due to the way Gradle's REPL is started, if you need tools.namespace, you must be on 0.3+
devImplementation 'org.clojure:tools.namespace:{tools-namespace-version}'
}
// due to how clojure.test is executed, the JUnit platform is needed
tasks.withType(Test) {
useJUnitPlatform()
}
Also see Gradle’s Declaring Dependencies
Full build.gradle
example:
plugins {
id 'dev.clojurephant.clojure' version '{clojurephant-version}'
}
group = 'my.example'
version = '0.1.0-SNAPSHOT'
repositories {
mavenCentral()
maven {
name = 'Clojars' // name can be ommitted, but is helpful in troubleshooting
url = 'https://repo.clojars.org/'
}
}
dependencies {
implementation 'org.clojure:clojure:{clojure-version}'
testRuntimeOnly 'org.ajoberstar:jovial:{jovial-version}'
devImplementation 'org.clojure:tools.namespace:{tools-namespace-version}'
}
tasks.withType(Test) {
useJUnitPlatform()
}