Explicitly state subproject location to avoid unintentionally creating empty projects

Author: tresat

.github/workflows/build-headless-docker.yml

@@ -28,7 +28,7 @@ jobs:
       - name: build headless docker container
         if: ${{ env.IS_MAIN_BUILD }}
         run: |
-          ./gradlew :game-app:game-headless:shadowJar
+          ./gradlew :game-headless:shadowJar
           BUILD_VERSION=$(game-app/run/.build/get-build-version)
 
           docker build game-app/game-headless \

.github/workflows/upload-http-client-jars.yml

@@ -33,6 +33,6 @@ jobs:
           BUILD_VERSION=$(game-app/run/.build/get-build-version)
           echo "JAR_VERSION=$BUILD_VERSION" | tee -a $GITHUB_ENV
       - name: Publish lobby client JAR
-        run: ./gradlew :http-clients:lobby-client:publish :game-app:domain-data:publish :lib:java-extras:publish :lib:websocket-client:publish :lib:feign-common:publish
+        run: ./gradlew :lobby-client:publish :domain-data:publish :java-extras:publish :websocket-client:publish :feign-common:publish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/development/README.md

@@ -68,7 +68,7 @@ If you are new to Open Source & GitHub:
 
 ```bash
 # Build & Launch TripleA Game-Client
-./gradlew :game-app:game-headed:run
+./gradlew :game-headed:run
 
 # Run all build checks
 ./verify
@@ -80,21 +80,21 @@ If you are new to Open Source & GitHub:
 ./gradlew test
 
 # Run tests for a (sub)project
-./gradlew :game-app:game-core:test
+./gradlew :game-core:test
 
 # Run a specific test
-./gradlew :game-app:game-core:test --tests games.strategy.triplea.UnitUtilsTest
+./gradlew :game-core:test --tests games.strategy.triplea.UnitUtilsTest
 
 # Runs a specific test method
-./gradlew :game-app:game-core:test --tests games.strategy.triplea.UnitUtilsTest.multipleTransportedUnitsAreTransferred
+./gradlew :game-core:test --tests games.strategy.triplea.UnitUtilsTest.multipleTransportedUnitsAreTransferred
 
 # Run specific tests using wildcard (be sure to use quotes around wildcard)
-./gradlew :game-app:game-core:test --tests 'games.strategy.triplea.UnitUtilsTest.*Units*'
+./gradlew :game-core:test --tests 'games.strategy.triplea.UnitUtilsTest.*Units*'
 ```
 
 To run tests even if there are no changes from the previous build, use the `--rerun-tasks` option:
 ```
-./gradlew --rerun-tasks :game-app:game-core:test
+./gradlew --rerun-tasks :game-core:test
 ```
 
 ## Run Formatting
@@ -137,7 +137,7 @@ save games from loading.
 This can be caused by missing resource files, such as images or icons.
 
 The Gradle task `run` for `game-headed` will download and unzip game assets into the `game-headed` project's directory `/build/assests`.
-This directory will then be processed as a main resource, by the task `:game-app:game-headed:processResources`, in order to be packaged in the resulting project jar.
+This directory will then be processed as a main resource, by the task `:game-headed:processResources`, in order to be packaged in the resulting project jar.
 When the game starts, it expects to find the folder `assets` at the root of the classpath, so to load files use the class loader's method `getResourceAsStream()`.
 Since this is a resource file packaged in the library jar produced by this project, the working dir should **not** influence how assets are loaded.
 

docs/development/build-overview-and-development.md

@@ -6,6 +6,12 @@ Gradle plugins used by the build are located in `/gradle/build-logic`.
 The build uses the Gradle Kotlin DSL. 
 This make the build easier to maintain by increasing the completion and refactoring assistance the IDE is able to provide.
 
