Cleanup sorting

Author: ComputerDaddyGuy

CHANGELOG.md

@@ -5,17 +5,22 @@ 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.3] - Unreleased
+
+### Changed
+- Sorting: option method `withFileSort` renamed in `sort`
+
+
 ## [0.0.2] - 2025-09-16
 
 ### Added
-
 - Option: sorting files and directories
 - 39 new default files & extension mappings for emojis
 
+
 ## [0.0.1] - 2025-09-14
 
 ### Added
-
 - Initial release
 - Option: tree format Unicode box drawing / classic ASCII
 - Option: use emojis

README.md

@@ -235,7 +235,7 @@ The `PrettyPrintOptions.Sorts` class provides a set of basic, ready-to-use compa
 ```java
 // Example: Sorting.java
 var prettyPrinter = FileTreePrettyPrinter.builder()
-    .customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
+    .customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
     .build();
 ```
 ```

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

@@ -7,7 +7,7 @@ public class Sorting {
 
 	public static void main(String[] args) {
 		var prettyPrinter = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.BY_FILE_SIZE))
+			.customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
 			.build();
 		var tree = prettyPrinter.prettyPrint("src/example/resources/sorting");
 		System.out.println(tree);

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/PrettyPrintOptions.java

@@ -273,7 +273,7 @@ public Comparator<Path> pathComparator() {
 	 * 
 	 * @param pathComparator The custom comparator
 	 */
-	public PrettyPrintOptions withFileSort(Comparator<Path> pathComparator) {
+	public PrettyPrintOptions sort(Comparator<Path> pathComparator) {
 		this.pathComparator = Objects.requireNonNull(pathComparator, "pathComparator is null").thenComparing(Sorts.BY_NAME);
 		return this;
 	}

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/scanner/DefaultPathToTreeScanner.java

@@ -78,13 +78,9 @@ private TreeEntry handleDirectory(int depth, Path dir) {
 	}
 
 	private Iterator<Path> directoryStreamToIterator(DirectoryStream<Path> childrenStream) {
-		var comparator = options.pathComparator();
-		if (comparator != null) {
-			return StreamSupport.stream(childrenStream.spliterator(), false)
-				.sorted(comparator)
-				.iterator();
-		}
-		return childrenStream.iterator();
+		return StreamSupport.stream(childrenStream.spliterator(), false)
+			.sorted(options.pathComparator())
+			.iterator();
 	}
 
 	private TreeEntry handleFile(Path file) {

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/scanner/ScanningOptions.java

@@ -4,7 +4,6 @@
 import java.util.Comparator;
 import java.util.function.ToIntFunction;
 import org.jspecify.annotations.NullMarked;
-import org.jspecify.annotations.Nullable;
 
 @NullMarked
 public interface ScanningOptions {
@@ -13,7 +12,6 @@ public interface ScanningOptions {
 
 	ToIntFunction<Path> getChildrenLimitFunction();
 
-	@Nullable
 	Comparator<Path> pathComparator();
 
 }

src/test/java/io/github/computerdaddyguy/jfiletreeprettyprinter/SortingTest.java

@@ -16,7 +16,7 @@ class SortingTest {
 	void example() {
 
 		FileTreePrettyPrinter printer = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
+			.customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
 			.build();
 
 		var result = printer.prettyPrint(Path.of("src/example/resources/sorting"));
@@ -80,7 +80,7 @@ void defaultOrderIsAlphabetical() {
 	void alphabetical_reversed() {
 
 		FileTreePrettyPrinter printer = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.BY_NAME.reversed()))
+			.customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.BY_NAME.reversed()))
 			.build();
 
 		var result = printer.prettyPrint(buildDefaultPath());
@@ -107,7 +107,7 @@ void alphabetical_reversed() {
 	void fileSize() {
 
 		FileTreePrettyPrinter printer = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.BY_FILE_SIZE))
+			.customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.BY_FILE_SIZE))
 			.build();
 
 		var result = printer.prettyPrint(Path.of("src/example/resources/sorting"));
@@ -151,7 +151,7 @@ private Path build_directoryFirstOrLast_paths() {
 	void directoriesFirst() {
 
 		FileTreePrettyPrinter printer = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
+			.customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
 			.build();
 
 		var result = printer.prettyPrint(build_directoryFirstOrLast_paths());
@@ -174,7 +174,7 @@ void directoriesFirst() {
 	void directoriesLast() {
 
 		FileTreePrettyPrinter printer = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.DIRECTORY_LAST))
+			.customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.DIRECTORY_LAST))
 			.build();
 
 		var result = printer.prettyPrint(build_directoryFirstOrLast_paths());
@@ -217,7 +217,7 @@ private Path build_extension_paths() {
 	void byExtension() {
 
 		FileTreePrettyPrinter printer = FileTreePrettyPrinter.builder()
-			.customizeOptions(options -> options.withFileSort(PrettyPrintOptions.Sorts.BY_EXTENSION))
+			.customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.BY_EXTENSION))
 			.build();
 
 		var result = printer.prettyPrint(build_extension_paths());