Add defaultLineFeed option (#34)

- Add build.gradle option defaultLineFeed
- Renamed `SocketLock` to `PortLock` to match documentation
- Removed excessive javadoc warnings from console when publishing
- Removed Triple class
- Lots of renames
- More documentation
- Fix workflow
- Renamed package `extension` to `config`

Author: ScribbleTAS

.github/workflows/publish-main.yml

@@ -22,4 +22,4 @@ jobs:
       with:
         gradle-version: 8.13
     - name: Publish
-      run: gradle publishAllPublicationsToMinecrafttasMainRepository -PminecrafttasMainUsername=${{ secrets.MAVEN_NAME }} -PminecrafttasMainPassword=${{ secrets.MAVEN_SECRET }}
+      run: gradle publishAllPublicationsToMinecrafttasMainRepository -Prelease=true -PminecrafttasMainUsername=${{ secrets.MAVEN_NAME }} -PminecrafttasMainPassword=${{ secrets.MAVEN_SECRET }}

Test/Test1.12.2/build.gradle

@@ -15,4 +15,4 @@ dependencies {
 	minecraft "com.mojang:minecraft:1.12.2"
 	mappings "net.legacyfabric:yarn:1.12.2+build.mcp"
 	modImplementation "net.fabricmc:fabric-loader:0.16.9"
-}
+}

Test/build.gradle

@@ -10,5 +10,7 @@ discombobulator {
 
 	ignoredFileFormats = ["*.png"]
 
+	defaultLineFeed = "\n"
+	
 	disableAnsi = false
-}
+}

build.gradle

