refactor(all): 修改项目结构，为BungeeYAML支持注释。

项目结构修改，避免使用上的误解。同时为 Bungee(YAML) 支持了注释功能。 BREAKING CHANGE: 包名与入口类变更 1. 项目结构与包名修改 mineconfiguration-bukkit-general -> mineconfiguration-bukkit mineconfiguration-bukkit-native -> mineconfiguration-spigot 2. MineConfiguration入口类变更，现移动到各自平台的包下。
2026-06-04 21:58:16 +08:00 · 2022-06-09 00:18:14 +08:00
parent 616d24d885
commit f826014c09
16 changed files with 345 additions and 160 deletions
@@ -0,0 +1,65 @@
+<?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">
+    <parent>
+        <groupId>cc.carm.lib</groupId>
+        <artifactId>mineconfiguration-parent</artifactId>
+        <version>2.0.0</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <properties>
+        <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
+        <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
+    </properties>
+
+    <artifactId>mineconfiguration-spigot</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>${project.parent.groupId}</groupId>
+            <artifactId>mineconfiguration-bukkit-base</artifactId>
+            <version>${project.parent.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.spigotmc</groupId>
+            <artifactId>spigot-api</artifactId>
+            <version>1.18.2-R0.1-SNAPSHOT</version>
+            <scope>provided</scope>
+        </dependency>
+
+
+        <!--PlaceholderAPI for general placeholder's support-->
+        <dependency>
+            <groupId>me.clip</groupId>
+            <artifactId>placeholderapi</artifactId>
+            <version>2.11.1</version>
+            <scope>provided</scope>
+        </dependency>
+
+        <!--ProtocolLib for general packet's function support-->
+        <dependency>
+            <groupId>com.comphenix.protocol</groupId>
+            <artifactId>ProtocolLib</artifactId>
+            <version>4.8.0</version>
+            <scope>provided</scope>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
+
+</project>
@@ -0,0 +1,42 @@
+package cc.carm.lib.mineconfiguration.spigot;
+
+import cc.carm.lib.mineconfiguration.spigot.source.SpigotConfigProvider;
+import org.bukkit.plugin.Plugin;
+
+import java.io.File;
+import java.io.IOException;
+
+public class MineConfiguration {
+
+    public static SpigotConfigProvider from(File file, String source) {
+        SpigotConfigProvider provider = new SpigotConfigProvider(file);
+        try {
+            provider.initializeFile(source);
+            provider.initializeConfig();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+        return provider;
+    }
+
+    public static SpigotConfigProvider from(File file) {
+        return from(file, file.getName());
+    }
+
+    public static SpigotConfigProvider from(String fileName) {
+        return from(fileName, fileName);
+    }
+
+    public static SpigotConfigProvider from(String fileName, String source) {
+        return from(new File(fileName), source);
+    }
+
+    public static SpigotConfigProvider from(Plugin plugin, String fileName) {
+        return from(plugin, fileName, fileName);
+    }
+
+    public static SpigotConfigProvider from(Plugin plugin, String fileName, String source) {
+        return from(new File(plugin.getDataFolder(), fileName), source);
+    }
+
+}
@@ -0,0 +1,54 @@
+package cc.carm.lib.mineconfiguration.spigot.source;
+
+import cc.carm.lib.configuration.core.ConfigInitializer;
+import cc.carm.lib.mineconfiguration.bukkit.source.CraftConfigProvider;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.Unmodifiable;
+
+import java.io.File;
+import java.util.Collections;
+import java.util.List;
+
+public class SpigotConfigProvider extends CraftConfigProvider {
+
+    public SpigotConfigProvider(@NotNull File file) {
+        super(file);
+    }
+
+    @Override
+    public void initializeConfig() {
+        this.configuration = YamlConfiguration.loadConfiguration(file);
+        this.initializer = new ConfigInitializer<>(this);
+    }
+
+    @Override
+    public void setHeaderComment(@Nullable String path, @Nullable List<String> comments) {
+        if (path == null) {
+            this.configuration.options().setHeader(comments);
+        } else {
+            this.configuration.setComments(path, comments);
+        }
+    }
+
+    @Override
+    public void setInlineComment(@NotNull String path, @Nullable String comment) {
+        if (comment == null) {
+            this.configuration.setInlineComments(path, null);
+        } else {
+            this.configuration.setComments(path, Collections.singletonList(comment));
+        }
+    }
+
+    @Override
+    public @Nullable @Unmodifiable List<String> getHeaderComment(@Nullable String path) {
+        if (path == null) return Collections.unmodifiableList(this.configuration.options().getHeader());
+        else return this.configuration.getComments(path);
+    }
+
+    @Override
+    public @Nullable String getInlineComment(@NotNull String path) {
+        return String.join(" ", this.configuration.getInlineComments(path));
+    }
+}