Filtering

Author: ComputerDaddyGuy

CHANGELOG.md

@@ -7,8 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.0.3] - Unreleased
 
+### Added
+- Filtering
+
 ### Changed
 - Sorting: option method `withFileSort` renamed in `sort`
+- `PathPredicates` help class now returns instances of `PathPredicate` to make predicate recursive
 
 
 ## [0.0.2] - 2025-09-16

README.md

@@ -2,12 +2,12 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ComputerDaddyGuy_JFileTreePrettyPrinter&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=ComputerDaddyGuy_JFileTreePrettyPrinter)
 
 A lightweight Java library for printing directory structures in a clean, tree-like format.
-- Various styles for tree rendering
+- Sorting & filtering
 - Emoji support 🎉
 - Limit displayed children (fixed value or dynamically)
 - Compact directory chains
 - Maximum depth
-- Sorting
+- Various styles for tree rendering
 
 > [!CAUTION]
 > This lib was developed just for fun, and has not been thoroughly tested!  
@@ -75,6 +75,7 @@ base/
 * [Compact directories](#compact-directories)
 * [Max depth](#max-depth)
 * [Sorting](#sorting)
+* [Filtering](#filtering)
 
 ## Tree format
 Choose between different tree formats.
@@ -252,6 +253,32 @@ sorting/
 └─ y_file
 ```
 
+## Filtering
+Files and directories can be selectively included or excluded using a custom `Predicate<Path>`.
+
+Filtering is **recursive by default**: directory's contents will always be traversed.
+However, if a directory does not match and none of its children match, the directory itself will not be displayed.
+
+The `PathPredicates` class provides several ready-to-use `Predicate<Path>` implementations for common cases, as well as a builder for creating more advanced predicates.
+
+```java
+// Example: Filtering.java
+var filter = PathPredicates.hasExtension("java");
+var tree = FileTreePrettyPrinter.createDefault()
+	.prettyPrint("src/example/resources/filtering", filter);
+```
+```
+filtering/
+├─ dir_with_java_files/
+│  ├─ file_B.java
+│  └─ file_E.java
+├─ dir_with_nested_java_files/
+│  └─ nested_dir_with_java_files/
+│     ├─ file_G.java
+│     └─ file_J.java
+└─ file_A.java
+```
+
 # Changelog
 See [CHANGELOG.md](CHANGELOG.md) for released versions.
 

ROADMAP.md

@@ -1,7 +1,6 @@
 # Roadmap
 
 ## Initial version
-
 - [x] Option: tree format Unicode box drawing / classic ASCII
 - [x] Option: use emojis
 - [x] Option: children limit (static & dynamic)
@@ -14,17 +13,22 @@
 - [x] Pre-defined Path predicates
 - [x] Publish on Maven Central!
 
-## Next version
+## Next version(s)
 - [ ] Directory children limitation function helper
 - [x] More default emojis
-- [ ] Filtering
+- [x] Filtering
 - [x] Ordering
 
 ## Other ideas
+- [ ] Use Github wiki to document options instead of readme
 - [ ] Custom tree format option
 - [ ] Custom emojis option
+- [ ] Additional text on lines
 - [ ] Color option
 - [ ] Follow symlink option
-- [ ] Print optional legend for symlink/other file types symbols (at the end of the tree)
-- [ ] File attributes LineRenderer (size, author, createAt, etc.)
 - [ ] Refactor unit tests (custom assert?)
+
+## Abandoned ideas
+These ideas will likely not been implemented because they do not align with JFileTreePrettyPrint vision:
+- File attributes LineRenderer (size, author, createAt, etc.)
+- Print optional legend for symlink/other file types symbols (at the end of the tree)

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

@@ -1,14 +1,14 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
 
 import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.PathUtils;
 import java.nio.file.Path;
 import java.util.function.ToIntFunction;
 
 public class ChildrenLimitDynamic {
 
 	public static void main(String[] args) {
-		ToIntFunction<Path> pathLimitFunction = path -> PathPredicates.hasName(path, "node_modules") ? 0 : -1; // Negative value means "no limit"
+		ToIntFunction<Path> pathLimitFunction = path -> PathUtils.hasName(path, "node_modules") ? 0 : -1; // Negative value means "no limit"
 		var prettyPrinter = FileTreePrettyPrinter.builder()
 			.customizeOptions(options -> options.withChildrenLimitFunction(pathLimitFunction))
 			.build();

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

@@ -0,0 +1,15 @@
+package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
+
+import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates;
+
+public class Filtering {
+
+	public static void main(String[] args) {
+		var filter = PathPredicates.hasExtension("java");
+		var prettyPrinter = FileTreePrettyPrinter.createDefault();
+		var tree = prettyPrinter.prettyPrint("src/example/resources/filtering", filter);
+		System.out.println(tree);
+	}
+
+}