Introduce common modules to not include config classes in API modules

JorelAli · Sep 26, 2024 · 5c8b2cd · 5c8b2cd
1 parent 5742748
commit 5c8b2cd
Show file tree

Hide file tree

Showing 14 changed files with 145 additions and 20 deletions.
diff --git a/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-plugin-common/pom.xml b/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-plugin-common/pom.xml
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>dev.jorel</groupId>
+ <artifactId>commandapi-bukkit</artifactId>
+ <version>9.6.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>commandapi-bukkit-plugin-common</artifactId>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <configuration>
+ <compilerArgs>
+ <arg>-Xlint</arg>
+ </compilerArgs>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.jacoco</groupId>
+ <artifactId>jacoco-maven-plugin</artifactId>
+ <executions>
+ <!-- to avoid bugs in some situations -->
+ <execution>
+ <id>default-prepare-agent</id>
+ <goals>
+ <goal>prepare-agent</goal>
+ </goals>
+ </execution>
+ <!-- create report during maven verify phase -->
+ <execution>
+ <id>report</id>
+ <phase>verify</phase>
+ <goals>
+ <goal>report</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+ <repositories>
+ <repository>
+ <id>papermc-repo</id>
+ <url>https://repo.papermc.io/repository/maven-public/</url>
+ </repository>
+ <repository>
+ <id>sonatype</id>
+ <url>https://oss.sonatype.org/content/groups/public/</url>
+ </repository>
+ </repositories>
+
+ <dependencies>
+ <dependency>
+ <groupId>io.papermc.paper</groupId>
+ <artifactId>paper-api</artifactId>
+ <version>1.21.1-R0.1-SNAPSHOT</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>dev.jorel</groupId>
+ <artifactId>commandapi-plugin</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/...pi/config/BukkitConfigurationAdapter.java → ...pi/config/BukkitConfigurationAdapter.java b/...pi/config/BukkitConfigurationAdapter.java → ...pi/config/BukkitConfigurationAdapter.java
@@ -3,7 +3,6 @@
 import org.bukkit.configuration.ConfigurationSection;
 import org.bukkit.configuration.InvalidConfigurationException;
 import org.bukkit.configuration.file.YamlConfiguration;
-import org.jetbrains.annotations.ApiStatus;
 
 import java.io.File;
 import java.util.ArrayList;
@@ -14,7 +13,6 @@
 import java.util.Set;
 import java.util.logging.Logger;
 
