Feature/custom emojis option (#11)

Author: ComputerDaddyGuy

CHANGELOG.md

@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ---
 ## [0.0.6] - Unreleased
 
+### Added
+- Emojis: option to use custom mapping
+
 ### Changed
 - Child limit: do not print skipped children count
 - Max depth: do not print "max depth reached"

README.md

@@ -167,13 +167,13 @@ sorting/
 ```
 
 ## Emojis ❤️
-If your terminal supports them, you can choose to use emojis.
+You can choose to use default built-in emojis, or define your own emoji mapping.
 Folders use the 📂 emoji, and files will have an emoji depending on their extension (when applicable).
 
 ```java
 // Example: Emojis.java
 var prettyPrinter = FileTreePrettyPrinter.builder()
-    .customizeOptions(options -> options.withEmojis(true))
+    .customizeOptions(options -> options.withDefaultEmojis()) // or withEmojis(EmojiMapping) for custom mapping
     .build();
 ```
 
@@ -194,9 +194,6 @@ var prettyPrinter = FileTreePrettyPrinter.builder()
 └─ 🎬 file.avi
 ```
 
-> [!TIP]
-> *Idea for a future version: option to allow custom emoji mapping*
-
 ## Child limit
 You can set a fixed limit to the number of children displayed for each directory. Each directory and file that pass the filter (if set) counts for one.
 

ROADMAP.md

@@ -5,6 +5,7 @@
   - [x] Option: filtering
   - [x] Option: ordering
   - [x] Option: emojis
+  - [x] Option: custom emojis mapping
   - [x] Option: compact directories display
   - [x] Option: line extension (=additional text after the file name)
   - [x] Option: children limit (static & dynamic)
@@ -31,8 +32,6 @@
   - [x] Publish on Maven Central!
 
 ## To do
-- [ ] Option: hide number of skipped files and folders for child limit
-- [ ] Option: custom emojis
 - [ ] Option: custom tree format
 
 ## Backlog / To analyze / To implement if requested

assets/project-structure.png

@@ -6,7 +6,7 @@ public class Emojis {
 
 	public static void main(String[] args) {
 		var prettyPrinter = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withEmojis(true))
+			.customizeOptions(options -> options.withDefaultEmojis()) // or withEmojis(EmojiMapping) for custom mapping
 			.build();
 		var tree = prettyPrinter.prettyPrint("src/example/resources/emojis");
 		System.out.println(tree);

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

@@ -87,7 +87,7 @@ public static void main(String[] args) {
 		var prettyPrinter = FileTreePrettyPrinter.builder()
 			.customizeOptions(
 				options -> options
-					.withEmojis(true) // Use emojis!
+					.withDefaultEmojis() // Use emojis!
 					.withCompactDirectories(true) // Inline directory chains: "src/main/java/..."
 					.filterDirectories(dirFilter)
 					.filterFiles(fileFilter)