Custom tree format option (#12)

Author: ComputerDaddyGuy

README.md

@@ -333,13 +333,13 @@ max_depth/
 ```
 
 ## Tree format
-Choose between different tree formats.
+Choose between different built-in tree formats, or create your own.
 The default is `UNICODE_BOX_DRAWING`, supported by all terminals, but you can also switch to use `CLASSIC_ASCII`.
 
 ```java
 // Example: FileTreeFormat.java
 var prettyPrinter = FileTreePrettyPrinter.builder()
-    .customizeOptions(options -> options.withTreeFormat(TreeFormat.CLASSIC_ASCII))
+    .customizeOptions(options -> options.withTreeFormat(TreeFormats.CLASSIC_ASCII))
     .build();
 ```
 
@@ -352,9 +352,6 @@ tree_format/
     `-- subFile_2
 ```
 
-> [!TIP]
-> *Idea for a future version: option to allow usage of custom format*
-
 # Project Information
 
 * See [🆕CHANGELOG.md](CHANGELOG.md) for a list of released versions and detailed changes.

ROADMAP.md

@@ -4,12 +4,11 @@
 - [x] **Features**
   - [x] Option: filtering
   - [x] Option: ordering
-  - [x] Option: emojis
-  - [x] Option: custom emojis mapping
+  - [x] Option: emojis (+ custom mapping)
   - [x] Option: compact directories display
   - [x] Option: line extension (=additional text after the file name)
   - [x] Option: children limit (static & dynamic)
-  - [x] Option: tree format Unicode box drawing / classic ASCII
+  - [x] Option: tree format (+ custom mapping)
   - [x] Option: max directory depth
 - [x] **Helpers**
   - [x] Path matchers
@@ -29,10 +28,11 @@
   - [x] SonarCloud integration
 - [x] **Workflows**
   - [x] Github actions
-  - [x] Publish on Maven Central!
+  - [x] Publish `0.0.x` alpha on Maven Central!
 
 ## To do
-- [ ] Option: custom tree format
+- [ ] Gather feedback
+- [ ] Publish `0.x.0` beta on Maven Central!
 
 ## Backlog / To analyze / To implement if requested
 - [ ] Rework/fix Github wiki to be up to date

assets/project-structure.png

@@ -1,8 +1,8 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
 
-import io.github.computerdaddyguy.jfiletreeprettyprinter.ChildLimits;
 import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PathMatchers;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.ChildLimits;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.PathMatchers;
 
 public class ChildLimitDynamic {
 

src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/ChildLimitDynamic.java

@@ -1,13 +1,13 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
 
 import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions.TreeFormat;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.TreeFormats;
 
 public class FileTreeFormat {
 
 	public static void main(String[] args) {
 		var prettyPrinter = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withTreeFormat(TreeFormat.CLASSIC_ASCII))
+			.customizeOptions(options -> options.withTreeFormat(TreeFormats.CLASSIC_ASCII))
 			.build();
 		var tree = prettyPrinter.prettyPrint("src/example/resources/tree_format");
 		System.out.println(tree);

src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/FileTreeFormat.java

@@ -1,7 +1,7 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
 
 import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PathMatchers;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.PathMatchers;
 
 public class Filtering {
 

src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/Filtering.java

@@ -1,8 +1,8 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
 
 import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.LineExtensions;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PathMatchers;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.LineExtensions;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.PathMatchers;
 import java.nio.file.Path;
 import java.util.function.Function;
 

src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/LineExtension.java

@@ -1,10 +1,10 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
 
-import io.github.computerdaddyguy.jfiletreeprettyprinter.ChildLimits;
 import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.LineExtensions;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PathMatchers;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PathSorts;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.ChildLimits;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.LineExtensions;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.PathMatchers;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.PathSorts;
 import java.nio.file.Path;
 import java.util.Comparator;
 import java.util.function.Function;
@@ -56,9 +56,10 @@ public static void main(String[] args) {
 		 */
 		var childLimitFunction = ChildLimits.builder()
 			// Hide all files under renderer and scanner packages
+			.add(PathMatchers.hasAbsolutePathMatchingGlob("**/io/github/computerdaddyguy/jfiletreeprettyprinter/options"), 0)
 			.add(PathMatchers.hasAbsolutePathMatchingGlob("**/io/github/computerdaddyguy/jfiletreeprettyprinter/renderer"), 0)
 			.add(PathMatchers.hasAbsolutePathMatchingGlob("**/io/github/computerdaddyguy/jfiletreeprettyprinter/scanner"), 0)
-			.add(PathMatchers.hasAbsolutePathMatchingGlob("**/io/github/computerdaddyguy/jfiletreeprettyprinter"), 3)
+			.add(PathMatchers.hasAbsolutePathMatchingGlob("**/io/github/computerdaddyguy/jfiletreeprettyprinter"), 4)
 			.build();
 
 		/*
@@ -113,22 +114,25 @@ public static void main(String[] args) {
 		│  └─ 🖼️ project-structure.png	// This image
 		├─ 📂 src/main/java/
 		│  └─ 📂 io/github/computerdaddyguy/jfiletreeprettyprinter/
+		│     ├─ 📂 options/
+		│     │  └─ ...
 		│     ├─ 📂 renderer/
 		│     │  └─ ...
 		│     ├─ 📂 scanner/
 		│     │  └─ ...
 		│     ├─ ☕ FileTreePrettyPrinter.java	// Main entry point
 		│     └─ ...
-		├─ 🗺️ CHANGELOG.md
-		├─ 📖 CONTRIBUTING.md
-		├─ 📄 LICENSE
-		├─ 📖 README.md		// You're reading at this!
+		├─ 🆕 CHANGELOG.md
+		├─ 🤝 CONTRIBUTING.md
+		├─ ⚖️ LICENSE
+		├─ 📘 README.md		// You're reading at this!
 		├─ 🗺️ ROADMAP.md
 		├─ 🛡️ SECURITY.md
-		├─ 🏗️ pom.xml
-		├─ 📖 release_process.md
+		├─ 🛠️ pom.xml
+		├─ 📝 release_process.md
 		└─ 📜 runMutationTests.sh
 		
+		
 		 */
 	}
 

src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/ProjectStructure.java

@@ -1,7 +1,7 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
 
 import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PathSorts;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.PathSorts;
 
 public class Sorting {
 

src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/Sorting.java

@@ -1,5 +1,6 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter;
 
+import io.github.computerdaddyguy.jfiletreeprettyprinter.options.PrettyPrintOptions;
 import java.io.UncheckedIOException;
 import java.nio.file.Path;
 import org.jspecify.annotations.NullMarked;