Skip to content

Commit

Permalink
Merge branch 'master' into JavassistEnumDeclaration_solve
Browse files Browse the repository at this point in the history
  • Loading branch information
WimTibackx committed Oct 18, 2017
2 parents 90d6a80 + 45b6e07 commit a09ceb1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,19 @@ The project is structured in this way:

A more detailed description of the architecture of the project is available in [Design.MD](https://github.com/javaparser/javasymbolsolver/blob/master/Design.MD)

### Gradle usage

We suggest that you use the local gradle wrapper within java-symbol-solver to execute gradle tasks. If you're working on a Linux or Mac system, this is `./gradlew` in the root directory of java-symbol-solver. On Windows, it's `gradlew.bat`. When executing gradle tasks via your IDE, make sure to configure your IDE to also use this wrapper. If you use intelliJ, you need the "Use default Gradle wrapper" option in the [IntelliJ Gradle settings](https://www.jetbrains.com/help/idea/gradle-2.html).

The following tasks are most relevant:

* `assemble`: If you need to build the source code (the full command thus becomes `.\gradlew assemble` or `.\gradlew.bat assemble` depending on your Operating System).
* `check`: To run the tests
* `check jacocoTestReport`: To run the tests (if still necessary) and generate a test coverage report. This coverage report is then located at `./java-symbol-solver-testing/build/jacocoHtml/index.html` relative to your project root.
* `install`: To install the snapshot version of the project to your local maven repository, which can be useful to test changes you're working on against external projects.

In case you haven't worked with Gradle before, one thing of note is that Gradle will only perform tasks that are still relevant. Let's say you have subprojects `foo` and `bar` and you had previously compiled those. If you then make changes in `foo` and compile both again, only `foo` will be compiled. You'll see in the Gradle output that the compile task of `bar` is marked as `UP-TO-DATE`.

## Contributing

I would absolutely love every possible kind of contributions: if you have questions, ideas, need help or want to propose a change just open an issue. Pull-requests are greatly appreciated.
Expand Down
5 changes: 5 additions & 0 deletions java-symbol-solver-testing/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,8 @@ idea {
}
}

jacocoTestReport {
sourceSets project(":java-symbol-solver-model").sourceSets.main
sourceSets project(":java-symbol-solver-logic").sourceSets.main
sourceSets project(":java-symbol-solver-core").sourceSets.main
}

0 comments on commit a09ceb1

Please sign in to comment.