GradleGalaxy/xyz.srnyx.gradlegalaxy.utility

Package-level declarations

Types

SemanticVersion

class SemanticVersion(version: String) : Comparable<SemanticVersion>

A class to represent a semantic version (example: 1.19.2)

Properties

inGitHubPreRelease

val inGitHubPreRelease: Boolean

inGitHubPublish

val inGitHubPublish: Boolean

inGitHubRelease

val inGitHubRelease: Boolean

inGitHubWorkflow

val inGitHubWorkflow: Boolean

Functions

addBuildShadowTask

fun Project.addBuildShadowTask()

Adds the task that makes gradle build run gradle shadowJar

addCompilerArgs

fun Project.addCompilerArgs(vararg args: String)

Adds the specified compiler arguments to the project

addJavadocSourcesJars

fun Project.addJavadocSourcesJars(javadocClassifier: String? = null, sourcesClassifier: String? = null)

Adds the task that generates the Javadoc and sources jar files

addPlatformsResourceFileTask

fun Project.addPlatformsResourceFileTask(platforms: Map<PluginPlatform, String>): TaskProvider<Task>

addReplacementsTask

fun Project.addReplacementsTask(files: Set<String> = setOf("plugin.yml"), replacements: Map<String, String> = getDefaultReplacements())

Configures the processResources and processTestResources tasks to add replacements

adventure

fun Project.adventure(vararg dependencies: AdventureDependency, configurationAll: String? = null)

annoyingAPI

fun Project.annoyingAPI(config: DependencyConfig, block: ExternalModuleDependency.() -> Unit = {}): List<ExternalModuleDependency>

dependencyRelocate

fun <T : ModuleDependency> Project.dependencyRelocate(dependency: T, relocateFrom: String, relocateTo: String = ".libs.", configuration: String = "implementation", configurationAction: T.() -> Unit = {}): T

fun Project.dependencyRelocate(dependency: String, relocateFrom: String = dependency.split(":").first(), relocateTo: String = ".libs.", configuration: String = "implementation", configurationAction: ExternalModuleDependency.() -> Unit = {}): ExternalModuleDependency

dotsToBrackets

fun String.dotsToBrackets(): String

Replaces all dots in the string with {}

generateAnnoyingApiRuntimeLibraryEnum

fun Project.generateAnnoyingApiRuntimeLibraryEnum(libraries: Collection<RuntimeLibrary>, generateRuntimeLibraryEnumConfig: GenerateRuntimeLibraryEnumConfig = GenerateRuntimeLibraryEnumConfig(), annoyingMetadata: AnnoyingMetadata? = null)

getAnnoyingApiMetadata

fun Project.getAnnoyingApiMetadata(version: String): AnnoyingMetadata?

Gets the metadata for the Annoying API with the specified version

getDefaultReplacements

fun Project.getDefaultReplacements(): Map<String, String>

Returns the default replacements map for addReplacementsTask

getEnvironmentVariable

fun getEnvironmentVariable(name: String): String?

Gets the environment variable with the specified name

getJavaExtension

fun Project.getJavaExtension(): JavaPluginExtension

Gets the Java plugin extension

getJavaVersionForMC

fun getJavaVersionForMC(minecraftVersion: String): JavaVersion

Returns the correct Java version that is required for the Minecraft version

getPackage

fun Project.getPackage(): String

Gets the main package of the project

getPublishing

fun Project.getPublishing(): PublishingExtension

getVersionString

fun getVersionString(version: String): String

Returns the version string with -R0.1-SNAPSHOT appended to it

hasApplicationPlugin

fun Project.hasApplicationPlugin(): Boolean

Checks if the application plugin is applied

hasJavaPlugin

fun Project.hasJavaPlugin(): Boolean

Checks if the java plugin is applied

hasModPublishPlugin

fun Project.hasModPublishPlugin(): Boolean

hasPublishPlugin

fun Project.hasPublishPlugin(): Boolean

Checks if the maven-publish plugin is applied

hasShadowPlugin

fun Project.hasShadowPlugin(): Boolean

Checks if the Shadow plugin is applied

jda

fun Project.jda(config: DependencyConfig, block: ExternalModuleDependency.() -> Unit = {}): List<ExternalModuleDependency>

lazyLibrary

fun Project.lazyLibrary(config: DependencyConfig, block: ExternalModuleDependency.() -> Unit = {}): List<ExternalModuleDependency>

magicMongo

fun Project.magicMongo(config: DependencyConfig, block: ExternalModuleDependency.() -> Unit = {}): List<ExternalModuleDependency>

makePackageSafe

fun makePackageSafe(path: String): String

Makes the given package path safe to use

mockBukkit

fun Project.mockBukkit(config: DependencyConfig, mockBukkitConfig: MockBukkitConfig = MockBukkitConfig(), block: ExternalModuleDependency.() -> Unit = {}): List<ExternalModuleDependency>

