feat(ServerConfiguration): Change args type from String to List

Author: osipxd

CHANGELOG.md

@@ -42,15 +42,16 @@ The plugin has been converted to Kotlin to make support easier.
 The plugin still can be configured with Groovy DSL but
 now it is friendly to Kotlin DSL.
 
-### Added
-- Configuration avoidance and build cache for task `generateMetaData`
-- Add `nogui` argument by default to `bukkitArgs`
-
 ### Removed
 - Task `:rebuildServerCore`, use `:buildServerCore --rerun-tasks` instead
 - Extension `DependencyHandler.craftbukkit()`, use `DependencyHandler.spigot()` instead
 - Automatic `mavenLocal()` apply, you should apply it manually if you need it
 
+### Changed
+- Add `nogui` argument by default to `bukkitArgs`
+- Type of properties `server.jvmArgs` and `server.bukkitArgs` changed from `String` to `List<String>`.
+  It makes it easier to add arguments without overriding defaults
+
 ### Housekeeping
 - Default bukkit version now is 1.16.4
 - Update Gradle to 6.7.1

README.md

@@ -227,9 +227,9 @@ bukkit {
         // Set server encoding (flag -Dfile.encoding)
         encoding = "UTF-8"
         // JVM arguments
-        javaArgs = "-Xmx1G"
+        javaArgs("-Xmx1G")
         // Bukkit arguments
-        bukkitArgs = "nogui"
+        bukkitArgs("nogui")
     }
 }
 ```

src/main/kotlin/server/DevServerPlugin.kt

@@ -147,8 +147,8 @@ public class DevServerPlugin : Plugin<Project> {
     ) {
         tasks.register<RunServer>("runServer") {
             workingDir(serverDir)
-            jvmArgs = serverConfiguration.buildJvmArgs().split(" ")
-            bukkitArgs = serverConfiguration.bukkitArgs.split(" ")
+            jvmArgs = serverConfiguration.buildJvmArgs()
+            bukkitArgs = serverConfiguration.bukkitArgs
             dependsOn(prepareServer)
         }
     }

src/main/kotlin/server/extension/ServerConfiguration.kt

@@ -7,10 +7,10 @@ public interface ServerConfiguration {
     public val onlineMode: Boolean
     public val debug: Boolean
     public val encoding: String
-    public val javaArgs: String
-    public val bukkitArgs: String
+    public val javaArgs: List<String>
+    public val bukkitArgs: List<String>
     public val coreType: CoreType
 
     /** Returns arguments for JVM. */
-    public fun buildJvmArgs(): String
+    public fun buildJvmArgs(): List<String>
 }

src/main/kotlin/server/extension/ServerConfigurationImpl.kt

@@ -13,8 +13,9 @@ public class ServerConfigurationImpl : ServerConfiguration {
     override var onlineMode: Boolean = false
     override var debug: Boolean = true
     override var encoding: String = "UTF-8"
-    override var javaArgs: String = "-Xmx1G"
-    override var bukkitArgs: String = "nogui"
+
+    override var javaArgs: List<String> = listOf("-Xmx1G")
+    override var bukkitArgs: List<String> = listOf("nogui")
 
     override var coreType: CoreType = CoreType.SPIGOT
 
@@ -37,8 +38,18 @@ public class ServerConfigurationImpl : ServerConfiguration {
         }
     }
 
-    override fun buildJvmArgs(): String {
-        return "${if (debug) "$DEBUG_ARGS " else ""}-Dfile.encoding=$encoding $javaArgs"
+    /** Append the given [args] to `javaArgs`. */
+    public fun javaArgs(vararg args: String) {
+        javaArgs = javaArgs + args.toList()
+    }
+
+    /** Append the given [args] to `bukkitArgs`. */
+    public fun bukkitArgs(vararg args: String) {
+        bukkitArgs = bukkitArgs + args.toList()
+    }
+
+    override fun buildJvmArgs(): List<String> {
+        return listOfNotNull(DEBUG_ARGS.takeIf { debug }, "-Dfile.encoding=$encoding") + javaArgs
     }
 
     override fun toString(): String {

src/test/groovy/ru/endlesscode/bukkitgradle/server/extension/ServerConfigurationSpec.groovy

@@ -5,52 +5,52 @@ import spock.lang.Specification
 class ServerConfigurationSpec extends Specification {
 
     // SUT
-    ServerConfigurationImpl runConfiguration
+    ServerConfigurationImpl serverConfiguration
 
     void setup() {
-        runConfiguration = new ServerConfigurationImpl()
+        serverConfiguration = new ServerConfigurationImpl()
     }
 
     void 'when build args - should return args with debug flags'() {
         when:
-        def args = runConfiguration.buildJvmArgs()
+        def args = serverConfiguration.buildJvmArgs()
 
         then:
-        "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -Dfile.encoding=UTF-8 -Xmx1G" == args
+        ["-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005", "-Dfile.encoding=UTF-8", "-Xmx1G"] == args
     }
 
     void 'when build args - and debug disabled - should return args without debug flags'() {
         given:
-        runConfiguration.debug = false
+        serverConfiguration.debug = false
 
         when:
-        def args = runConfiguration.buildJvmArgs()
+        def args = serverConfiguration.buildJvmArgs()
 
         then:
-        "-Dfile.encoding=UTF-8 -Xmx1G" == args
+        ["-Dfile.encoding=UTF-8", "-Xmx1G"] == args
     }
 
     void 'when set existing core - should set core successfully'() {
         when:
-        runConfiguration.core = "paper"
+        serverConfiguration.core = "paper"
 
         then:
-        CoreType.PAPER == runConfiguration.coreType
+        CoreType.PAPER == serverConfiguration.coreType
     }
 
     void 'when set existing core in mixed case - should set core successfully'() {
         when:
-        runConfiguration.core = "Paper"
+        serverConfiguration.core = "Paper"
 
         then:
-        CoreType.PAPER == runConfiguration.coreType
+        CoreType.PAPER == serverConfiguration.coreType
     }
 
     void 'when set not existing core - should fallback to spigot core'() {
         when:
-        runConfiguration.core = "uber-bukkit"
+        serverConfiguration.core = "uber-bukkit"
 
         then:
-        CoreType.SPIGOT == runConfiguration.coreType
+        CoreType.SPIGOT == serverConfiguration.coreType
     }
 }