diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-11-10 11:46:54 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-10 11:46:54 +0100 |
| commit | 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch) | |
| tree | 1b915207b2b9f61951ddbf0ff2e687efd053d555 /runners | |
| parent | a44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff) | |
| download | dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2 dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip | |
Restructure the project to utilize included builds (#3174)
* Refactor and simplify artifact publishing
* Update Gradle to 8.4
* Refactor and simplify convention plugins and build scripts
Fixes #3132
---------
Co-authored-by: Adam <897017+aSemy@users.noreply.github.com>
Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
Diffstat (limited to 'runners')
79 files changed, 0 insertions, 7426 deletions
diff --git a/runners/cli/api/cli.api b/runners/cli/api/cli.api deleted file mode 100644 index 74769272..00000000 --- a/runners/cli/api/cli.api +++ /dev/null @@ -1,101 +0,0 @@ -public final class org/jetbrains/dokka/ArgTypeArgument : kotlinx/cli/ArgType { - public fun <init> (Lkotlinx/cli/CLIEntity;)V - public final fun component1 ()Lkotlinx/cli/CLIEntity; - public synthetic fun convert (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object; - public fun convert (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet; - public final fun copy (Lkotlinx/cli/CLIEntity;)Lorg/jetbrains/dokka/ArgTypeArgument; - public static synthetic fun copy$default (Lorg/jetbrains/dokka/ArgTypeArgument;Lkotlinx/cli/CLIEntity;ILjava/lang/Object;)Lorg/jetbrains/dokka/ArgTypeArgument; - public fun equals (Ljava/lang/Object;)Z - public fun getDescription ()Ljava/lang/String; - public final fun getModuleName ()Lkotlinx/cli/CLIEntity; - public fun hashCode ()I - public fun toString ()Ljava/lang/String; -} - -public final class org/jetbrains/dokka/ArgTypeFile : kotlinx/cli/ArgType { - public static final field INSTANCE Lorg/jetbrains/dokka/ArgTypeFile; - public fun convert (Ljava/lang/String;Ljava/lang/String;)Ljava/io/File; - public synthetic fun convert (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object; - public fun getDescription ()Ljava/lang/String; -} - -public final class org/jetbrains/dokka/ArgTypeHelpSourceSet : kotlinx/cli/ArgType { - public fun <init> (Lkotlinx/cli/CLIEntity;)V - public final fun component1 ()Lkotlinx/cli/CLIEntity; - public fun convert (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object; - public final fun copy (Lkotlinx/cli/CLIEntity;)Lorg/jetbrains/dokka/ArgTypeHelpSourceSet; - public static synthetic fun copy$default (Lorg/jetbrains/dokka/ArgTypeHelpSourceSet;Lkotlinx/cli/CLIEntity;ILjava/lang/Object;)Lorg/jetbrains/dokka/ArgTypeHelpSourceSet; - public fun equals (Ljava/lang/Object;)Z - public fun getDescription ()Ljava/lang/String; - public final fun getModuleName ()Lkotlinx/cli/CLIEntity; - public fun hashCode ()I - public fun toString ()Ljava/lang/String; -} - -public final class org/jetbrains/dokka/ArgTypePlatform : kotlinx/cli/ArgType { - public static final field INSTANCE Lorg/jetbrains/dokka/ArgTypePlatform; - public synthetic fun convert (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object; - public fun convert (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/dokka/Platform; - public fun getDescription ()Ljava/lang/String; -} - -public final class org/jetbrains/dokka/ArgTypePlugin : kotlinx/cli/ArgType { - public static final field INSTANCE Lorg/jetbrains/dokka/ArgTypePlugin; - public synthetic fun convert (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object; - public fun convert (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaConfiguration$PluginConfiguration; - public fun getDescription ()Ljava/lang/String; -} - -public final class org/jetbrains/dokka/ArgTypeSourceLinkDefinition : kotlinx/cli/ArgType { - public static final field INSTANCE Lorg/jetbrains/dokka/ArgTypeSourceLinkDefinition; - public synthetic fun convert (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object; - public fun convert (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaConfiguration$SourceLinkDefinition; - public fun getDescription ()Ljava/lang/String; -} - -public final class org/jetbrains/dokka/ArgTypeVisibility : kotlinx/cli/ArgType { - public static final field INSTANCE Lorg/jetbrains/dokka/ArgTypeVisibility; - public synthetic fun convert (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object; - public fun convert (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaConfiguration$Visibility; - public fun getDescription ()Ljava/lang/String; -} - -public final class org/jetbrains/dokka/GlobalArguments : org/jetbrains/dokka/DokkaConfiguration { - public fun <init> ([Ljava/lang/String;)V - public synthetic fun getCacheRoot ()Ljava/io/File; - public fun getCacheRoot ()Ljava/lang/Void; - public fun getDelayTemplateSubstitution ()Z - public fun getFailOnWarning ()Z - public fun getFinalizeCoroutines ()Z - public final fun getGlobalLinks ()Ljava/util/List; - public final fun getGlobalPackageOptions ()Ljava/util/List; - public final fun getGlobalSrcLink ()Ljava/util/List; - public final fun getHelpSourceSet ()Ljava/lang/Object; - public fun getIncludes ()Ljava/util/Set; - public final fun getJson ()Ljava/lang/String; - public final fun getLogger ()Lorg/jetbrains/dokka/utilities/DokkaLogger; - public final fun getLoggingLevel ()Lorg/jetbrains/dokka/utilities/LoggingLevel; - public fun getModuleName ()Ljava/lang/String; - public fun getModuleVersion ()Ljava/lang/String; - public fun getModules ()Ljava/util/List; - public final fun getNoSuppressObviousFunctions ()Z - public fun getOfflineMode ()Z - public fun getOutputDir ()Ljava/io/File; - public final fun getParser ()Lkotlinx/cli/ArgParser; - public fun getPluginsClasspath ()Ljava/util/List; - public fun getPluginsConfiguration ()Ljava/util/List; - public fun getSourceSets ()Ljava/util/List; - public fun getSuppressInheritedMembers ()Z - public fun getSuppressObviousFunctions ()Z -} - -public final class org/jetbrains/dokka/LinkMapperKt { - public static final fun defaultLinks (Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)Ljava/util/List; - public static final fun parseLinks (Ljava/util/List;)Ljava/util/List; -} - -public final class org/jetbrains/dokka/MainKt { - public static final fun initializeConfiguration (Lorg/jetbrains/dokka/GlobalArguments;)Lorg/jetbrains/dokka/DokkaConfiguration; - public static final fun main ([Ljava/lang/String;)V -} - diff --git a/runners/cli/build.gradle.kts b/runners/cli/build.gradle.kts deleted file mode 100644 index 6633dd84..00000000 --- a/runners/cli/build.gradle.kts +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. - */ - -import org.jetbrains.DokkaPublicationBuilder.Component.Shadow -import org.jetbrains.registerDokkaArtifactPublication - -plugins { - id("org.jetbrains.conventions.kotlin-jvm") - id("org.jetbrains.conventions.maven-publish") - id("com.github.johnrengelman.shadow") -} - -dependencies { - implementation(projects.core) - implementation(libs.kotlinx.cli) - - testImplementation(kotlin("test")) -} - -tasks { - shadowJar { - val dokka_version: String by project - archiveFileName.set("dokka-cli-$dokka_version.jar") - archiveClassifier.set("") - manifest { - attributes("Main-Class" to "org.jetbrains.dokka.MainKt") - } - } -} - -registerDokkaArtifactPublication("dokkaCli") { - artifactId = "dokka-cli" - component = Shadow -} diff --git a/runners/cli/src/main/kotlin/org/jetbrains/dokka/CliArgumentTypes.kt b/runners/cli/src/main/kotlin/org/jetbrains/dokka/CliArgumentTypes.kt deleted file mode 100644 index 1c6b0ba4..00000000 --- a/runners/cli/src/main/kotlin/org/jetbrains/dokka/CliArgumentTypes.kt +++ /dev/null @@ -1,97 +0,0 @@ -/* - * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. - */ - -package org.jetbrains.dokka - -import kotlinx.cli.ArgParser -import kotlinx.cli.ArgType -import kotlinx.cli.CLIEntity -import java.io.File -import java.nio.file.Paths - - -public object ArgTypeFile : ArgType<File>(true) { - override fun convert(value: kotlin.String, name: kotlin.String): File = Paths.get(value).toRealPath().toFile() - override val description: kotlin.String - get() = "{ String that represents a directory / file path }" -} - -public object ArgTypePlatform : ArgType<Platform>(true) { - override fun convert(value: kotlin.String, name: kotlin.String): Platform = Platform.fromString(value) - override val description: kotlin.String - get() = "{ String that represents a Kotlin platform. Possible values: jvm/js/native/common/android }" -} - -public object ArgTypeVisibility : ArgType<DokkaConfiguration.Visibility>(true) { - override fun convert(value: kotlin.String, name: kotlin.String): DokkaConfiguration.Visibility { - return DokkaConfiguration.Visibility.fromString(value) - } - - override val description: kotlin.String - get() = "{ String that represents a visibility modifier. Possible values: ${getPossibleVisibilityValues()}" - - private fun getPossibleVisibilityValues(): kotlin.String = - DokkaConfiguration.Visibility.values().joinToString(separator = ", ") -} - -public object ArgTypePlugin : ArgType<DokkaConfiguration.PluginConfiguration>(true) { - override fun convert( - value: kotlin.String, - name: kotlin.String - ): DokkaConfiguration.PluginConfiguration { - return value.split("=").let { - PluginConfigurationImpl( - fqPluginName = it[0], - serializationFormat = DokkaConfiguration.SerializationFormat.JSON, - values = it[1] - ) - } - } - - override val description: kotlin.String - get() = "{ String that represents plugin configuration. " + - "Format is {fullyQualifiedPluginName}={jsonConfiguration}. " + - "Quotation marks (`\"`) inside json must be escaped. }" -} - -public object ArgTypeSourceLinkDefinition : ArgType<DokkaConfiguration.SourceLinkDefinition>(true) { - override fun convert(value: kotlin.String, name: kotlin.String): DokkaConfiguration.SourceLinkDefinition { - return if (value.isNotEmpty() && value.contains("=")) - SourceLinkDefinitionImpl.parseSourceLinkDefinition(value) - else { - throw IllegalArgumentException( - "Warning: Invalid -srcLink syntax. " + - "Expected: <path>=<url>[#lineSuffix]. No source links will be generated." - ) - } - } - - override val description: kotlin.String - get() = "{ String that represent source links. Format: {srcPath}={remotePath#lineSuffix} }" -} - -public data class ArgTypeArgument(val moduleName: CLIEntity<kotlin.String>) : - ArgType<DokkaConfiguration.DokkaSourceSet>(true) { - override fun convert(value: kotlin.String, name: kotlin.String): DokkaConfiguration.DokkaSourceSet = - (if (moduleName.valueOrigin != ArgParser.ValueOrigin.UNSET && moduleName.valueOrigin != ArgParser.ValueOrigin.UNDEFINED) { - moduleName.value - } else { - DokkaDefaults.moduleName - }).let { moduleNameOrDefault -> - parseSourceSet(moduleNameOrDefault, value.split(" ").filter { it.isNotBlank() }.toTypedArray()) - } - - override val description: kotlin.String - get() = "" -} - -// Workaround for printing nested parsers help -public data class ArgTypeHelpSourceSet(val moduleName: CLIEntity<kotlin.String>) : ArgType<Any>(false) { - override fun convert(value: kotlin.String, name: kotlin.String): Any = Any().also { - parseSourceSet(moduleName.value, arrayOf("-h")) - } - |