paper

fun Project.paper(config: DependencyConfig, spigotConfig: SpigotConfig = SpigotConfig(), block: ExternalModuleDependency.() -> Unit = {}): List<ExternalModuleDependency>

processRelocationTo

fun String.processRelocationTo(): String

Removes {package}.libs. and runs dotsToBrackets

processRuntimeLibraries

fun Project.processRuntimeLibraries(libraries: Collection<RuntimeLibrary>, runtimeLibrariesConfig: RuntimeLibrariesConfig = RuntimeLibrariesConfig())

Processes the specified runtime libraries

relocate

fun Project.relocate(from: String, to: String = ".libs.", action: SimpleRelocator.() -> Unit = {})

Relocates the specified package to the specified package

setJavaVersion

fun Project.setJavaVersion(version: JavaVersion = JavaVersion.VERSION_1_8)

Sets the Java version for the project

setMainClass

fun Project.setMainClass(mainClassName: String? = null)

Sets the main class for the project

setShadowArchiveClassifier

fun Project.setShadowArchiveClassifier(classifier: String = "")

Sets the artifact/archive classifier for the JAR and Shadow JAR tasks

setTextEncoding

fun Project.setTextEncoding(encoding: String = "UTF-8")

Sets the text encoding for the project

setupAnnoyingAPI

fun Project.setupAnnoyingAPI(javaSetupConfig: JavaSetupConfig = JavaSetupConfig(), mcSetupConfig: MCSetupConfig = MCSetupConfig(), annoyingAPIConfig: DependencyConfig, annoyingSetupConfig: AnnoyingSetupConfig = AnnoyingSetupConfig(), metadataConfig: MetadataConfig = MetadataConfig(), customRuntimeLibrariesConfig: CustomRuntimeLibrariesConfig = CustomRuntimeLibrariesConfig(), publishingPlatformConfig: PublishingPlatformConfig = PublishingPlatformConfig(mapOf())): AnnoyingMetadata?

Sets up the project using Annoying API. The root project's name must be the same as the one in plugin.yml!

setupJava

fun Project.setupJava(config: JavaSetupConfig = JavaSetupConfig())

Sets up the project for a simple Java project

setupJda

fun Project.setupJda(javaSetupConfig: JavaSetupConfig = JavaSetupConfig(), jdaSetupConfig: JdaSetupConfig = JdaSetupConfig(), jdaConfig: DependencyConfig)

Sets up the project using JDA (Java-Discord API)

setupLazyLibrary

fun Project.setupLazyLibrary(javaSetupConfig: JavaSetupConfig = JavaSetupConfig(), jdaSetupConfig: JdaSetupConfig = JdaSetupConfig(), jdaConfig: DependencyConfig, lazyLibraryConfig: DependencyConfig)

Sets up the project using Lazy Library

setupMC

fun Project.setupMC(javaSetupConfig: JavaSetupConfig = JavaSetupConfig(), mcSetupConfig: MCSetupConfig = MCSetupConfig())

Sets up the project for Minecraft development

setupMockBukkit

fun Project.setupMockBukkit(junitBomConfig: DependencyConfig, mockBukkitDependencyConfig: DependencyConfig, mockBukkitConfig: MockBukkitConfig = MockBukkitConfig(), block: Test.() -> Unit = {}): TaskProvider<Test>

Sets up the project for testing with JUnit and MockBukkit

setupPublishingEnv

fun Project.setupPublishingEnv(simpleConfig: PublishingSimpleConfig = PublishingSimpleConfig(this), envConfig: PublishingEnvConfig = PublishingEnvConfig()): MavenPublication

Sets up a bit more advanced publishing configuration using environment variables and a custom repository

setupPublishingPlatforms

fun Project.setupPublishingPlatforms(config: PublishingPlatformConfig)

Sets up publishing for project platforms (GitHub, Modrinth, CurseForge)

setupPublishingSimple

fun Project.setupPublishingSimple(config: PublishingSimpleConfig = PublishingSimpleConfig(this), configuration: MavenPublication.() -> Unit = {}): MavenPublication

Sets up a simple publishing configuration

setupTesting

fun Project.setupTesting(junitBomConfig: DependencyConfig, block: Test.() -> Unit = {}): TaskProvider<Test>

Sets up the project for testing with JUnit

silenceMissingJavaDocWarnings

fun Project.silenceMissingJavaDocWarnings()

Silences missing JavaDoc warnings

spigotAPI

fun Project.spigotAPI(config: DependencyConfig, spigotConfig: SpigotConfig = SpigotConfig(), block: ExternalModuleDependency.() -> Unit = {}): List<ExternalModuleDependency>

spigotNMS

fun Project.spigotNMS(config: DependencyConfig, spigotConfig: SpigotConfig = SpigotConfig(), block: ExternalModuleDependency.() -> Unit = {}): List<ExternalModuleDependency>