From 36a185bd4a486799338188d2f8d605bcdb86c57d Mon Sep 17 00:00:00 2001 From: vmishenev Date: Wed, 22 Jun 2022 15:15:35 +0300 Subject: [PATCH 1/2] Give notice of alpha version for GFM, Javadoc, Jekyll formats --- plugins/gfm/api/gfm.api | 1 + .../main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt | 11 +++++++++++ plugins/javadoc/api/javadoc.api | 1 + .../org/jetbrains/dokka/javadoc/JavadocPlugin.kt | 11 +++++++++++ plugins/jekyll/api/jekyll.api | 1 + plugins/jekyll/src/main/kotlin/JekyllPlugin.kt | 11 +++++++++++ 6 files changed, 36 insertions(+) diff --git a/plugins/gfm/api/gfm.api b/plugins/gfm/api/gfm.api index b697021103..9e177eaf3b 100644 --- a/plugins/gfm/api/gfm.api +++ b/plugins/gfm/api/gfm.api @@ -11,6 +11,7 @@ public final class org/jetbrains/dokka/gfm/GfmCommand$Companion { public final class org/jetbrains/dokka/gfm/GfmPlugin : org/jetbrains/dokka/plugability/DokkaPlugin { public fun ()V + public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getBriefCommentPreprocessor ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getGfmPreprocessors ()Lorg/jetbrains/dokka/plugability/ExtensionPoint; public final fun getLocationProvider ()Lorg/jetbrains/dokka/plugability/Extension; diff --git a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt index 78597d445e..c8951c5502 100644 --- a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt +++ b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt @@ -10,6 +10,8 @@ import org.jetbrains.dokka.gfm.renderer.BriefCommentPreprocessor import org.jetbrains.dokka.gfm.renderer.CommonmarkRenderer import org.jetbrains.dokka.plugability.DokkaPlugin import org.jetbrains.dokka.transformers.pages.PageTransformer +import org.jetbrains.dokka.validity.PreGenerationChecker +import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class GfmPlugin : DokkaPlugin() { @@ -38,4 +40,13 @@ class GfmPlugin : DokkaPlugin() { providing { PackageListCreator(it, RecognizedLinkFormat.DokkaGFM) } order { after(rootCreator) }) } + + val alphaVersionNotifier by extending { + CoreExtensions.preGenerationCheck providing { ctx -> + PreGenerationChecker { + ctx.logger.warn("The GFM output format is in Alpha version") + PreGenerationCheckerOutput(true, emptyList()) + } + } + } } diff --git a/plugins/javadoc/api/javadoc.api b/plugins/javadoc/api/javadoc.api index 70a69a7921..f1896117b5 100644 --- a/plugins/javadoc/api/javadoc.api +++ b/plugins/javadoc/api/javadoc.api @@ -14,6 +14,7 @@ public class org/jetbrains/dokka/javadoc/JavadocPageCreator { public final class org/jetbrains/dokka/javadoc/JavadocPlugin : org/jetbrains/dokka/plugability/DokkaPlugin { public fun ()V public final fun getAllClassessPageInstaller ()Lorg/jetbrains/dokka/plugability/Extension; + public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getDeprecatedPageCreator ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getDocumentableSourceSetFilter ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getDokkaBasePlugin ()Lorg/jetbrains/dokka/base/DokkaBase; diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt index 7f90f1ce15..1c8f67dd64 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt @@ -15,6 +15,8 @@ import org.jetbrains.dokka.javadoc.validity.MultiplatformConfiguredChecker import org.jetbrains.dokka.kotlinAsJava.KotlinAsJavaPlugin import org.jetbrains.dokka.plugability.DokkaPlugin import org.jetbrains.dokka.transformers.pages.PageTransformer +import org.jetbrains.dokka.validity.PreGenerationChecker +import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class JavadocPlugin : DokkaPlugin() { @@ -81,5 +83,14 @@ class JavadocPlugin : DokkaPlugin() { val deprecatedPageCreator by extending { javadocPreprocessors with DeprecatedPageCreator order { before(rootCreator) } } + + val alphaVersionNotifier by extending { + CoreExtensions.preGenerationCheck providing { ctx -> + PreGenerationChecker { + ctx.logger.warn("The Javadoc output format is in Alpha version") + PreGenerationCheckerOutput(true, emptyList()) + } + } + } } diff --git a/plugins/jekyll/api/jekyll.api b/plugins/jekyll/api/jekyll.api index 2d75b214d2..081c18cea6 100644 --- a/plugins/jekyll/api/jekyll.api +++ b/plugins/jekyll/api/jekyll.api @@ -1,5 +1,6 @@ public final class org/jetbrains/dokka/jekyll/JekyllPlugin : org/jetbrains/dokka/plugability/DokkaPlugin { public fun ()V + public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getBriefCommentPreprocessor ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getJekyllPreprocessors ()Lorg/jetbrains/dokka/plugability/ExtensionPoint; public final fun getLocationProvider ()Lorg/jetbrains/dokka/plugability/Extension; diff --git a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt index 4dfd21d36a..7bfcbc2ae0 100644 --- a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt +++ b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt @@ -15,6 +15,8 @@ import org.jetbrains.dokka.plugability.DokkaPlugin import org.jetbrains.dokka.plugability.plugin import org.jetbrains.dokka.plugability.query import org.jetbrains.dokka.transformers.pages.PageTransformer +import org.jetbrains.dokka.validity.PreGenerationChecker +import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class JekyllPlugin : DokkaPlugin() { @@ -47,6 +49,15 @@ class JekyllPlugin : DokkaPlugin() { val locationProvider by extending { dokkaBase.locationProviderFactory providing ::DokkaLocationProviderFactory override listOf(gfmPlugin.locationProvider) } + + val alphaVersionNotifier by extending { + CoreExtensions.preGenerationCheck providing { ctx -> + PreGenerationChecker { + ctx.logger.warn("The Jekyll output format is in Alpha version") + PreGenerationCheckerOutput(true, emptyList()) + } + } + } } class JekyllRenderer( From c57134a5b30e81833b5259ee483e500179f31713 Mon Sep 17 00:00:00 2001 From: vmishenev Date: Tue, 26 Jul 2022 13:06:53 +0300 Subject: [PATCH 2/2] Change message of notice and add it for KaJ plugin --- plugins/gfm/api/gfm.api | 1 - .../main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt | 12 +++++------- plugins/javadoc/api/javadoc.api | 1 - .../org/jetbrains/dokka/javadoc/JavadocPlugin.kt | 12 +++++------- plugins/jekyll/api/jekyll.api | 1 - plugins/jekyll/src/main/kotlin/JekyllPlugin.kt | 12 +++++------- .../src/main/kotlin/KotlinAsJavaPlugin.kt | 9 +++++++++ 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/plugins/gfm/api/gfm.api b/plugins/gfm/api/gfm.api index 9e177eaf3b..b697021103 100644 --- a/plugins/gfm/api/gfm.api +++ b/plugins/gfm/api/gfm.api @@ -11,7 +11,6 @@ public final class org/jetbrains/dokka/gfm/GfmCommand$Companion { public final class org/jetbrains/dokka/gfm/GfmPlugin : org/jetbrains/dokka/plugability/DokkaPlugin { public fun ()V - public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getBriefCommentPreprocessor ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getGfmPreprocessors ()Lorg/jetbrains/dokka/plugability/ExtensionPoint; public final fun getLocationProvider ()Lorg/jetbrains/dokka/plugability/Extension; diff --git a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt index c8951c5502..f3c44dac85 100644 --- a/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt +++ b/plugins/gfm/src/main/kotlin/org/jetbrains/dokka/gfm/GfmPlugin.kt @@ -9,9 +9,8 @@ import org.jetbrains.dokka.gfm.location.MarkdownLocationProvider import org.jetbrains.dokka.gfm.renderer.BriefCommentPreprocessor import org.jetbrains.dokka.gfm.renderer.CommonmarkRenderer import org.jetbrains.dokka.plugability.DokkaPlugin +import org.jetbrains.dokka.renderers.PostAction import org.jetbrains.dokka.transformers.pages.PageTransformer -import org.jetbrains.dokka.validity.PreGenerationChecker -import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class GfmPlugin : DokkaPlugin() { @@ -41,11 +40,10 @@ class GfmPlugin : DokkaPlugin() { order { after(rootCreator) }) } - val alphaVersionNotifier by extending { - CoreExtensions.preGenerationCheck providing { ctx -> - PreGenerationChecker { - ctx.logger.warn("The GFM output format is in Alpha version") - PreGenerationCheckerOutput(true, emptyList()) + internal val alphaVersionNotifier by extending { + CoreExtensions.postActions providing { ctx -> + PostAction { + ctx.logger.warn("GFM output format is in Alpha version, use at your own risk, expect bugs and migration issues") } } } diff --git a/plugins/javadoc/api/javadoc.api b/plugins/javadoc/api/javadoc.api index f1896117b5..70a69a7921 100644 --- a/plugins/javadoc/api/javadoc.api +++ b/plugins/javadoc/api/javadoc.api @@ -14,7 +14,6 @@ public class org/jetbrains/dokka/javadoc/JavadocPageCreator { public final class org/jetbrains/dokka/javadoc/JavadocPlugin : org/jetbrains/dokka/plugability/DokkaPlugin { public fun ()V public final fun getAllClassessPageInstaller ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getDeprecatedPageCreator ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getDocumentableSourceSetFilter ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getDokkaBasePlugin ()Lorg/jetbrains/dokka/base/DokkaBase; diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt index 1c8f67dd64..a067de8411 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt @@ -14,9 +14,8 @@ import org.jetbrains.dokka.javadoc.transformers.documentables.JavadocDocumentabl import org.jetbrains.dokka.javadoc.validity.MultiplatformConfiguredChecker import org.jetbrains.dokka.kotlinAsJava.KotlinAsJavaPlugin import org.jetbrains.dokka.plugability.DokkaPlugin +import org.jetbrains.dokka.renderers.PostAction import org.jetbrains.dokka.transformers.pages.PageTransformer -import org.jetbrains.dokka.validity.PreGenerationChecker -import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class JavadocPlugin : DokkaPlugin() { @@ -84,11 +83,10 @@ class JavadocPlugin : DokkaPlugin() { javadocPreprocessors with DeprecatedPageCreator order { before(rootCreator) } } - val alphaVersionNotifier by extending { - CoreExtensions.preGenerationCheck providing { ctx -> - PreGenerationChecker { - ctx.logger.warn("The Javadoc output format is in Alpha version") - PreGenerationCheckerOutput(true, emptyList()) + internal val alphaVersionNotifier by extending { + CoreExtensions.postActions providing { ctx -> + PostAction { + ctx.logger.warn("Javadoc output format is in Alpha version, use at your own risk, expect bugs and migration issues") } } } diff --git a/plugins/jekyll/api/jekyll.api b/plugins/jekyll/api/jekyll.api index 081c18cea6..2d75b214d2 100644 --- a/plugins/jekyll/api/jekyll.api +++ b/plugins/jekyll/api/jekyll.api @@ -1,6 +1,5 @@ public final class org/jetbrains/dokka/jekyll/JekyllPlugin : org/jetbrains/dokka/plugability/DokkaPlugin { public fun ()V - public final fun getAlphaVersionNotifier ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getBriefCommentPreprocessor ()Lorg/jetbrains/dokka/plugability/Extension; public final fun getJekyllPreprocessors ()Lorg/jetbrains/dokka/plugability/ExtensionPoint; public final fun getLocationProvider ()Lorg/jetbrains/dokka/plugability/Extension; diff --git a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt index 7bfcbc2ae0..2b6d646d99 100644 --- a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt +++ b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt @@ -14,9 +14,8 @@ import org.jetbrains.dokka.plugability.DokkaContext import org.jetbrains.dokka.plugability.DokkaPlugin import org.jetbrains.dokka.plugability.plugin import org.jetbrains.dokka.plugability.query +import org.jetbrains.dokka.renderers.PostAction import org.jetbrains.dokka.transformers.pages.PageTransformer -import org.jetbrains.dokka.validity.PreGenerationChecker -import org.jetbrains.dokka.validity.PreGenerationCheckerOutput class JekyllPlugin : DokkaPlugin() { @@ -50,11 +49,10 @@ class JekyllPlugin : DokkaPlugin() { dokkaBase.locationProviderFactory providing ::DokkaLocationProviderFactory override listOf(gfmPlugin.locationProvider) } - val alphaVersionNotifier by extending { - CoreExtensions.preGenerationCheck providing { ctx -> - PreGenerationChecker { - ctx.logger.warn("The Jekyll output format is in Alpha version") - PreGenerationCheckerOutput(true, emptyList()) + internal val alphaVersionNotifier by extending { + CoreExtensions.postActions providing { ctx -> + PostAction { + ctx.logger.warn("Jekyll output format is in Alpha version, use at your own risk, expect bugs and migration issues") } } } diff --git a/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt b/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt index aae6f57046..3c204047f8 100644 --- a/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt +++ b/plugins/kotlin-as-java/src/main/kotlin/KotlinAsJavaPlugin.kt @@ -7,6 +7,7 @@ import org.jetbrains.dokka.kotlinAsJava.transformers.JvmNameDocumentableTransfor import org.jetbrains.dokka.kotlinAsJava.transformers.KotlinAsJavaDocumentableTransformer import org.jetbrains.dokka.kotlinAsJava.translators.KotlinAsJavaDocumentableToPageTranslator import org.jetbrains.dokka.plugability.DokkaPlugin +import org.jetbrains.dokka.renderers.PostAction class KotlinAsJavaPlugin : DokkaPlugin() { val kotlinAsJavaDocumentableTransformer by extending { @@ -29,4 +30,12 @@ class KotlinAsJavaPlugin : DokkaPlugin() { CoreExtensions.documentableToPageTranslator providing ::KotlinAsJavaDocumentableToPageTranslator override plugin().documentableToPageTranslator } + + internal val alphaVersionNotifier by extending { + CoreExtensions.postActions providing { ctx -> + PostAction { + ctx.logger.warn("KotlinAsJava plugin is in Alpha version, use at your own risk, expect bugs and migration issues") + } + } + } }