File sort

Author: ComputerDaddyGuy

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.2] - Unreleased
+
+### Added
+
+- Option: sorting files and directories
+
 ## [0.0.1] - 2025-09-14
 
 ### Added

README.md

@@ -7,6 +7,7 @@ A lightweight Java library for printing directory structures in a clean, tree-li
 - Limit displayed children (fixed value or dynamically)
 - Compact directory chains
 - Maximum depth
+- File sort
 
 > [!CAUTION]
 > This lib was developed just for fun, and has not been thoroughly tested!  
@@ -73,6 +74,7 @@ base/
 * [Children limit](#children-limit)
 * [Compact directories](#compact-directories)
 * [Max depth](#max-depth)
+* [Sorting](#sorting)
 
 ## Tree format
 Choose between different tree formats.
@@ -224,6 +226,31 @@ max_depth/
          └─ ... (max depth reached)
 ```
 
+## Sorting
+Files and directories can be sorted using a custom comparator (default is alphabetical order). Class `PrettyPrintOptions.Sorts` helps you by providing some basic comparators.
+
+```java
+// Example: Sorting.java
+var prettyPrinter = FileTreePrettyPrinter.builder()
+    .customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.ALPHABETICAL_ORDER.reversed()))
+    .build();
+```
+```
+file_sort/
+├─ dir_C/
+│  ├─ file_C_3
+│  ├─ file_C_2
+│  └─ file_C_1
+├─ dir_B/
+│  ├─ file_B_3
+│  ├─ file_B_2
+│  └─ file_B_1
+└─ dir_A/
+   ├─ file_A_3
+   ├─ file_A_2
+   └─ file_A_1
+```
+
 # Changelog
 See [CHANGELOG.md](CHANGELOG.md) for released versions.
 

ROADMAP.md

@@ -18,7 +18,7 @@
 - [ ] Directory children limitation function helper
 - [ ] More default emojis
 - [ ] Filtering
-- [ ] Ordering
+- [x] Ordering
 
 ## Other ideas
 - [ ] Custom tree format option

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

@@ -0,0 +1,16 @@
+package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
+
+import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.PrettyPrintOptions;
+
+public class Sorting {
+
+	public static void main(String[] args) {
+		var prettyPrinter = FileTreePrettyPrinter.builder()
+			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.ALPHABETICAL_ORDER.reversed()))
+			.build();
+		var tree = prettyPrinter.prettyPrint("src/example/resources/file_sort");
+		System.out.println(tree);
+	}
+
+}

src/example/resources/file_sort/dir_A/file_A_1

@@ -0,0 +1 @@
+small file

src/example/resources/file_sort/dir_A/file_A_2

@@ -0,0 +1 @@
+looooooongest file

src/example/resources/file_sort/dir_A/file_A_3

@@ -0,0 +1 @@
+medium file!

src/example/resources/file_sort/dir_B/file_B_1

@@ -0,0 +1 @@
+small file

src/example/resources/file_sort/dir_B/file_B_2

@@ -0,0 +1 @@
+looooooongest file

src/example/resources/file_sort/dir_B/file_B_3

@@ -0,0 +1 @@
+medium file!