aboutsummaryrefslogtreecommitdiff
path: root/website/templates/setup/ecj.html
blob: e01bc653d65bfd41140bcb38e0f33575c761d2d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<#import "_setup.html" as s>

<@s.scaffold title="ecj">
	<@s.introduction>
		<p>
			ecj (the eclipse standalone compiler) is compatible with lombok. Use the following command line to enable lombok with ecj:
			<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><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><p>
			If you're using a tool based on ecj, adding these VM arguments and adding lombok.jar to the classpath should work.
		</p>
	</@s.introduction>

	<@s.section title="Maven">
		<p>
			It is possible to <a href="/setup/ecj-in-maven-pom-example.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>${r"${project.build.directory}"}</code>.
		</p><p>
			Use the following commands in sequence to enable lombok with ecj in your Maven build:
<pre>
# Make sure you've updated your pom as per <a href="/setup/ecj-in-maven-pom-example.xml">this example</a>.
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>
	</@s.section>
</@s.scaffold>