-@ApiStatus.Internal
 public record BukkitConfigurationAdapter(YamlConfiguration config) implements ConfigurationAdapter<YamlConfiguration> {
 
  public static BukkitConfigurationAdapter createDummyInstance() {

diff --git a/...ommandapi/config/DefaultBukkitConfig.java → ...ommandapi/config/DefaultBukkitConfig.java b/...ommandapi/config/DefaultBukkitConfig.java → ...ommandapi/config/DefaultBukkitConfig.java
@@ -1,13 +1,10 @@
 package dev.jorel.commandapi.config;
 
-import org.jetbrains.annotations.ApiStatus;
-
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 
-@ApiStatus.Internal
 public class DefaultBukkitConfig extends DefaultConfig {
 
  public static final CommentedConfigOption<Boolean> USE_LATEST_NMS_VERSION = new CommentedConfigOption<>(

diff --git a/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-plugin-mojang-mapped/pom.xml b/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-plugin-mojang-mapped/pom.xml
@@ -85,6 +85,11 @@
  <version>${paper.version}</version>
  <scope>provided</scope>
  </dependency>
+ <dependency>
+ <groupId>dev.jorel</groupId>
+ <artifactId>commandapi-bukkit-plugin-common</artifactId>
+ <version>${project.version}</version>
+ </dependency>
  </dependencies>
 
  <build>

diff --git a/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-plugin/pom.xml b/commandapi-platforms/commandapi-bukkit/commandapi-bukkit-plugin/pom.xml
@@ -78,6 +78,11 @@
  <version>${paper.version}</version>
  <scope>provided</scope>
  </dependency>
+ <dependency>
+ <groupId>dev.jorel</groupId>
+ <artifactId>commandapi-bukkit-plugin-common</artifactId>
+ <version>${project.version}</version>
+ </dependency>
  </dependencies>
 
  <build>

diff --git a/commandapi-platforms/commandapi-bukkit/pom.xml b/commandapi-platforms/commandapi-bukkit/pom.xml
@@ -24,6 +24,9 @@
  <module>commandapi-bukkit-vh</module>
  <module>commandapi-bukkit-mojang-mapped</module>
 
+ <!-- Common Bukkit plugin classes -->
+ <module>commandapi-bukkit-plugin-common</module>
+
  <!-- Outputs -->
  <module>commandapi-bukkit-plugin</module>
  <module>commandapi-bukkit-shade</module>

diff --git a/commandapi-platforms/commandapi-velocity/commandapi-velocity-plugin/pom.xml b/commandapi-platforms/commandapi-velocity/commandapi-velocity-plugin/pom.xml
@@ -40,6 +40,11 @@
  <version>${project.version}</version>
  <scope>compile</scope>
  </dependency>
+ <dependency>
+ <groupId>dev.jorel</groupId>
+ <artifactId>commandapi-plugin</artifactId>
+ <version>${project.version}</version>
+ </dependency>
  </dependencies>
 
  <build>

diff --git a/commandapi-plugin/pom.xml b/commandapi-plugin/pom.xml
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>dev.jorel</groupId>
+ <artifactId>commandapi</artifactId>
+ <version>9.6.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>commandapi-plugin</artifactId>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <configuration>
+ <compilerArgs>
+ <arg>-Xlint</arg>
+ </compilerArgs>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.jacoco</groupId>
+ <artifactId>jacoco-maven-plugin</artifactId>
+ <executions>
+ <!-- to avoid bugs in some situations -->
+ <execution>
+ <id>default-prepare-agent</id>
+ <goals>
+ <goal>prepare-agent</goal>
+ </goals>
+ </execution>
+ <!-- create report during maven verify phase -->
+ <execution>
+ <id>report</id>
+ <phase>verify</phase>
+ <goals>
+ <goal>report</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
diff --git a/...mandapi/config/CommentedConfigOption.java → ...mandapi/config/CommentedConfigOption.java b/...mandapi/config/CommentedConfigOption.java → ...mandapi/config/CommentedConfigOption.java
@@ -1,7 +1,4 @@
 package dev.jorel.commandapi.config;
 
-import org.jetbrains.annotations.ApiStatus;
-
-@ApiStatus.Internal
 public record CommentedConfigOption<T>(String[] comment, T option) {
 }
diff --git a/...l/commandapi/config/CommentedSection.java → ...l/commandapi/config/CommentedSection.java b/...l/commandapi/config/CommentedSection.java → ...l/commandapi/config/CommentedSection.java
@@ -1,7 +1,4 @@
 package dev.jorel.commandapi.config;
 
-import org.jetbrains.annotations.ApiStatus;
-
-@ApiStatus.Internal
 public record CommentedSection(String[] comment) {
 }
diff --git a/...el/commandapi/config/ConfigGenerator.java → ...el/commandapi/config/ConfigGenerator.java b/...el/commandapi/config/ConfigGenerator.java → ...el/commandapi/config/ConfigGenerator.java
@@ -1,12 +1,9 @@
 package dev.jorel.commandapi.config;
 
-import org.jetbrains.annotations.ApiStatus;
-
 import java.util.Arrays;
 import java.util.Map;
 import java.util.Set;
 
-@ApiStatus.Internal
 public class ConfigGenerator {
 
  private final DefaultConfig defaultConfig;

diff --git a/...mmandapi/config/ConfigurationAdapter.java → ...mmandapi/config/ConfigurationAdapter.java b/...mmandapi/config/ConfigurationAdapter.java → ...mmandapi/config/ConfigurationAdapter.java
@@ -1,12 +1,9 @@
 package dev.jorel.commandapi.config;
 
-import org.jetbrains.annotations.ApiStatus;
-
 import java.io.File;
 import java.util.Set;
 import java.util.logging.Logger;
 
-@ApiStatus.Internal
 public interface ConfigurationAdapter<Configuration> {
 
  void setValue(String key, Object value);

diff --git a/...orel/commandapi/config/DefaultConfig.java → ...orel/commandapi/config/DefaultConfig.java b/...orel/commandapi/config/DefaultConfig.java → ...orel/commandapi/config/DefaultConfig.java
@@ -1,11 +1,8 @@
 package dev.jorel.commandapi.config;
 
-import org.jetbrains.annotations.ApiStatus;
-
 import java.util.LinkedHashMap;
 import java.util.Map;
 
-@ApiStatus.Internal
 public abstract class DefaultConfig {
 
  protected final Map<String, CommentedConfigOption<?>> allOptions = new LinkedHashMap<>();

diff --git a/pom.xml b/pom.xml
@@ -61,6 +61,9 @@
  <!-- Main core code -->
  <module>commandapi-core</module>
 
+ <!-- Plugin core code -->
+ <module>commandapi-plugin</module>
+
  <!-- Platform implementations (includes documentation code) -->
  <module>commandapi-platforms</module>
  <module>commandapi-kotlin</module>