azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Gradle, JS] Add documentation of KotlinNpmResolutionManager

Browse Source
This commit is contained in:
Ilya Goncharov
2023-02-15 14:06:44 +01:00
committed by Space Team
parent d64e211dca
commit df50994f4f
2 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/targets/js/nodejs/NodeJsRootPlugin.kt
+1
View File
@@ -103,6 +103,7 @@ open class NodeJsRootPlugin : Plugin<Project> {
val objectFactory = project.objects
// TODO: Could we use common approach with build services to KotlinNpmResolutionManager?
val npmResolutionManager = project.gradle.sharedServices.registerIfAbsent(
KotlinNpmResolutionManager::class.java.name,
KotlinNpmResolutionManager::class.java
libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/targets/js/npm/KotlinNpmResolutionManager.kt
+21
View File
@@ -15,12 +15,33 @@ import org.gradle.api.tasks.Internal
import org.gradle.internal.service.ServiceRegistry
import org.jetbrains.kotlin.gradle.targets.js.npm.resolved.Installation
import org.jetbrains.kotlin.gradle.targets.js.npm.resolved.KotlinRootNpmResolution
import org.jetbrains.kotlin.gradle.targets.js.npm.resolver.KotlinCompilationNpmResolver
import org.jetbrains.kotlin.gradle.targets.js.npm.resolver.KotlinProjectNpmResolver
import org.jetbrains.kotlin.gradle.targets.js.npm.resolver.KotlinRootNpmResolver
internal interface UsesKotlinNpmResolutionManager : Task {
@get:Internal
val npmResolutionManager: Property<KotlinNpmResolutionManager>
}
/**
* [KotlinNpmResolutionManager] is build service which holds state of resolution process of JS-related projects.
*
* Terms:
* `*Resolver` means entities which should exist only in Configuration phase
* `*Resolution` means entities which should be created from `*Resolver` in the end of Configuration phase (when all projects are registered themselves)
*
* The process is following:
* Every project register itself via [NpmResolverPlugin] in [KotlinRootNpmResolver].
* [KotlinRootNpmResolver] creates for every project [KotlinProjectNpmResolver],
* and [KotlinProjectNpmResolver] creates [KotlinCompilationNpmResolver] for every compilation.
* [KotlinCompilationNpmResolver] exist to resolve all JS-related dependencies (inter-project dependencies and NPM dependencies)`.
* In [KotlinCompilationNpmResolver] one can get [KotlinCompilationNpmResolver.compilationNpmResolution] to get resolution,
* but it must be called only after all projects were registered in [KotlinRootNpmResolver]
*
* After configuration phase, on execution, tasks can call [org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin.kotlinNpmResolutionManager]
* It provides [KotlinRootNpmResolution] into [KotlinNpmResolutionManager] and since then it stores all information about resolution process in execution phase
*/
abstract class KotlinNpmResolutionManager : BuildService<KotlinNpmResolutionManager.Parameters> {
interface Parameters : BuildServiceParameters {