aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorReinier Zwitserloot <r.zwitserloot@projectlombok.org>2019-01-28 22:15:50 +0100
committerReinier Zwitserloot <r.zwitserloot@projectlombok.org>2019-01-28 22:15:56 +0100
commit2a8225a6af39d4a82f20928409fcb96ae72d363f (patch)
tree0cbf2fdef4ad88d212303ccf19066a383219f283
parentf2d03973d59d96d8bfef51d8378a4069d8d46205 (diff)
downloadlombok-2a8225a6af39d4a82f20928409fcb96ae72d363f.tar.gz
lombok-2a8225a6af39d4a82f20928409fcb96ae72d363f.tar.bz2
lombok-2a8225a6af39d4a82f20928409fcb96ae72d363f.zip
[website] updated docs for using lombok with gradle
-rw-r--r--website/templates/setup/gradle.html32
1 files changed, 3 insertions, 29 deletions
diff --git a/website/templates/setup/gradle.html b/website/templates/setup/gradle.html
index b3c7de3a..53f45a71 100644
--- a/website/templates/setup/gradle.html
+++ b/website/templates/setup/gradle.html
@@ -11,51 +11,25 @@
<@s.section title="The Lombok Gradle Plugin">
<p>
- There is a plugin for gradle that we recommend you use; it makes deployment a breeze, works around shortcomings of gradle prior to v2.12, and makes it easy to do additional tasks, such as running the lombok eclipse installer or delomboking. The plugin is open source. Read more <a href="https://github.com/franzbecker/gradle-lombok">about the gradle-lombok plugin</a>.
- </p><p>
- Note, to tell the <code>gradle-lombok</code> plugin to use the latest version of lombok, you need to explicitly tell it about the latest version number and the SHA-256. For our current latest version, put this in your <code>build.gradle</code> file:<pre>
-lombok {
- version = '${version}'
- sha256 = ""
-}</pre>
+ There is a plugin for gradle that we recommend you use; it makes deployment a breeze, works around shortcomings of gradle prior to v2.12, and makes it easy to do additional tasks, such as running the lombok eclipse installer or delomboking. The plugin is open source. Read more <a href="https://plugins.gradle.org/plugin/io.freefair.lombok">about the gradle-lombok plugin</a>.
</p>
</@s.section>
- <@s.section title="Gradle v2.12 and up">
+ <@s.section title="Gradle without a plugin">
<p>
If you don't want to use the plugin, gradle has the built-in <code>compileOnly</code> scope, which can be used to tell gradle to add lombok only during compilation. Your <code>build.gradle</code> will look like:<pre>
repositories {
mavenCentral()
}
-plugins {
- id 'net.ltgt.apt' version '0.10'
-}
-
dependencies {
compileOnly 'org.projectlombok:lombok:${version}'
-
- apt 'org.projectlombok:lombok:${version}'
+ annotationProcessor 'org.projectlombok:lombok:${version}'
}</pre>
</p><p>
Remember that you still have to download <code>lombok.jar</code> (or find it in gradle's caches) and run it as a jarfile, if you wish to program in eclipse. The plugin makes that part easier.
</p>
</@s.section>
- <@s.section title="Gradle prior to v2.12">
- <p>
- If you don't want to use the plugin and you're on gradle prior to v2.12, there's a bit of problem: Gradle didn't introduce the 'provided' concept until v2.12. The concept is added by a few well known plugins: The gradle <code>war</code> plugin has the <code>providedCompile</code> scope, and the <a href="https://github.com/nebula-plugins/gradle-extra-configurations-plugin">Gradle Extra Configurations Plugin</a> supports the <code>provided</code> scope. With these plugins, your <code>build.gradle</code> file will look something like this:<pre>
-apply plugin: 'java'
-apply plugin: 'nebula.provided-base'
-
-repositories {
- mavenCentral()
-}
-
-dependencies {
- provided 'org.projectlombok:lombok:${version}'
-}</pre>
- </p>
- </@s.section>
<@s.section title="Android development">
<p>