aboutsummaryrefslogtreecommitdiff
path: root/website/setup
diff options
context:
space:
mode:
authorMart Hagenaars <marthagenaars@gmail.com>2016-03-17 10:17:39 +0100
committerMart Hagenaars <marthagenaars@gmail.com>2016-03-17 10:44:42 +0100
commit894bfe1c083fbe257eef78cbab6860032026d122 (patch)
treefb2347006736c1c56688ef778b5c6361eaf8654c /website/setup
parent26ad9e7f5f4de77436d3d63e4a43e8cb77621c15 (diff)
downloadlombok-894bfe1c083fbe257eef78cbab6860032026d122.tar.gz
lombok-894bfe1c083fbe257eef78cbab6860032026d122.tar.bz2
lombok-894bfe1c083fbe257eef78cbab6860032026d122.zip
Update instructions for using lombok with ecj and Maven
Diffstat (limited to 'website/setup')
-rw-r--r--website/setup/ecj.html28
-rw-r--r--website/setup/pom.xml78
2 files changed, 104 insertions, 2 deletions
diff --git a/website/setup/ecj.html b/website/setup/ecj.html
index 07d2f0f6..cc70c566 100644
--- a/website/setup/ecj.html
+++ b/website/setup/ecj.html
@@ -42,10 +42,34 @@
<div class="downloadHelp">
ecj (the eclipse standalone compiler) is compatible with lombok. Use the following command line to enable lombok with ecj:
<p>
- <pre>
-java <strong>-javaagent:lombok.jar=ECJ -Xbootclasspath/p:lombok.jar</strong> -jar ecj.jar -cp lombok.jar <em>(rest of arguments)</em></pre>
+ <pre>java <strong>-javaagent:lombok.jar=ECJ</strong> -jar ecj.jar -cp lombok.jar -source 1.8 <em class="note">(rest of arguments)</em></pre>
+ <p>
+ You may have to add the following VM argument, if you're using an older version of lombok or java:
+ <pre><strong>-Xbootclasspath/p:lombok.jar</strong></pre>
+ <p>
If you're using a tool based on ecj, adding these VM arguments and adding lombok.jar to the classpath should work.
</div>
+ <div class="separator">
+ </div>
+ <div class="downloadHelp">
+ <h3>Using ecj with Maven</h3>
+ <p>
+ It is possible to <a href="pom.xml">configure</a> <code>maven-compiler-plugin</code> with <code>maven-dependency-plugin</code> and <code>plexus-compiler-eclipse</code>.
+ </p>
+ <p>
+ Before the <code>compile</code> phase, you will have to set your <code>MAVEN_OPTS</code> environment variable to include the <code>javaagent</code> argument.
+ In the example below, <code>target</code> is your <code>${project.build.directory}</code>.
+ </p>
+ <p>
+ Use the following commands in sequence to enable lombok with ecj in your Maven build:
+<pre>
+mvn clean <strong>dependency:copy@get-lombok</strong>
+set MAVEN_OPTS=<strong>-javaagent:target/lombok.jar=ECJ</strong> <em class="note">(or your OS's equivalent)</em>
+mvn install
+set MAVEN_OPTS= <em class="note">(or your OS's equivalent)</em>
+</pre>
+ </p>
+ </div>
<div class="endBar">
</div>
<div class="footer">
diff --git a/website/setup/pom.xml b/website/setup/pom.xml
new file mode 100644
index 00000000..6562afe8
--- /dev/null
+++ b/website/setup/pom.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.projectlombok</groupId>
+ <artifactId>eclipse-compiler-test</artifactId>
+ <version>1.0-SNAPSHOT</version>
+
+ <properties>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ <lombok.version>1.16.8</lombok.version>
+ </properties>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok</artifactId>
+ <version>${lombok.version}</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>3.5.1</version>
+ <configuration>
+ <compilerId>eclipse</compilerId>
+ <source>1.8</source>
+ <target>1.8</target>
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>org.codehaus.plexus</groupId>
+ <artifactId>plexus-compiler-eclipse</artifactId>
+ <version>2.7</version>
+ </dependency>
+ <dependency>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok</artifactId>
+ <version>${lombok.version}</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <version>2.10</version>
+ <executions>
+ <execution>
+ <id>get-lombok</id>
+ <goals>
+ <goal>copy</goal>
+ </goals>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok</artifactId>
+ <version>${lombok.version}</version>
+ <type>jar</type>
+ <outputDirectory>${project.build.directory}</outputDirectory>
+ <destFileName>lombok.jar</destFileName>
+ </artifactItem>
+ </artifactItems>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
+</project>