From 104e6a9b7cc6b50508bf463223257e013bd27227 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Sun, 14 Jan 2024 22:35:11 +0100 Subject: [PATCH] [Gradle] Suppress documentation for warnNpmGenerateExternals ^KT-58858 In Progress --- .../gradle/plugin/HasKotlinDependencies.kt | 30 ++++++++++------ .../targets/js/npm/NpmDependencyExtension.kt | 36 +++++++++---------- 2 files changed, 38 insertions(+), 28 deletions(-) diff --git a/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/HasKotlinDependencies.kt b/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/HasKotlinDependencies.kt index 66c9a3ab695..838e6866266 100644 --- a/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/HasKotlinDependencies.kt +++ b/libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/HasKotlinDependencies.kt @@ -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. */ -@file:Suppress("DEPRECATION") - package org.jetbrains.kotlin.gradle.plugin import groovy.lang.Closure @@ -93,6 +91,7 @@ interface KotlinDependencyHandler { version: String, generateExternals: Boolean ): Dependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return npm(name, version) } @@ -107,6 +106,7 @@ interface KotlinDependencyHandler { directory: File, generateExternals: Boolean ): Dependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return npm(name, directory) } @@ -120,6 +120,7 @@ interface KotlinDependencyHandler { directory: File, generateExternals: Boolean ): Dependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return npm(directory) } @@ -147,6 +148,7 @@ interface KotlinDependencyHandler { version: String, generateExternals: Boolean ): Dependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return optionalNpm(name, version) } @@ -161,6 +163,7 @@ interface KotlinDependencyHandler { directory: File, generateExternals: Boolean ): Dependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return optionalNpm(name, directory) } @@ -174,6 +177,7 @@ interface KotlinDependencyHandler { directory: File, generateExternals: Boolean ): Dependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return optionalNpm(directory) } @@ -198,16 +202,22 @@ interface HasKotlinDependencies { 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) { logger.warn( """ - | - |========== - |Please note, Dukat integration in Gradle plugin does not work now. - |It is in redesigning process. - |========== - | - """.trimMargin() + | + |========== + |Please note, Dukat integration in Gradle plugin does not work now. + |It is in redesigning process. + |========== + | + """.trimMargin() ) } diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/targets/js/npm/NpmDependencyExtension.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/targets/js/npm/NpmDependencyExtension.kt index 839b6cced87..2faf6d4451b 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/targets/js/npm/NpmDependencyExtension.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/targets/js/npm/NpmDependencyExtension.kt @@ -209,22 +209,22 @@ private class DefaultNpmDependencyExtension( delegate.invoke(name, version) @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(name, version) } @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(name, directory) } @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(directory) } @@ -270,22 +270,22 @@ private fun defaultNpmDependencyDelegate( scope, ) { @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(directory) } @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(name, version) } @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(name, directory) } @@ -344,22 +344,22 @@ private class DefaultPeerNpmDependencyExtension( PEER, ) { @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(directory: File, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(directory) } @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(name: String, version: String, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(name, version) } @Deprecated("Dukat integration is in redesigning process. Now it does not work.") - override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { - @Suppress("DEPRECATION") + override fun invoke(name: String, directory: File, generateExternals: Boolean): NpmDependency { + @Suppress("deprecation_error") warnNpmGenerateExternals(project.logger) return invoke(name, directory) }