@@ -7,6 +7,8 @@ plugins {
 // Change java compatibility level to 23
 sourceCompatibility = targetCompatibility = 23
 
+def snapshot = project.release ? "" : "-SNAPSHOT"
+version = project.version+snapshot
 // Name, version and group for the project
 version = "1.3"
 group = "com.minecrafttas"
@@ -46,12 +48,16 @@ java {
 
 javadoc {
 	options.locale = "en_US"
+	options.addBooleanOption('Xdoclint:none', true)
+}
+
+publishToMavenLocal {
+	version = version + "-SNAPSHOT"
 }
 
 publishing {
 	repositories {
 		maven {
-			version = version + "-SNAPSHOT"
 			name = "minecrafttasSnapshots"
 			url = "https://maven.minecrafttas.com/snapshots"
 			credentials(PasswordCredentials)

gradle.properties

@@ -0,0 +1,2 @@
+version=1.3
+release=false

src/main/java/com/minecrafttas/discombobulator/Discombobulator.java

@@ -26,7 +26,7 @@
 import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.artifacts.ModuleVersionIdentifier;
 
-import com.minecrafttas.discombobulator.extensions.PreprocessingConfiguration;
+import com.minecrafttas.discombobulator.config.PreprocessingConfiguration;
 import com.minecrafttas.discombobulator.processor.FilePreprocessor;
 import com.minecrafttas.discombobulator.processor.LinePreprocessor;
 import com.minecrafttas.discombobulator.tasks.TaskCollectBuilds;
@@ -40,16 +40,21 @@
 /**
  * Gradle plugin main class
  * 
- * @author Pancake
+ * @author Pancake, Scribble
  */
 public class Discombobulator implements Plugin<Project> {
 
+	/**
+	 * Which port to lock
+	 */
 	public static int PORT_LOCK = 8762;
 
 	public static PreprocessingConfiguration config;
 
 	public static boolean DISABLE_ANSI = false;
 
+	public static String DEFAULT_LINE_FEED = System.lineSeparator();
+
 	public static FilePreprocessor fileProcessor;
 
 	public static PathLock pathLock;
@@ -98,6 +103,7 @@ public void apply(Project project) {
 			boolean inverted = config.getInverted().getOrElse(false);
 			PORT_LOCK = config.getPort().getOrElse(8762);
 			DISABLE_ANSI = config.getDisableAnsi().getOrElse(false);
+			DEFAULT_LINE_FEED = config.getDefaultLineFeed().getOrElse(System.lineSeparator());
 
 			Map<String, Path> versionPairs = null;
 			Path projectDir = _project.getProjectDir().toPath();
@@ -157,11 +163,26 @@ public static LinkedHashMap<String, Path> getVersionPairs(Path baseProjectDir) t
 		return versions;
 	}
 
+	/**
+	 * Centers any given text
+	 * @param text The text to print
+	 * @return The centered text
+	 */
 	private static String getCenterText(String text) {
 		int length = text.length();
 		return getCenterText(text, length);
 	}
 
+	/**
+	 * Centers any given text
+	 * 
+	 * This method is used if ANSI colors are in the text which are not rendered,<br>
+	 * but are still counted in String.length();
+	 * 
+	 * @param text The text to print
+	 * @param length The length of the text
+	 * @return The centered text
+	 */
 	private static String getCenterText(String text, int length) {
 		int total = 31;
 		if (length % 2 == 0) {
@@ -170,14 +191,26 @@ private static String getCenterText(String text, int length) {
 		return String.format("%s%s", " ".repeat(total - length / 2), text);
 	}
 
-	public static void printError(String line) {
-		System.err.println(Colors.RED + line + Colors.WHITE);
+	/**
+	 * Prints an error in red to the console
+	 * @param msg The error message to print
+	 */
+	public static void printError(String msg) {
+		System.err.println(Colors.RED + msg + Colors.WHITE);
 	}
 
-	public static void printError(String line, String filename) {
-		printError(String.format("[%s] %s", filename, line));
+	/**
+	 * Print an error to the console in red together with the file where this error occured in
+	 * @param msg The error message to print
+	 * @param filename The filename of the file where this error occured
+	 */
+	public static void printError(String msg, String filename) {
+		printError(String.format("[%s] %s", filename, msg));
 	}
 
+	/**
+	 * @return The splash with ANSI colors
+	 */
 	private static String getColoredSplash() {
 		return " (\n"
 				+ " )\\ )                         )         )      (         )\n"
@@ -189,6 +222,9 @@ private static String getColoredSplash() {
 				+ " |___/|_/__|__\\___/_|_|_| |_.__/\\___/_.__/\\_,_|_\\__,_|\\__\\___/_|\n";
 	}
 
+	/**
+	 * @return The splash without ANSI colors
+	 */
 	private static String getColorLessSplash() {
 		return " (                                                                 \n"
 				+ " )\\ )                         )         )      (         )         \n"

src/main/java/com/minecrafttas/discombobulator/config/PreprocessingConfiguration.java

@@ -0,0 +1,128 @@
+package com.minecrafttas.discombobulator.config;
+
+import java.util.Map;
+
+import org.gradle.api.provider.ListProperty;
+import org.gradle.api.provider.MapProperty;
+import org.gradle.api.provider.Property;
+
+import com.minecrafttas.discombobulator.utils.PortLock;
+
+/**
+ * Configuration for preprocessing
+ * @author Pancake
+ */
+public abstract class PreprocessingConfiguration {
+
+	/**
+	 * All versions for the project
+	 * <pre>
+	 * versions = [
+	 * 	"1.14.4":"",
+	 * 	"1.12.2":"",
+	 * 	"1.8.9": "AlternateFolderName1.8.9"
+	 * ]
+	 * </pre>
+	 * 
+	 * <p>A subproject will be created, only if a version is present in the list. 
+	 * 
+	 * <p>Defaults to []
+	 * @return Ordered list of versions
+	 */
+	public abstract MapProperty<String, String> getVersions();
+
+	/**
+	 * All patterns for the project.
+	 * <pre>
+	 * patterns = [
+	 * 	GetMinecraft: [
+	 * 		"1.14.4": "Minecraft.getMinecraft().getPlayer()",
+	 *		"1.12.2": "Minecraft.getMinecraft().player",
+	 *		"def": "Minecraft.getMinecraft().thePlayer"
+	 * 	]
+	 * ]
+	 * </pre>
+	 * <p>Anything annotated by @key will be adjusted according to the version where "1.14.4" would refer to any version above or equal to 1.14.4<br>
+	 * {@code Minecraft.getMinecraft().getPlayer(); // @GetMinecraft} would be adjusted to {@code Minecraft.getMinecraft().thePlayer} in versions below 1.12.2
+	 * 
+	 * <p>Defaults to []
+	 * 
+	 * @return Map of patterns
+	 */
+	public abstract MapProperty<String, Map<String, String>> getPatterns();
+
+	/**
+	 * <p>If the default version should be inverted
+	 * 
+	 * <p>This makes it, so the highest version is considered the default version
+	 * <pre>
+	 * versions = [
+	 *	"1.12.2":"", &lt;- Default version if inverted is true
+	 *	"1.11.2":"",
+	 *	"1.10.2":"",
+	 *	"1.9.4":"",
+	 *	"1.8.9": "" &lt;- Default version if inverted is false
+	 * ]
+	 * </pre>
+	 * 
+	 * <pre>
+	 * inverted = false
+	 * </pre>
+	 * 
+	 * <p>Defaults to false
+	 * 
+	 * @return True if inverted
+	 */
+	public abstract Property<Boolean> getInverted();
+
+	/**
+	 * If true, disables ANSI colors
+	 * 
+	 * <pre>
+	 * 	disableAnsi = false
+	 * </pre>
+	 *
+	 * <p>Defaults to false
+	 * 
+	 * @return True if disabled
+	 */
+	public abstract Property<Boolean> getDisableAnsi();
+
+	/**
+	 * The port for the {@link PortLock}
+	 * 
+	 * <pre>
+	 * 	port = 8762
+	 * </pre>
+	 * 
+	 * <p>Defaults to 8762
+	 * 
+	 * @return The port number
+	 */
+	public abstract Property<Integer> getPort();
+
+	/**
+	 * <p>Filetypes which should be ignored by the preprocessor and just copied.<br>
+	 * Usually binary file formats should be excluded in this list
+	 * 
+	 * <pre>
+	 * 	ignoredFileFormats = ["*.png"]
+	 * </pre>
+	 *  
+	 * <p>Defaults to []	
+	 * @return A string array of file filter wildcards
+	 */
+	public abstract ListProperty<String> getIgnoredFileFormats();
+
+	/**
+	 * <p>Set's the default line feed character
+	 * 
+	 * <p>If this option is not set, the {@link System#lineSeparator()} is used instead.
+	 * <p>This option can also be overwritten by the system property "line.seperator"
+	 * <pre>
+	 * 	defaultLineFeed = "\n"
+	 * </pre>
+	 * @return The line feed string
+	 */
+	public abstract Property<String> getDefaultLineFeed();
+}