diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleApp.kt.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleApp.kt.ft index 80cb94d483f1..7f52390652b0 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleApp.kt.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleApp.kt.ft @@ -2,8 +2,8 @@ package ${PACKAGE_NAME}.app import ${PACKAGE_NAME}.utils.Printer -// This is the main entrypoint of the application. -// It uses the Printer class, from the `:utils` subproject. +// This is the main entry point of the application. +// It uses the `Printer` class from the `:utils` subproject. fun main() { val message = "Hello JetBrains!" val printer = Printer(message) diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleAppBuildGradle.gradle.kts.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleAppBuildGradle.gradle.kts.ft index 3d522070f732..ca52988a9f3b 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleAppBuildGradle.gradle.kts.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleAppBuildGradle.gradle.kts.ft @@ -1,8 +1,9 @@ plugins { - // Apply the shared build logic from a convention plugin. The shared code is located in buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts + // Apply the shared build logic from a convention plugin. + // The shared code is located in `buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts`. id("buildsrc.convention.kotlin-jvm") - // Apply the Application plugin to add support for building an executable JVM application + // Apply the Application plugin to add support for building an executable JVM application. application } diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleBuildSrcBuildGradle.gradle.kts.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleBuildSrcBuildGradle.gradle.kts.ft index 9e29802cb095..66dc3c54b779 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleBuildSrcBuildGradle.gradle.kts.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleBuildSrcBuildGradle.gradle.kts.ft @@ -1,5 +1,5 @@ plugins { - // The Kotlin DSL Plugin provides a convenient way of developing convention plugins. + // The Kotlin DSL plugin provides a convenient way to develop convention plugins. // Convention plugins are located in `src/main/kotlin`, with the file extension `.gradle.kts`, // and are applied in the project's `build.gradle.kts` files as required. `kotlin-dsl` @@ -10,6 +10,6 @@ kotlin { } dependencies { - // Add a dependency on Kotlin Gradle Plugin, so that convention plugins can apply KGP. + // Add a dependency on the Kotlin Gradle plugin, so that convention plugins can apply it. implementation(libs.kotlinGradlePlugin) } diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleBuildSrcSettings.gradle.kts.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleBuildSrcSettings.gradle.kts.ft index 8fa387d88154..705bfb5e5771 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleBuildSrcSettings.gradle.kts.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleBuildSrcSettings.gradle.kts.ft @@ -1,12 +1,12 @@ dependencyResolutionManagement { - // Use Maven Central and Gradle Plugin Portal for resolving dependencies in the shared build logic ("buildSrc") project + // Use Maven Central and the Gradle Plugin Portal for resolving dependencies in the shared build logic (`buildSrc`) project. @Suppress("UnstableApiUsage") repositories { mavenCentral() } - // Re-use the version catalog from the main build + // Reuse the version catalog from the main build. versionCatalogs { create("libs") { from(files("../gradle/libs.versions.toml")) diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleConventionPlugin.gradle.kts.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleConventionPlugin.gradle.kts.ft index dde203217670..b7087c2e187d 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleConventionPlugin.gradle.kts.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleConventionPlugin.gradle.kts.ft @@ -1,24 +1,24 @@ // The code in this file is a convention plugin - a Gradle mechanism for sharing reusable build logic. -// "buildSrc" is a Gradle-recognized directory and every plugin there will be easily available in the rest of the build. +// `buildSrc` is a Gradle-recognized directory and every plugin there will be easily available in the rest of the build. package buildsrc.convention import org.gradle.api.tasks.testing.logging.TestLogEvent plugins { - // Apply the Kotlin JVM plugin to add support for Kotlin in JVM projects + // Apply the Kotlin JVM plugin to add support for Kotlin in JVM projects. kotlin("jvm") } kotlin { - // Use a specific Java version to ease working on different environments + // Use a specific Java version to make it easier to work in different environments. jvmToolchain(${JVM_VERSION}) } tasks.withType().configureEach { - // Configure all test Gradle tasks to use JUnitPlatform + // Configure all test Gradle tasks to use JUnitPlatform. useJUnitPlatform() - // Log information about all test results, not only the failed ones + // Log information about all test results, not only the failed ones. testLogging { events( TestLogEvent.FAILED, diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleProperties.properties.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleProperties.properties.ft index aea150123015..13ff322c91d7 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleProperties.properties.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleProperties.properties.ft @@ -1,8 +1,8 @@ -# Enable build cache to save time by reusing outputs produced by other successful builds. +# Enable the build cache to save time by reusing outputs produced by other successful builds. # https://docs.gradle.org/current/userguide/build_cache.html org.gradle.caching=true -# Enable configuration cache to reuse build configuration and enable parallel task execution. +# Enable the configuration cache to reuse the build configuration and enable parallel task execution. # (Note that some plugins may not yet be compatible with the configuration cache.) # https://docs.gradle.org/current/userguide/configuration_cache.html org.gradle.configuration-cache=true diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleReadme.md.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleReadme.md.ft index 57361d9bc469..73be47a169e6 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleReadme.md.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleReadme.md.ft @@ -3,25 +3,25 @@ ## How to run this application? This project uses [Gradle](https://gradle.org/). -To build and run the application, use the Gradle tool window by clicking the Gradle icon in the right toolbar, +To build and run the application, use the *Gradle* tool window by clicking the Gradle icon in the right-hand toolbar, or run it directly from the terminal: -* Run `./gradlew run` to build and run the application -* Run `./gradlew build` to only build the application -* Run `./gradlew check` to run all checks including tests -* Run `./gradlew clean` to clean all build outputs +* Run `./gradlew run` to build and run the application. +* Run `./gradlew build` to only build the application. +* Run `./gradlew check` to run all checks, including tests. +* Run `./gradlew clean` to clean all build outputs. -Note the usage of Gradle Wrapper (`./gradlew`). This is the suggested way to use Gradle in production -projects. +Note the usage of the Gradle Wrapper (`./gradlew`). +This is the suggested way to use Gradle in production projects. -[Learn more about Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html). +[Learn more about the Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html). [Learn more about Gradle tasks](https://docs.gradle.org/current/userguide/command_line_interface.html#common_tasks). ## Project structure -The project follows suggested multi-module setup and consists of "app" and "utils" subprojects. -The shared build logic was extracted to a convention plugin located in "buildSrc". +This project follows the suggested multi-module setup and consists of the `app` and `utils` subprojects. +The shared build logic was extracted to a convention plugin located in `buildSrc`. -This project uses version catalog (see "gradle/libs.versions.toml") to declare and version dependencies -and both build and configuration cache (see "gradle.properties"). \ No newline at end of file +This project uses a version catalog (see `gradle/libs.versions.toml`) to declare and version dependencies +and both a build cache and a configuration cache (see `gradle.properties`). \ No newline at end of file diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleSettings.gradle.kts.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleSettings.gradle.kts.ft index 6aff29f138b6..2f06c8749eb3 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleSettings.gradle.kts.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleSettings.gradle.kts.ft @@ -1,10 +1,10 @@ // The settings file is the entry point of every Gradle build. // Its primary purpose is to define the subprojects. -// It is also used to configure some project-wide configuration, like plugins management, dependencies management, etc. +// It is also used for some aspects of project-wide configuration, like managing plugins, dependencies, etc. // https://docs.gradle.org/current/userguide/settings_file_basics.html dependencyResolutionManagement { - // Use Maven Central as a default repository (where Gradle will download dependencies) in all subprojects + // Use Maven Central as the default repository (where Gradle will download dependencies) in all subprojects. @Suppress("UnstableApiUsage") repositories { mavenCentral() @@ -12,13 +12,13 @@ dependencyResolutionManagement { } plugins { - // Use the Foojay Toolchains Plugin to automatically download JDKs required by subprojects + // Use the Foojay Toolchains plugin to automatically download JDKs required by subprojects. id("org.gradle.toolchains.foojay-resolver-convention") version "${FOOJAY_VERSION}" } -// Include subprojects "app" and "utils" in the build -// If there are changes in only one of the projects, Gradle will only rebuild only the changed one -// Learn more about structuring projects in Gradle - https://docs.gradle.org/8.7/userguide/multi_project_builds.html +// Include the `app` and `utils` subprojects in the build. +// If there are changes in only one of the projects, Gradle will rebuild only the one that has changed. +// Learn more about structuring projects with Gradle - https://docs.gradle.org/8.7/userguide/multi_project_builds.html include(":app") include(":utils") diff --git a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleUtilsBuildGradle.gradle.kts.ft b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleUtilsBuildGradle.gradle.kts.ft index b328349c3e27..3fb9d6dcecf0 100644 --- a/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleUtilsBuildGradle.gradle.kts.ft +++ b/plugins/kotlin/project-wizard/gradle/resources/fileTemplates/internal/KotlinSampleUtilsBuildGradle.gradle.kts.ft @@ -1,12 +1,13 @@ plugins { - // Apply the shared build logic from a convention plugin. The shared code is located in buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts + // Apply the shared build logic from a convention plugin. + // The shared code is located in `buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts`. id("buildsrc.convention.kotlin-jvm") - // Apply Kotlin Serialization plugin from "gradle/libs.versions.toml" + // Apply Kotlin Serialization plugin from `gradle/libs.versions.toml`. alias(libs.plugins.kotlinPluginSerialization) } dependencies { - // Apply KotlinX bundle of dependencies from the version catalog ("gradle/libs.versions.toml") + // Apply the kotlinx bundle of dependencies from the version catalog (`gradle/libs.versions.toml`). implementation(libs.bundles.kotlinxEcosystem) testImplementation(kotlin("test")) } \ No newline at end of file diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectEmptyKts/settings.gradle.kts b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectEmptyKts/settings.gradle.kts index 0663d9a47c79..ddaaa5f1bfd8 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectEmptyKts/settings.gradle.kts +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectEmptyKts/settings.gradle.kts @@ -1,10 +1,10 @@ // The settings file is the entry point of every Gradle build. // Its primary purpose is to define the subprojects. -// It is also used to configure some project-wide configuration, like plugins management, dependencies management, etc. +// It is also used for some aspects of project-wide configuration, like managing plugins, dependencies, etc. // https://docs.gradle.org/current/userguide/settings_file_basics.html dependencyResolutionManagement { - // Use Maven Central as a default repository (where Gradle will download dependencies) in all subprojects + // Use Maven Central as the default repository (where Gradle will download dependencies) in all subprojects. @Suppress("UnstableApiUsage") repositories { mavenCentral() @@ -12,13 +12,13 @@ dependencyResolutionManagement { } plugins { - // Use the Foojay Toolchains Plugin to automatically download JDKs required by subprojects + // Use the Foojay Toolchains plugin to automatically download JDKs required by subprojects. id("org.gradle.toolchains.foojay-resolver-convention") version "FOOJAY_VERSION" } -// Include subprojects "app" and "utils" in the build -// If there are changes in only one of the projects, Gradle will only rebuild only the changed one -// Learn more about structuring projects in Gradle - https://docs.gradle.org/8.7/userguide/multi_project_builds.html +// Include the `app` and `utils` subprojects in the build. +// If there are changes in only one of the projects, Gradle will rebuild only the one that has changed. +// Learn more about structuring projects with Gradle - https://docs.gradle.org/8.7/userguide/multi_project_builds.html include(":app") include(":utils") diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/README.md b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/README.md index 6b0adbc96803..f749c5bb51d1 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/README.md +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/README.md @@ -2,24 +2,24 @@ This project uses [Gradle](https://gradle.org/). -To build and run the application, use the Gradle tool window by clicking the Gradle icon in the right toolbar, +To build and run the application, use the *Gradle* tool window by clicking the Gradle icon in the right-hand toolbar, or run it directly from the terminal: -* Run `./gradlew run` to build and run the application -* Run `./gradlew build` to only build the application -* Run `./gradlew check` to run all checks including tests -* Run `./gradlew clean` to clean all build outputs +* Run `./gradlew run` to build and run the application. +* Run `./gradlew build` to only build the application. +* Run `./gradlew check` to run all checks, including tests. +* Run `./gradlew clean` to clean all build outputs. -Note the usage of Gradle Wrapper (`./gradlew`). This is the suggested way to use Gradle in production -projects. +Note the usage of the Gradle Wrapper (`./gradlew`). +This is the suggested way to use Gradle in production projects. -[Learn more about Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html). +[Learn more about the Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html). [Learn more about Gradle tasks](https://docs.gradle.org/current/userguide/command_line_interface.html#common_tasks). -The project follows suggested multi-module setup and consists of "app" and "utils" subprojects. -The shared build logic was extracted to a convention plugin located in "buildSrc". +This project follows the suggested multi-module setup and consists of the `app` and `utils` subprojects. +The shared build logic was extracted to a convention plugin located in `buildSrc`. -This project uses version catalog (see "gradle/libs.versions.toml") to declare and version dependencies -and both build and configuration cache (see "gradle.properties"). +This project uses a version catalog (see `gradle/libs.versions.toml`) to declare and version dependencies +and both a build cache and a configuration cache (see `gradle.properties`). diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/app/build.gradle.kts b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/app/build.gradle.kts index e4b62e4ca7d4..02c5b43f0473 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/app/build.gradle.kts +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/app/build.gradle.kts @@ -1,8 +1,9 @@ plugins { - // Apply the shared build logic from a convention plugin. The shared code is located in buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts + // Apply the shared build logic from a convention plugin. + // The shared code is located in `buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts`. id("buildsrc.convention.kotlin-jvm") - // Apply the Application plugin to add support for building an executable JVM application + // Apply the Application plugin to add support for building an executable JVM application. application } diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/app/src/main/kotlin/App.kt b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/app/src/main/kotlin/App.kt index 0917e737773f..e74df745e3b6 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/app/src/main/kotlin/App.kt +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/app/src/main/kotlin/App.kt @@ -2,8 +2,8 @@ package org.testcase.app import org.testcase.utils.Printer -// This is the main entrypoint of the application. -// It uses the Printer class, from the `:utils` subproject. +// This is the main entry point of the application. +// It uses the `Printer` class from the `:utils` subproject. fun main() { val message = "Hello JetBrains!" val printer = Printer(message) diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/build.gradle.kts b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/build.gradle.kts index 2a53606c0b1c..fcd8d792200a 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/build.gradle.kts +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/build.gradle.kts @@ -1,5 +1,5 @@ plugins { - // The Kotlin DSL Plugin provides a convenient way of developing convention plugins. + // The Kotlin DSL plugin provides a convenient way to develop convention plugins. // Convention plugins are located in `src/main/kotlin`, with the file extension `.gradle.kts`, // and are applied in the project's `build.gradle.kts` files as required. `kotlin-dsl` @@ -10,6 +10,6 @@ kotlin { } dependencies { - // Add a dependency on Kotlin Gradle Plugin, so that convention plugins can apply KGP. + // Add a dependency on the Kotlin Gradle plugin, so that convention plugins can apply it. implementation(libs.kotlinGradlePlugin) } diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/settings.gradle.kts b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/settings.gradle.kts index e0e1bd75e9ae..09148f87f399 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/settings.gradle.kts +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/settings.gradle.kts @@ -1,12 +1,12 @@ dependencyResolutionManagement { - // Use Maven Central and Gradle Plugin Portal for resolving dependencies in the shared build logic ("buildSrc") project + // Use Maven Central and the Gradle Plugin Portal for resolving dependencies in the shared build logic (`buildSrc`) project. @Suppress("UnstableApiUsage") repositories { mavenCentral() } - // Re-use the version catalog from the main build + // Reuse the version catalog from the main build. versionCatalogs { create("libs") { from(files("../gradle/libs.versions.toml")) diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts index 08d411012530..a9137a43d081 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts @@ -1,24 +1,24 @@ // The code in this file is a convention plugin - a Gradle mechanism for sharing reusable build logic. -// "buildSrc" is a Gradle-recognized directory and every plugin there will be easily available in the rest of the build. +// `buildSrc` is a Gradle-recognized directory and every plugin there will be easily available in the rest of the build. package buildsrc.convention import org.gradle.api.tasks.testing.logging.TestLogEvent plugins { - // Apply the Kotlin JVM plugin to add support for Kotlin in JVM projects + // Apply the Kotlin JVM plugin to add support for Kotlin in JVM projects. kotlin("jvm") } kotlin { - // Use a specific Java version to ease working on different environments + // Use a specific Java version to make it easier to work in different environments. jvmToolchain(JDK_VERSION) } tasks.withType().configureEach { - // Configure all test Gradle tasks to use JUnitPlatform + // Configure all test Gradle tasks to use JUnitPlatform. useJUnitPlatform() - // Log information about all test results, not only the failed ones + // Log information about all test results, not only the failed ones. testLogging { events( TestLogEvent.FAILED, diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/settings.gradle.kts b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/settings.gradle.kts index 0663d9a47c79..ddaaa5f1bfd8 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/settings.gradle.kts +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/settings.gradle.kts @@ -1,10 +1,10 @@ // The settings file is the entry point of every Gradle build. // Its primary purpose is to define the subprojects. -// It is also used to configure some project-wide configuration, like plugins management, dependencies management, etc. +// It is also used for some aspects of project-wide configuration, like managing plugins, dependencies, etc. // https://docs.gradle.org/current/userguide/settings_file_basics.html dependencyResolutionManagement { - // Use Maven Central as a default repository (where Gradle will download dependencies) in all subprojects + // Use Maven Central as the default repository (where Gradle will download dependencies) in all subprojects. @Suppress("UnstableApiUsage") repositories { mavenCentral() @@ -12,13 +12,13 @@ dependencyResolutionManagement { } plugins { - // Use the Foojay Toolchains Plugin to automatically download JDKs required by subprojects + // Use the Foojay Toolchains plugin to automatically download JDKs required by subprojects. id("org.gradle.toolchains.foojay-resolver-convention") version "FOOJAY_VERSION" } -// Include subprojects "app" and "utils" in the build -// If there are changes in only one of the projects, Gradle will only rebuild only the changed one -// Learn more about structuring projects in Gradle - https://docs.gradle.org/8.7/userguide/multi_project_builds.html +// Include the `app` and `utils` subprojects in the build. +// If there are changes in only one of the projects, Gradle will rebuild only the one that has changed. +// Learn more about structuring projects with Gradle - https://docs.gradle.org/8.7/userguide/multi_project_builds.html include(":app") include(":utils") diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/utils/build.gradle.kts b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/utils/build.gradle.kts index 903693d0fdcb..eee3c34d1a6f 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/utils/build.gradle.kts +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectKts/utils/build.gradle.kts @@ -1,12 +1,13 @@ plugins { - // Apply the shared build logic from a convention plugin. The shared code is located in buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts + // Apply the shared build logic from a convention plugin. + // The shared code is located in `buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts`. id("buildsrc.convention.kotlin-jvm") - // Apply Kotlin Serialization plugin from "gradle/libs.versions.toml" + // Apply Kotlin Serialization plugin from `gradle/libs.versions.toml`. alias(libs.plugins.kotlinPluginSerialization) } dependencies { - // Apply KotlinX bundle of dependencies from the version catalog ("gradle/libs.versions.toml") + // Apply the kotlinx bundle of dependencies from the version catalog (`gradle/libs.versions.toml`). implementation(libs.bundles.kotlinxEcosystem) testImplementation(kotlin("test")) } diff --git a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectOnboardingTipsKts/app/build.gradle.kts b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectOnboardingTipsKts/app/build.gradle.kts index e4b62e4ca7d4..02c5b43f0473 100644 --- a/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectOnboardingTipsKts/app/build.gradle.kts +++ b/plugins/kotlin/project-wizard/tests/testData/gradleNewProjectWizard/multiModuleProjectOnboardingTipsKts/app/build.gradle.kts @@ -1,8 +1,9 @@ plugins { - // Apply the shared build logic from a convention plugin. The shared code is located in buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts + // Apply the shared build logic from a convention plugin. + // The shared code is located in `buildSrc/src/main/kotlin/kotlin-jvm.gradle.kts`. id("buildsrc.convention.kotlin-jvm") - // Apply the Application plugin to add support for building an executable JVM application + // Apply the Application plugin to add support for building an executable JVM application. application }