[Gradle] Suppress documentation for warnNpmGenerateExternals

^KT-58858 In Progress
This commit is contained in:
Yahor Berdnikau
2024-01-14 22:35:11 +01:00
committed by Space Team
parent 5f51f5e1fc
commit 104e6a9b7c
2 changed files with 38 additions and 28 deletions
@@ -3,8 +3,6 @@
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file. * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/ */
@file:Suppress("DEPRECATION")
package org.jetbrains.kotlin.gradle.plugin package org.jetbrains.kotlin.gradle.plugin
import groovy.lang.Closure import groovy.lang.Closure
@@ -93,6 +91,7 @@ interface KotlinDependencyHandler {
version: String, version: String,
generateExternals: Boolean generateExternals: Boolean
): Dependency { ): Dependency {
@Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return npm(name, version) return npm(name, version)
} }
@@ -107,6 +106,7 @@ interface KotlinDependencyHandler {
directory: File, directory: File,
generateExternals: Boolean generateExternals: Boolean
): Dependency { ): Dependency {
@Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return npm(name, directory) return npm(name, directory)
} }
@@ -120,6 +120,7 @@ interface KotlinDependencyHandler {
directory: File, directory: File,
generateExternals: Boolean generateExternals: Boolean
): Dependency { ): Dependency {
@Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return npm(directory) return npm(directory)
} }
@@ -147,6 +148,7 @@ interface KotlinDependencyHandler {
version: String, version: String,
generateExternals: Boolean generateExternals: Boolean
): Dependency { ): Dependency {
@Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return optionalNpm(name, version) return optionalNpm(name, version)
} }
@@ -161,6 +163,7 @@ interface KotlinDependencyHandler {
directory: File, directory: File,
generateExternals: Boolean generateExternals: Boolean
): Dependency { ): Dependency {
@Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return optionalNpm(name, directory) return optionalNpm(name, directory)
} }
@@ -174,6 +177,7 @@ interface KotlinDependencyHandler {
directory: File, directory: File,
generateExternals: Boolean generateExternals: Boolean
): Dependency { ): Dependency {
@Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return optionalNpm(directory) return optionalNpm(directory)
} }
@@ -198,16 +202,22 @@ interface HasKotlinDependencies {
val runtimeOnlyConfigurationName: String val runtimeOnlyConfigurationName: String
} }
@Deprecated("Do not use in your build script") /**
* @suppress
*/
@Deprecated(
message = "Do not use in your build script",
level = DeprecationLevel.ERROR
)
fun warnNpmGenerateExternals(logger: Logger) { fun warnNpmGenerateExternals(logger: Logger) {
logger.warn( logger.warn(
""" """
| |
|========== |==========
|Please note, Dukat integration in Gradle plugin does not work now. |Please note, Dukat integration in Gradle plugin does not work now.
|It is in redesigning process. |It is in redesigning process.
|========== |==========
| |
""".trimMargin() """.trimMargin()
) )
} }
@@ -209,22 +209,22 @@ private class DefaultNpmDependencyExtension(
delegate.invoke(name, version) delegate.invoke(name, version)
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(name, version) return invoke(name, version)
} }
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(name, directory) return invoke(name, directory)
} }
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { override fun invoke(directory: File, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(directory) return invoke(directory)
} }
@@ -270,22 +270,22 @@ private fun defaultNpmDependencyDelegate(
scope, scope,
) { ) {
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { override fun invoke(directory: File, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(directory) return invoke(directory)
} }
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(name, version) return invoke(name, version)
} }
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(name, directory) return invoke(name, directory)
} }
@@ -344,22 +344,22 @@ private class DefaultPeerNpmDependencyExtension(
PEER, PEER,
) { ) {
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { override fun invoke(directory: File, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(directory) return invoke(directory)
} }
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(name, version) return invoke(name, version)
} }
@Deprecated("Dukat integration is in redesigning process. Now it does not work.") @Deprecated("Dukat integration is in redesigning process. Now it does not work.")
override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency {
@Suppress("DEPRECATION") @Suppress("deprecation_error")
warnNpmGenerateExternals(project.logger) warnNpmGenerateExternals(project.logger)
return invoke(name, directory) return invoke(name, directory)
} }