Compact directories

Author: ComputerDaddyGuy

README.md

@@ -1,20 +1,45 @@
 # JFileTreePrettyPrint
 
-A lightweight Java library for printing directory structures in a clean, tree-like format (think Unix `tree` command).
+A lightweight Java library for printing directory structures in a clean, tree-like format.
 
 - Print folder trees like Unix `tree`
-- Choose ASCII or Unicode styles for tree rendering
-- Emoji support 🎉
-- Limit displayed children statically or dynamically
+- Customizable:
+  - ASCII or Unicode styles for tree rendering
+  - Emoji support 🎉
+  - Limit displayed children statically or dynamically
+  - Compact directory chains
+
+**ℹ️ Was developed just for fun, has not been thoroughly tested! May not be suitable for production code 😊**
+
+```java
+// Example: BasicUsage.java
+var printer = FileTreePrettyPrinter.createDefault();
+var tree = printer.prettyPrint("src/example/resources/base");
+System.out.println(tree);
+```
+
+Result:
+```
+base/
+├─ businessPlan.pdf
+├─ businessProject.pdf
+├─ cars/
+│  ├─ Ferrari.doc
+│  └─ Porsche.doc
+├─ diyIdeas.docx
+├─ giftIdeas.txt
+└─ images/
+   ├─ funnyCat.gif
+   ├─ holidays/
+   │  ├─ meAtTheBeach.jpeg
+   │  └─ meAtTheZoo.jpeg
+   └─ landscape.jpeg
+```
 
-ℹ️ Was developed just for fun!
 
