Initial commit

Auxilor · Dec 31, 2020 · 2265e10 · 2265e10
commit 2265e10
Show file tree

Hide file tree

Showing 100 changed files with 6,454 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,23 @@
+# Java
+*.class
+
+# Eclipse IDE
+.settings/
+bin/
+.classpath
+.project
+
+# IntelliJ IDEA
+.idea/
+*.iml
+
+# Gradle
+.gradle
+**/build/
+!src/**/build/
+.gradletasknamecache
+!gradle-wrapper.jar
+gradle-app.setting
+
+# Mac OSX
+.DS_Store
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# How to contribute to eco
+
+## Codestyle
+1. The eco checkstyle is in /config/checkstyle.xml
+- The pull request must not have any checkstyle issues.
+- Every method and field must have a javadoc attached.
+
+2. Use lombok wherever possible.
+- @Getter, @Setter, @ToString, @EqualsAndHashCode, @UtilityClass are the most important.
+
+3. Use JetBrains annotations
+- Every parameter should be annotated with @NotNull or @Nullable
+- Use @NotNull over lombok @NonNull
+
+4. Imports
+- No group (*) imports.
+- No static imports.
+
+## Dependency Injection
+- eco uses Dependency Injection
+- Any calls to AbstractEcoPlugin#getInstance are code smells and should never be used unless **absolutely necessary**.
+- NamespacedKeys, FixedMetadataValues, Runnables, and Schedules should be managed using AbstractEcoPlugin through DI.
+- Any DI class should extend PluginDependent where possible. If the class extends another, then you **must** store the plugin instance in a private final variable called **plugin** with a private or protected getter.
+
+## Other
+- All drops **must** be sent through a DropQueue - calls to World#dropItem will get your PR rejected.
+- eco is built with java 8. Usage of J9+ will get your PR rejected.
diff --git a/README.md b/README.md
@@ -0,0 +1,8 @@
+
+<h4 align="center">Source code for eco, a spigot development library.</h4>
+
+<p align="center">
+    <a href="https://discord.gg/ZcwpSsE/" alt="Discord">
+        <img src="https://img.shields.io/discord/452518336627081236?label=discord&style=for-the-badge"/>
+    </a>
+</p>
diff --git a/build.gradle b/build.gradle
@@ -0,0 +1,102 @@
+plugins {
+    id 'java-library'
+    id 'com.github.johnrengelman.shadow' version '5.2.0'
+    id 'maven-publish'
+    id 'java'
+}
+
+dependencies {
+    implementation 'org.apache.maven:maven-artifact:3.0.3'
+    implementation 'org.bstats:bstats-bukkit:1.7'
+    compileOnly 'org.spigotmc:spigot-api:1.16.4-R0.1-SNAPSHOT'
+    compileOnly 'me.clip:placeholderapi:2.10.9'
+    compileOnly 'com.comphenix.protocol:ProtocolLib:4.6.0-SNAPSHOT'
+    compileOnly 'com.sk89q.worldguard:worldguard-bukkit:7.0.4-SNAPSHOT'
+    compileOnly 'com.github.TechFortress:GriefPrevention:16.14.0'
+    compileOnly 'com.massivecraft:Factions:1.6.9.5-U0.5.10'
+    compileOnly 'com.github.cryptomorin:kingdoms:1.10.3.1'
+    compileOnly 'com.github.TownyAdvanced:Towny:0.96.2.0'
+    compileOnly 'com.github.angeschossen:LandsAPI:4.7.3'
+    compileOnly 'fr.neatmonster:nocheatplus:3.16.1-SNAPSHOT'
+    compileOnly 'com.github.jiangdashao:matrix-api-repo:317d4635fd'
+    compileOnly 'org.jetbrains:annotations:19.0.0'
+    compileOnly fileTree(dir: '/lib', include: ['*.jar'])
+
+    // Lombok
+    compileOnly 'org.projectlombok:lombok:1.18.16'
+    annotationProcessor 'org.projectlombok:lombok:1.18.16'
+    testCompileOnly 'org.projectlombok:lombok:1.18.16'
+    testAnnotationProcessor 'org.projectlombok:lombok:1.18.16'
+}
+
+
+repositories {
+    mavenCentral()
+    jcenter()
+    mavenLocal()
+    maven { url 'https://jitpack.io' }
+
+    // NMS (for jitpack compilation)
+    maven { url 'https://repo.codemc.org/repository/nms/' }
+
+    // bStats
+    maven { url 'https://repo.codemc.org/repository/maven-public' }
+
+    // Spigot API
+    maven { url 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/' }
+
+    // PlaceholderAPI
+    maven { url 'https://repo.extendedclip.com/content/repositories/placeholderapi/' }
+
+    // ProtocolLib
+    maven { url 'https://repo.dmulloy2.net/nexus/repository/public/' }
+
+    // WorldGuard
+    maven { url 'https://maven.enginehub.org/repo/' }
+
+    // FactionsUUID
+    maven { url 'https://ci.ender.zone/plugin/repository/everything/' }
+
+    // NoCheatPlus
+    maven { url 'https://repo.md-5.net/content/repositories/snapshots/' }
+}
+
+tasks.withType(JavaCompile) {
+    options.deprecation = true
+    options.encoding = 'UTF-8'
+}
+
+configurations.all {
+    exclude group: "org.codehaus.plexus", module: "plexus-utils"
+    exclude group: "com.mojang", module: "brigadier"
+    exclude group: "org.kitteh", module: "paste-gg-api"
+    exclude group: "org.spongepowered", module: "configurate-hocon"
+    exclude group: "com.darkblade12", module: "particleeffect"
+}
+
+shadowJar {
+    relocate('org.bstats.bukkit', 'com.willfp.eco.util.shaded.bstats')
+    relocate('org.apache.maven', 'com.willfp.eco.util.shaded.maven')
+}
+
+publishing {
+    publications {
+        shadow(MavenPublication) {
+            from components.java
+            artifact shadowJar
+        }
+    }
+}
+
+compileJava.options.encoding = 'UTF-8'
+compileJava.dependsOn clean
+
+publishToMavenLocal.dependsOn shadowJar
+
+build.dependsOn shadowJar
+build.dependsOn publishToMavenLocal
+
+group = 'com.willfp'
+archivesBaseName = project.name
+version = '1.0.0'
+java.sourceCompatibility = JavaVersion.VERSION_1_8
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -0,0 +1,184 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<!--
+
+  Checkstyle configuration that checks the sun coding conventions from:
+
+    - the Java Language Specification at
+      https://docs.oracle.com/javase/specs/jls/se11/html/index.html
+
+    - the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
+
+    - the Javadoc guidelines at
+      https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
+
+    - the JDK Api documentation https://docs.oracle.com/en/java/javase/11/
+
+    - some best practices
+
+  Checkstyle is very configurable. Be sure to read the documentation at
+  https://checkstyle.org (or in your downloaded distribution).
+
+  Most Checks are configurable, be sure to consult the documentation.
+
+  To completely disable a check, just comment it out or delete it from the file.
+  To suppress certain violations please review suppression filters.
+
+  Finally, it is worth reading the documentation.
+
+-->
+
+<module name="Checker">
+    <module name="SuppressionFilter">
+        <property name="file" value="config/checkstyle/suppression.xml"/>
+    </module>
+
+    <!--
+        If you set the basedir property below, then all reported file
+        names will be relative to the specified directory. See
+        https://checkstyle.org/config.html#Checker
+
+        <property name="basedir" value="${basedir}"/>
+    -->
+    <property name="severity" value="error"/>
+
+    <property name="fileExtensions" value="java, properties, xml"/>
+
+    <!-- Excludes all 'module-info.java' files              -->
+    <!-- See https://checkstyle.org/config_filefilters.html -->
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value="module\-info\.java$"/>
+    </module>
+
+    <!-- Checks whether files end with a new line.                        -->
+    <!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
+    <module name="NewlineAtEndOfFile"/>
+
+    <!-- Checks that property files contain the same keys.         -->
+    <!-- See https://checkstyle.org/config_misc.html#Translation -->
+    <module name="Translation"/>
+
+    <!-- Checks for Size Violations.                    -->
+    <!-- See https://checkstyle.org/config_sizes.html -->
+    <module name="FileLength"/>
+    <module name="LineLength">
+        <property name="fileExtensions" value="java"/>
+        <property name="max" value="200"/>
+    </module>
+
+    <!-- Checks for whitespace                               -->
+    <!-- See https://checkstyle.org/config_whitespace.html -->
+    <module name="FileTabCharacter"/>
+
+    <!-- Miscellaneous other checks.                   -->
+    <!-- See https://checkstyle.org/config_misc.html -->
+    <module name="RegexpSingleline">
+        <property name="format" value="\s+$"/>
+        <property name="minimum" value="0"/>
+        <property name="maximum" value="0"/>
+        <property name="message" value="Line has trailing spaces."/>
+    </module>
+
+    <!-- Checks for Headers                                -->
+    <!-- See https://checkstyle.org/config_header.html   -->
+    <!-- <module name="Header"> -->
+    <!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
+    <!--   <property name="fileExtensions" value="java"/> -->
+    <!-- </module> -->
+
+    <module name="TreeWalker">
+
+        <!-- Checks for Javadoc comments. -->
+        <!-- See https://checkstyle.org/config_javadoc.html -->
+        <module name="InvalidJavadocPosition"/>
+        <module name="JavadocMethod"/>
+        <module name="JavadocType"/>
+        <module name="JavadocVariable"/>
+        <module name="JavadocStyle"/>
+        <module name="MissingJavadocMethod"/>
+
+        <!-- Checks for Naming Conventions.                  -->
+        <!-- See https://checkstyle.org/config_naming.html -->
+        <module name="ConstantName"/>
+        <module name="LocalFinalVariableName"/>
+        <module name="LocalVariableName"/>
+        <module name="MemberName"/>
+        <module name="MethodName"/>
+        <module name="PackageName"/>
+        <module name="ParameterName"/>
+        <module name="StaticVariableName"/>
+        <module name="TypeName"/>
+
+        <!-- Checks for imports                              -->
+        <!-- See https://checkstyle.org/config_imports.html -->
+        <module name="AvoidStarImport"/>
+        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
+        <module name="RedundantImport"/>
+        <module name="UnusedImports">
+            <property name="processJavadoc" value="true"/>
+        </module>
+
+        <!-- Checks for Size Violations.                    -->
+        <!-- See https://checkstyle.org/config_sizes.html -->
+        <!-- <module name="MethodLength"/> -->
+        <module name="ParameterNumber"/>
+
+        <!-- Checks for whitespace                               -->
+        <!-- See https://checkstyle.org/config_whitespace.html -->
+        <module name="EmptyForIteratorPad"/>
+        <module name="GenericWhitespace"/>
+        <module name="MethodParamPad"/>
+        <module name="NoWhitespaceAfter"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="OperatorWrap"/>
+        <module name="ParenPad"/>
+        <module name="TypecastParenPad"/>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround"/>
+
+        <!-- Modifier Checks                                    -->
+        <!-- See https://checkstyle.org/config_modifiers.html -->
+        <module name="ModifierOrder"/>
+        <module name="RedundantModifier"/>
+
+        <!-- Checks for blocks. You know, those {}'s         -->
+        <!-- See https://checkstyle.org/config_blocks.html -->
+        <module name="AvoidNestedBlocks"/>
+        <module name="EmptyBlock"/>
+        <module name="LeftCurly"/>
+        <module name="NeedBraces"/>
+        <module name="RightCurly"/>
+
+        <!-- Checks for common coding problems               -->
+        <!-- See https://checkstyle.org/config_coding.html -->
+        <module name="EmptyStatement"/>
+        <module name="EqualsHashCode"/>
+        <module name="IllegalInstantiation"/>
+        <module name="InnerAssignment"/>
+        <!-- <module name="MagicNumber"/> -->
+        <module name="MissingSwitchDefault"/>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+
+        <!-- Checks for class design                         -->
+        <!-- See https://checkstyle.org/config_design.html -->
+        <!-- <module name="DesignForExtension"/> -->
+        <module name="FinalClass"/>
+        <!-- <module name="HideUtilityClassConstructor"/> -->
+        <module name="InterfaceIsType"/>
+        <module name="VisibilityModifier"/>
+        <module name="RequireThis"/>
+
+        <!-- Miscellaneous other checks.                   -->
+        <!-- See https://checkstyle.org/config_misc.html -->
+        <module name="ArrayTypeStyle"/>
+        <module name="FinalParameters"/>
+        <module name="TodoComment"/>
+        <module name="UpperEll"/>
+
+    </module>
+</module>
diff --git a/config/checkstyle/suppression.xml b/config/checkstyle/suppression.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
+        "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+
+<suppressions>
+    <!-- Modified version of library -->
+    <suppress files="ArmorEquipEvent.java" checks="JavadocVariable"/>
+    <suppress files="ArmorEquipEvent.java" checks="MissingJavadocMethod"/>
+    <suppress files="ArmorEquipEvent.java" checks="JavadocStyle"/>
+    <suppress files="ArmorListener.java" checks="JavadocVariable"/>
+    <suppress files="ArmorListener.java" checks="MissingJavadocMethod"/>
+    <suppress files="ArmorType.java" checks="JavadocVariable"/>
+    <suppress files="ArmorType.java" checks="MissingJavadocMethod"/>
+</suppressions>
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists