From 2081087c76970cc20298250418a4d3ada22fb657 Mon Sep 17 00:00:00 2001 From: KingRainbow44 Date: Fri, 31 Mar 2023 22:14:56 -0400 Subject: [PATCH] Format `build.gradle` and add dependency for JUnit tests --- build.gradle | 156 ++++++++++++++++++++++++++++++++------------------- 1 file changed, 98 insertions(+), 58 deletions(-) diff --git a/build.gradle b/build.gradle index 678862d30..ab3a287d5 100644 --- a/build.gradle +++ b/build.gradle @@ -1,3 +1,5 @@ +import org.gradle.plugins.ide.eclipse.model.SourceFolder + /* * This file was generated by the Gradle 'init' task. * @@ -8,7 +10,7 @@ buildscript { repositories { - maven { url "https://plugins.gradle.org/m2/" } + maven { url 'https://plugins.gradle.org/m2/' } } dependencies { classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.18' @@ -16,40 +18,41 @@ buildscript { } plugins { - // Apply the application plugin to add support for building a CLI application - id 'application' + id 'java' // Apply the java plugin to add support for Java + id 'java-library' // Apply the java-library plugin for API and implementation separation. + id 'application' // Apply the application plugin to add support for building a CLI application + id 'com.google.protobuf' version '0.8.18' // Apply the protobuf auto generator + id 'com.diffplug.spotless' version '6.11.0' // Apply the Spotless linter plugin. - // Apply the java plugin to add support for Java - id 'java' + id 'eclipse' // Eclipse Support + id 'idea' // IntelliJ Support - // Apply the protobuf auto generator - id 'com.google.protobuf' version "0.8.18" + id 'maven-publish' // Support for publishing to Maven repositories. + id 'signing' // Support for signing build artifacts. - // Eclipse Support - id 'eclipse' - - // IntelliJ Support - id 'idea' - - // Maven - id 'maven-publish' - id 'signing' - - // Lombok for delombok'ification - id "io.freefair.lombok" version "6.6.1" + id 'io.freefair.lombok' version '6.6.1' // Lombok for delombok'ification } -compileJava.options.encoding = "UTF-8" -compileTestJava.options.encoding = "UTF-8" +spotless { + java { + importOrder('io.grasscutter', '', 'java', 'javax', '\\#java', '\\#') // Configure import order. + googleJavaFormat('1.15.0') // Use Google's Java formatter. + .reflowLongStrings() // Reflow long strings. + formatAnnotations() // Reformat annotations. + endWithNewline() // Ensure files end with a newline. + indentWithTabs(2); indentWithSpaces(4) // Use 4 spaces for indentation. + toggleOffOn() // Toggle off/on. + } +} + +compileJava.options.encoding = 'UTF-8' +compileTestJava.options.encoding = 'UTF-8' sourceCompatibility = JavaVersion.VERSION_17 targetCompatibility = JavaVersion.VERSION_17 -group = 'xyz.grasscutters' -version = '1.4.7' - -sourceCompatibility = 17 -targetCompatibility = 17 +group = 'io.grasscutter' +version = '2.0.0-unstable' java { withJavadocJar() @@ -61,53 +64,77 @@ repositories { } dependencies { + // Additional JAR libraries. implementation fileTree(dir: 'lib', include: ['*.jar']) implementation group: 'it.unimi.dsi', name: 'fastutil', version: '8.5.8' + // Logging libraries. implementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.36' implementation group: 'ch.qos.logback', name: 'logback-core', version: '1.2.11' implementation group: 'ch.qos.logback', name: 'logback-classic', version: '1.2.11' + // Line reading libraries. implementation group: 'org.jline', name: 'jline', version: '3.21.0' implementation group: 'org.jline', name: 'jline-terminal-jna', version: '3.21.0' implementation group: 'net.java.dev.jna', name: 'jna', version: '5.10.0' + // Java Netty for networking. implementation group: 'io.netty', name: 'netty-common', version: '4.1.79.Final' implementation group: 'io.netty', name: 'netty-handler', version: '4.1.79.Final' implementation group: 'io.netty', name: 'netty-transport-native-epoll', version: '4.1.79.Final' implementation group: 'io.netty', name: 'netty-transport-native-kqueue', version: '4.1.79.Final' + // Serialization. implementation group: 'com.google.code.gson', name: 'gson', version: '2.9.0' - implementation group: 'com.google.protobuf', name: 'protobuf-java', version: '3.18.2' + implementation group: 'com.google.protobuf', name: 'protobuf-java', version: '3.19.6' + implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.14.2' + implementation platform('com.fasterxml.jackson:jackson-bom:2.14.0') + implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.14.2' + + // Reflections libraries. implementation group: 'org.reflections', name: 'reflections', version: '0.10.2' - - implementation group: 'dev.morphia.morphia', name: 'morphia-core', version: '2.2.7' - - implementation group: 'org.greenrobot', name: 'eventbus-java', version: '3.3.1' - //implementation group: 'org.danilopianini', name: 'java-quadtree', version: '0.1.9' - - implementation group: 'org.quartz-scheduler', name: 'quartz', version: '2.3.2' - implementation group: 'org.quartz-scheduler', name: 'quartz-jobs', version: '2.3.2' - - implementation group: 'org.luaj', name: 'luaj-jse', version: '3.0.1' - implementation group: 'com.esotericsoftware', name: 'reflectasm', version: '1.11.9' implementation group: 'com.github.davidmoten', name: 'rtree-multi', version: '0.1' - implementation group: 'io.javalin', name: 'javalin', version: '4.6.4' - implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.13.3' + // MongoDB object mapper. + implementation group: 'dev.morphia.morphia', name: 'morphia-core', version: '2.2.7' + // Utility libraries. + implementation group: 'org.greenrobot', name: 'eventbus-java', version: '3.3.1' + // implementation group: 'org.danilopianini', name: 'java-quadtree', version: '0.1.9' + + // Long-term scheduler. + implementation group: 'org.quartz-scheduler', name: 'quartz', version: '2.3.2' + implementation group: 'org.quartz-scheduler', name: 'quartz-jobs', version: '2.3.2' + + // Lua script engine library. + implementation group: 'org.luaj', name: 'luaj-jse', version: '3.0.1' + + // Java HTTP server library. + implementation group: 'io.javalin', name: 'javalin', version: '4.6.4' + + // Google Protocol Buffer definitions. + // These are the raw '.proto' files. protobuf files('proto/') - compileOnly 'org.projectlombok:lombok:1.18.24' - annotationProcessor 'org.projectlombok:lombok:1.18.24' - testCompileOnly 'org.projectlombok:lombok:1.18.24' - testAnnotationProcessor 'org.projectlombok:lombok:1.18.24' + // Testing libraries. + testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.8.2' + testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-params', version: '5.8.2' + testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.8.2' + + // HTTP client library for testing. + testImplementation group: 'com.squareup.okhttp3', name: 'okhttp', version: '4.10.0' + + // Lombok. + compileOnly group: 'org.projectlombok', name: 'lombok', version: '1.18.26' + annotationProcessor group: 'org.projectlombok', name: 'lombok', version: '1.18.26' + testCompileOnly group: 'org.projectlombok', name: 'lombok', version: '1.18.26' + testAnnotationProcessor group: 'org.projectlombok', name: 'lombok', version: '1.18.26' } -configurations.all { +configurations.configureEach { exclude group: 'org.slf4j', module: 'slf4j' } @@ -129,7 +156,9 @@ jar { } from { - configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) } + configurations.runtimeClasspath.collect { + it.isDirectory() ? it : zipTree(it) + } } duplicatesStrategy = DuplicatesStrategy.INCLUDE @@ -138,7 +167,7 @@ jar { include '*.xml' } - destinationDirectory = file(".") + destinationDirectory = file('.') } publishing { @@ -154,6 +183,7 @@ publishing { fromResolutionResult() } } + pom { name = 'Grasscutter' description = 'A server software reimplementation for an anime game.' @@ -179,10 +209,15 @@ publishing { } } } + repositories { maven { if (version.endsWith('-dev')) { - println("Publishing to 4benj-maven") + // Check if the action being ran is 'publish'. + if (project.hasProperty('publish')) { + println('Publishing to Ben4J-Maven') + } + url 'https://repo.4benj.com/releases' name '4benj-maven' credentials { @@ -190,7 +225,11 @@ publishing { password System.getenv('benj_maven_token') } } else { - println("Publishing to sonatype") + // Check if the action being ran is 'publish'. + if (project.hasProperty('publish')) { + println('Publishing to Sonatype') + } + def releasesRepoUrl = 'https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/' def snapshotsRepoUrl = 'https://s01.oss.sonatype.org/content/repositories/snapshots/' url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl @@ -232,13 +271,14 @@ idea { // proto files and generated Java files are automatically added as // source dirs. // If you have additional sources, add them here: - sourceDirs += file("/proto/"); + sourceDirs += file('/proto/'); } } eclipse { classpath { - file.whenMerged { cp -> cp.entries.add(new org.gradle.plugins.ide.eclipse.model.SourceFolder('src/generated/main/java', null)) + file.whenMerged { + cp -> cp.entries.add(new SourceFolder('src/generated/main/java', null)) } } } @@ -254,39 +294,39 @@ javadoc { if (JavaVersion.current().isJava9Compatible()) { options.addBooleanOption('html5', true) } + // Add this to avoid warning caused by lack of comments in proto generated java files options.addStringOption('Xdoclint:none', '-quiet') exclude '**/*.md' } -task injectGitHash { +tasks.register('injectGitHash') { def gitCommitHash = { try { return 'git rev-parse --verify --short HEAD'.execute().text.trim() } catch (ignored) { - return "GIT_NOT_FOUND" + return 'GIT_NOT_FOUND' } } - new File(projectDir, "src/main/java/emu/grasscutter/BuildConfig.java").text = """package emu.grasscutter; + new File(projectDir, 'src/main/java/emu/grasscutter/BuildConfig.java').text = """package emu.grasscutter; public final class BuildConfig { public static final String VERSION = \"${version}\"; public static final String GIT_HASH = \"${gitCommitHash()}\"; }""" - } processResources { - dependsOn "generateProto" + dependsOn 'generateProto' } sourcesJar { - dependsOn "generateProto" + dependsOn 'generateProto' } delombok { - dependsOn "generateProto" + dependsOn 'generateProto' } // For terminal interacting in IDEA running