-* [Import dependency](#import-dependency)
 * [Usage](#usage)  
+* [Import dependency](#import-dependency)
 * [Options](#options)
-  * [Tree format](#tree-format)
-  * [Emojis ❤️](#emojis-%EF%B8%8F)
-  * [Children limit](#children-limit)
 * [Changelog](#changelog) 
 * [Roadmap](#roadmap) 
 * [License](#license) 
@@ -39,34 +64,14 @@ For Gradle:
 implementation "com.github.computerdaddyguy:jfiletreeprettyprinter:0.1.0"
 ```
 
-# Usage
-```java
-// Example: BasicUsage.java
-var printer = FileTreePrettyPrinter.createDefault();
-var tree = printer.prettyPrint("src/example/resources/base");
-System.out.println(tree);
-```
-
-Result:
-```
-base/
-├─ businessPlan.pdf
-├─ businessProject.pdf
-├─ cars/
-│  ├─ Ferrari.doc
-│  └─ Porsche.doc
-├─ diyIdeas.docx
-├─ giftIdeas.txt
-└─ images/
-   ├─ funnyCat.gif
-   ├─ holidays/
-   │  ├─ meAtTheBeach.jpeg
-   │  └─ meAtTheZoo.jpeg
-   └─ landscape.jpeg
-```
 
 # Options
 
+* [Tree format](#tree-format)
+* [Emojis ❤️](#emojis-%EF%B8%8F)
+* [Children limit](#children-limit)
+* [Compact directories](#compact-directories)
+  
 ## Tree format
 Choose between different tree formats.
 The default is `UNICODE_BOX_DRAWING`, supported by all terminals, but you can also switch to use `CLASSIC_ASCII`.
@@ -163,7 +168,8 @@ static_children_limit/
 
 ```
 
-Or you can also set a limitation function, to dynamically choose the number of children displayed in each directory (for, say, avoid cluttering the whole console with known large folders like `node_modules` but continue to pretty print normally other folders).
+Or you can also set a limitation function, to dynamically choose the number of children displayed in each directory.
+It avoids cluttering the whole console with known large folders (e.g. `node_modules`) but continue to pretty print normally other folders.
 
 The `PathPredicates` class contains several ready-to-use predicates to help you.
 
@@ -187,6 +193,27 @@ children_limit_dynamic/
    └─ ... (9 files skipped)
 ```
 
+💡 *Idea for a future version: helper for custom basic functions (by name, prefix, regex, etc.)*
+
+## Compact directories
+Directories chain with single directory child are fully expanded by default, but you can compact them into a single tree entry.
+
+```java
+// Example: CompactDirectories.java
+var prettyPrinter = FileTreePrettyPrinter.builder()
+    .customizeOptions(options -> options.withCompactDirectories(true))
+    .build();
+```
+```
+single_directory_child/
+├─ file1
+├─ file2
+└─ this/is/single/directory/child/
+   ├─ file1
+   ├─ file2
+   └─ file3
+```
+
 # Changelog
 See [CHANGELOG.md](CHANGELOG.md) for released versions.
 

ROADMAP.md

@@ -9,8 +9,9 @@
 - [x] Pre-defined Path predicates
 - [x] Add examples & README
 - [x] Implement emojis for files
+- [x] Unify dir-in-a-row into a single entry option
 - [ ] Max depth options
-- [ ] Unify dir-in-a-row into a single entry option
+- [ ] Refactor unit tests (custom assert?)
 - [ ] Publish on Maven Central!
 
 ## Other ideas

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

@@ -0,0 +1,15 @@
+package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
+
+import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
+
+public class CompactDirectories {
+
+	public static void main(String[] args) {
+		var prettyPrinter = FileTreePrettyPrinter.builder()
+			.customizeOptions(options -> options.withCompactDirectories(true))
+			.build();
+		var tree = prettyPrinter.prettyPrint("src/example/resources/single_directory_child");
+		System.out.println(tree);
+	}
+
+}

src/example/resources/single_directory_child/file1

@@ -14,6 +14,7 @@ public class PrettyPrintOptions implements VisitingOptions, RenderingOptions {
 
 	private TreeFormat treeFormat = TreeFormat.UNICODE_BOX_DRAWING;
 	private boolean useEmojis = false;
+	private boolean compactDirectories = false;
 
 	public PrettyPrintOptions() {
 		super();
@@ -91,4 +92,22 @@ public PrettyPrintOptions withEmojis(boolean useEmojis) {
 		return this;
 	}
 
+	// ----------------------------------------------
+
+	@Override
+	public boolean areCompactDirectoriesUsed() {
+		return compactDirectories;
+	}
+
+	/**
+	 * Whether or not compact directories chain into a single entry in the rendered tree.
+	 * Default is {@code false}.
+	 * 
+	 * @param compact	{@code true} to compact, {@code false} otherwise.
+	 */
+	public PrettyPrintOptions withCompactDirectories(boolean compact) {
+		this.compactDirectories = compact;
+		return this;
+	}
+
 }

src/example/resources/single_directory_child/file2

@@ -71,14 +71,20 @@ public boolean hasSomeNotVisitedChildren() {
 		return records.isEmpty() ? false : records.getLast().notVisited().size() > 0;
 	}
 
+	public boolean hasSingleDirectoryChild() {
+		return records.isEmpty() ? false : records.getLast().hasSingleDirectoryChild();
+	}
+
 	private class ChildVisitCounterRecord {
 
 		private final int maxChildVisitCount;
+		private LinkedHashSet<Path> allChildren;
 		private LinkedHashSet<Path> notVisited;
 		private LinkedHashSet<Path> alreadyVisited;
 
 		ChildVisitCounterRecord(int maxChildVisitCount, LinkedHashSet<Path> childrenInDir) {
 			this.maxChildVisitCount = maxChildVisitCount;
+			this.allChildren = childrenInDir;
 			this.notVisited = childrenInDir;
 			this.alreadyVisited = new LinkedHashSet<Path>();
 		}
@@ -99,6 +105,10 @@ Set<Path> notVisited() {
 			return notVisited;
 		}
 
+		boolean hasSingleDirectoryChild() {
+			return allChildren.size() == 1 && allChildren.getFirst().toFile().isDirectory();
+		}
+
 	}
 
 }