Skip to content

Commit a200bba

Browse files
authored
Document IntelliJ known project setup issues (#574)
1 parent e6fc58c commit a200bba

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,32 @@ cli-java is a collection of commandline messaging clients suitable for interacti
1010

1111
## Getting started
1212

13-
When using IntelliJ IDEA Ultimate Edition, select "Open" (not "Import Project") option to open project and delete OSGi facets in File >> Project Structure >> Project Settings >> Facets.
14-
1513
mvn clean package # compile without executing external tests (tests that require broker)
1614
java -jar cli-qpid-jms/target/cli-qpid-jms-*.jar sender -b amqp://127.0.0.1:5672 -a myQ --log-msgs dict
1715

16+
### IntelliJ notes
17+
18+
[Open an existing Maven project](https://www.jetbrains.com/help/idea/maven-support.html#maven_import_project_start).
19+
20+
#### Common issues
21+
22+
* OSGi problems (don't remember what those actually were)
23+
24+
When using IntelliJ IDEA Ultimate Edition, select "Open" (not "Import Project") option to open project and delete OSGi facets in File >> Project Structure >> Project Settings >> Facets.
25+
26+
* `Unresolved reference: DaggerFakeClient`, or anything else with `Dagger` in it
27+
28+
The class is generated by the [Dagger](https://github.com/google/dagger) annotation processor.
29+
Run `mvn compile` on the command line so that Maven generates what is needed.
30+
31+
The IDE action on the Maven tab to generate sources does not actually generate what is needed for Kotlin tests, because of a [missing feature](https://youtrack.jetbrains.com/issue/KT-15040).
32+
33+
* `Error: Unable to access jarfile [...]/target/cli-qpid-jms-1.2.2-SNAPSHOT-2.2.0.jar`
34+
35+
IntelliJ is happy to run [failsafe](https://maven.apache.org/surefire/maven-failsafe-plugin/) tests without doing the (equivalent of) `mvn package` first.
36+
This means that the jars used in the `*ITCase` tests may be nonexistent (or out of date).
37+
Run `mvn package -DskipTests` yourself to fix this.
38+
1839
### Run tests
1940

2041
mvn test -Ptests

0 commit comments

Comments
 (0)