+## Build Structure
+
+By explicitly specifying the physical location of nested subprojects in the root `settings.gradle.kts` file, the build is able to avoid [unintentionally creating empty projects](https://docs.gradle.org/current/userguide/best_practices_structuring_builds.html#avoid_empty_projects).
+These empty projects slow the build and make it more difficult to understand the project structure.
+This allows you to reference projects using non-hierarchical names, for example `:game-core` instead of `:game-app:game-core`.
+
 ## Convention Plugins
 
 The TripleA build defines Gradle [Convention Plugins](https://docs.gradle.org/current/userguide/implementing_gradle_plugins_convention.html#header) to avoid cross-project configuration and duplication of configuration.
@@ -18,10 +24,10 @@ It applies the `java-library` plugin and applies universal configuration, code c
 
 ## Test Fixtures
 
-The `:game-app:game-core` project exposes [Test Fixtures](https://docs.gradle.org/current/userguide/java_testing.html#producing_and_using_test_fixtures_within_a_single_project) to share common testing code and resources between projects.
-Other projects (like `:game-app:ai`) can access these fixtures to use during testing by adding a dependency like `testImplementation(testFixtures(project(":game-app:game-core")))`.
+The `:game-core` project exposes [Test Fixtures](https://docs.gradle.org/current/userguide/java_testing.html#producing_and_using_test_fixtures_within_a_single_project) to share common testing code and resources between projects.
+Other projects (like `:ai`) can access these fixtures to use during testing by adding a dependency like `testImplementation(testFixtures(project(":game-core")))`.
 
-The fixture in `:game-app:game-core` includes map data present in `/game-app/game-core/src/testFixtures/resources`, that can be loaded by tests via the `TestMapGameDataLoader` class and the `TestMapGameData` enum.
+The fixture in `:game-core` includes map data present in `/game-app/game-core/src/testFixtures/resources`, that can be loaded by tests via the `TestMapGameDataLoader` class and the `TestMapGameData` enum.
 
 # Future Work
 

game-app/ai/build.gradle.kts

@@ -3,8 +3,8 @@ plugins {
 }
 
 dependencies {
-    implementation(project(":game-app:game-core"))
-    implementation(project(":lib:java-extras"))
+    implementation(project(":game-core"))
+    implementation(project(":java-extras"))
 
-    testImplementation(testFixtures(project(":game-app:game-core")))
+    testImplementation(testFixtures(project(":game-core")))
 }

game-app/game-core/build.gradle.kts

@@ -4,20 +4,20 @@ plugins {
 }
 
 dependencies {
-    implementation(project(":game-app:domain-data"))
-    implementation(project(":game-app:map-data"))
-    implementation(project(":game-app:game-relay-server"))
-    implementation(project(":http-clients:lobby-client"))
-    implementation(project(":lib:java-extras"))
-    implementation(project(":lib:swing-lib"))
-    implementation(project(":lib:websocket-client"))
-    implementation(project(":lib:xml-reader"))
-    testImplementation(project(":lib:swing-lib-test-support"))
-    testImplementation(project(":lib:test-common"))
+    implementation(project(":domain-data"))
+    implementation(project(":map-data"))
+    implementation(project(":game-relay-server"))
+    implementation(project(":lobby-client"))
+    implementation(project(":java-extras"))
+    implementation(project(":swing-lib"))
+    implementation(project(":websocket-client"))
+    implementation(project(":xml-reader"))
+    testImplementation(project(":swing-lib-test-support"))
+    testImplementation(project(":test-common"))
     // Configures mockito to use the legacy "subclass mock maker"
     // see https://github.com/mockito/mockito/releases/tag/v5.0.0 for more information
 
-    testFixturesImplementation(project(":lib:java-extras"))
+    testFixturesImplementation(project(":java-extras"))
     testFixturesImplementation(libs.bundles.junit)
     testFixturesImplementation(libs.bundles.mockito)
     testFixturesImplementation(libs.jsr305) {

game-app/game-headed/build.gradle.kts

@@ -20,7 +20,7 @@ application {
 val releasesDir = project.layout.buildDirectory.file("releases").get().asFile
 
 fun getProductVersion(): String {
-    return project(":game-app").file("../game-app/run/.build/product-version.txt").readText().trim()
+    return rootProject.file("game-app/run/.build/product-version.txt").readText().trim()
 }
 
 fun getCommitNumber(): String {
@@ -32,16 +32,16 @@ fun getCommitNumber(): String {
 val releaseVersion = getProductVersion() + "+" + getCommitNumber()
 
 dependencies {
-    implementation(project(":game-app:ai"))
-    implementation(project(":game-app:domain-data"))
-    implementation(project(":game-app:game-core"))
-    implementation(project(":game-app:map-data"))
-    implementation(project(":http-clients:lobby-client"))
-    implementation(project(":lib:feign-common"))
-    implementation(project(":lib:java-extras"))
-    implementation(project(":lib:swing-lib"))
-    implementation(project(":lib:websocket-client"))
-    testImplementation(project(":lib:test-common"))
+    implementation(project(":ai"))
+    implementation(project(":domain-data"))
+    implementation(project(":game-core"))
+    implementation(project(":map-data"))
+    implementation(project(":lobby-client"))
+    implementation(project(":feign-common"))
+    implementation(project(":java-extras"))
+    implementation(project(":swing-lib"))
+    implementation(project(":websocket-client"))
+    testImplementation(project(":test-common"))
 }
 
 tasks.named<Jar>("jar") {

game-app/game-headless/README.md

@@ -31,7 +31,7 @@ docker compose-up
 
 Example command to run a new headless game server from Gradle:
 ```
-$ MAPS_FOLDER=/home/$USER/triplea/downloadedMaps ./gradlew :game-app:game-headless:run
+$ MAPS_FOLDER=/home/$USER/triplea/downloadedMaps ./gradlew :game-headless:run
 ```
 See 'build.gradle' file to change things like lobby URI & bot port number.
 

game-app/game-headless/build.gradle.kts

@@ -12,11 +12,11 @@ application {
 }
 
 dependencies {
-    implementation(project(":http-clients:lobby-client"))
-    implementation(project(":game-app:ai"))
-    implementation(project(":game-app:domain-data"))
-    implementation(project(":game-app:game-core"))
-    implementation(project(":lib:java-extras"))
+    implementation(project(":lobby-client"))
+    implementation(project(":ai"))
+    implementation(project(":domain-data"))
+    implementation(project(":game-core"))
+    implementation(project(":java-extras"))
 }
 
 tasks.named<Jar>("jar") {

game-app/game-relay-server/build.gradle.kts

@@ -3,7 +3,7 @@ plugins {
 }
 
 dependencies {
-    implementation(project(":lib:websocket-client"))
-    implementation(project(":lib:websocket-server"))
-    testImplementation(project(":lib:test-common"))
+    implementation(project(":websocket-client"))
+    implementation(project(":websocket-server"))
+    testImplementation(project(":test-common"))
 }