first commit

Author: ComputerDaddyGuy

.gitignore

@@ -0,0 +1,61 @@
+# Compiled class files
+*.class
+*.jar
+*.war
+*.ear
+
+# Log files
+*.log
+hs_err_pid*
+
+# Maven specific
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+.mvn/wrapper/maven-wrapper.jar
+
+# GPG keys (security risk!)
+private.gpg
+public.gpg
+*.asc
+
+# IntelliJ IDEA
+.idea/
+*.iml
+*.iws
+out/
+
+# Eclipse
+.project
+.classpath
+.settings/
+
+# NetBeans
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+.netbeans/
+
+# VS Code
+.vscode/
+
+# OS-specific files
+.DS_Store
+Thumbs.db
+
+# SonarQube
+.sonar/
+target/site/
+target/surefire-reports/
+target/failsafe-reports/
+
+# GitHub Actions cache
+.github/workflows/*.log
+.github/workflows/cache/

ROADMAP.md

@@ -0,0 +1,14 @@
+# Roadmap
+
+## Next version
+[x] Use JSpecify annotations
+[ ] Builder with options (depth symbols, emoji, colors)
+[ ] Max depth option
+[ ] Unify dir-in-a-row into a single entry option
+[ } Regroup all formatting work under single "LineFormatter"
+[ ] Better "isLast" detection algorithm
+[ ] Unit tests, using @TempDir
+
+## Other ideas
+[ ] Filtering
+[ ] Alternative implementation (using DirectoryStream instead of Files.walkFileTree)

pom.xml

@@ -0,0 +1,27 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	
+	<modelVersion>4.0.0</modelVersion>
+	
+	<groupId>io.github.computerdaddyguy</groupId>
+	<artifactId>jfiletreeprinter</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+
+	<properties>
+		<java.version>21</java.version>
+		<maven.compiler.source>21</maven.compiler.source>
+		<maven.compiler.target>21</maven.compiler.target>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		
+		<jspecify.version>1.0.0</jspecify.version>
+	</properties>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.jspecify</groupId>
+			<artifactId>jspecify</artifactId>
+			<version>${jspecify.version}</version>
+		</dependency>
+	</dependencies>
+
+</project>

src/main/java/io/github/computerdaddyguy/jfiletreeprinter/FileWalkTest.java

@@ -0,0 +1,27 @@
+package io.github.computerdaddyguy.jfiletreeprinter;
+
+import java.io.IOException;
+
+import io.github.computerdaddyguy.jfiletreeprinter.core.FileTreePrettyPrinter;
+
+public class FileWalkTest {
+
+	public static void main(String[] args) throws IOException {
+		test("C:\\Users\\samue\\eclipse-workspace\\jfiletreeprinter\\src\\test\\resources");
+//		test("C:\\Users\\samue\\eclipse-workspace\\jfiletreeprinter\\src\\test\\resources\\empty_folder");
+//		test("C:\\Users\\samue\\eclipse-workspace\\jfiletreeprinter\\src\\test\\resources\\folder_with_1_file");
+//		test("C:\\Users\\samue\\eclipse-workspace\\jfiletreeprinter\\src\\test\\resources\\folder_with_3_files");
+//		test("C:\\Users\\samue\\eclipse-workspace\\jfiletreeprinter\\src\\test\\resources\\folder_with_3_files_and_subfolders");
+//		test("C:\\Users\\samue\\eclipse-workspace\\jfiletreeprinter\\src\\test\\resources\\skipped");
+//		test("C:\\Users\\samue\\eclipse-workspace\\jfiletreeprinter");
+	}
+
+	private static void test(String path) throws IOException {
+		System.out.println("-------------------------------------------------------");
+		System.out.println(">>> " + path);
+		var tree = FileTreePrettyPrinter.createDefault().prettyPrint(path);
+		System.out.println(tree);
+		System.out.println("-------------------------------------------------------");
+	}
+
+}

src/main/java/io/github/computerdaddyguy/jfiletreeprinter/core/DefaultFileTreePrettyPrinter.java

@@ -0,0 +1,31 @@
+package io.github.computerdaddyguy.jfiletreeprinter.core;
+
+import io.github.computerdaddyguy.jfiletreeprinter.core.visitor.FileTreePrettyPrintVisitor;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Objects;
+import org.jspecify.annotations.NullMarked;
+
+@NullMarked
+class DefaultFileTreePrettyPrinter implements FileTreePrettyPrinter {
+
+	private final FileTreePrettyPrintVisitor visitor;
+
+	public DefaultFileTreePrettyPrinter(FileTreePrettyPrintVisitor visitor) {
+		this.visitor = Objects.requireNonNull(visitor, "visitor cannot be null");
+	}
+
+	@Override
+	public String prettyPrint(Path path) {
+		try {
+			visitor.reset();
+			Files.walkFileTree(path, visitor);
+			return visitor.getResult();
+		} catch (IOException e) {
+			throw new UncheckedIOException("Exception in pretty-print process of path: " + path.toAbsolutePath(), e);
+		}
+	}
+
+}

src/main/java/io/github/computerdaddyguy/jfiletreeprinter/core/FileTreePrettyPrinter.java

@@ -0,0 +1,28 @@
+package io.github.computerdaddyguy.jfiletreeprinter.core;
+
+import io.github.computerdaddyguy.jfiletreeprinter.core.visitor.FileTreePrettyPrintVisitor;
+import java.nio.file.Path;
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * @implNote Instances of this interface are not thread safe.
+ */
+@NullMarked
+public interface FileTreePrettyPrinter {
+
+	String prettyPrint(Path path);
+
+	default String prettyPrint(String path) {
+		return prettyPrint(Path.of(path));
+	}
+
+	static FileTreePrettyPrinter createDefault() {
+		var visitor = FileTreePrettyPrintVisitor.builder().build();
+		return new DefaultFileTreePrettyPrinter(visitor);
+	}
+
+	static FileTreePrettyPrinter createWithVisitor(FileTreePrettyPrintVisitor visitor) {
+		return new DefaultFileTreePrettyPrinter(visitor);
+	}
+
+}

src/main/java/io/github/computerdaddyguy/jfiletreeprinter/core/predicates/FileVisitorPredicates.java

@@ -0,0 +1,24 @@
+package io.github.computerdaddyguy.jfiletreeprinter.core.predicates;
+
+import java.nio.file.Path;
+import java.util.Collection;
+import java.util.List;
+import java.util.function.Predicate;
+import org.jspecify.annotations.NullMarked;
+
+@NullMarked
+public final class FileVisitorPredicates {
+
+	private FileVisitorPredicates() {
+		// Helper class
+	}
+
+	public static Predicate<Path> hasName(String name) {
+		return hasNameIn(List.of(name));
+	}
+
+	public static Predicate<Path> hasNameIn(Collection<String> names) {
+		return (path) -> names.contains(path.getFileName().toString());
+	}
+
+}

src/main/java/io/github/computerdaddyguy/jfiletreeprinter/core/visitor/DefaultFileTreePrettyPrintVisitor.java

@@ -0,0 +1,155 @@
+package io.github.computerdaddyguy.jfiletreeprinter.core.visitor;
+
+import io.github.computerdaddyguy.jfiletreeprinter.core.visitor.depth.Depth;
+import io.github.computerdaddyguy.jfiletreeprinter.core.visitor.depth.DepthFormatter;
+import io.github.computerdaddyguy.jfiletreeprinter.core.visitor.depth.DepthSymbol;
+import io.github.computerdaddyguy.jfiletreeprinter.core.visitor.filename.FileNameFormatter;
+import io.github.computerdaddyguy.jfiletreeprinter.core.visitor.limit.ChildVisitCounter;
+import io.github.computerdaddyguy.jfiletreeprinter.core.visitor.limit.ChildrenLimitConfig;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Path;
+import java.nio.file.attribute.BasicFileAttributes;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+@NullMarked
+class DefaultFileTreePrettyPrintVisitor implements FileTreePrettyPrintVisitor {
+
+	private final DepthFormatter depthFormatter;
+	private final ChildrenLimitConfig childrenLimitConfig;
+	private final FileNameFormatter fileNameFormatter;
+
+	private StringBuilder buff;
+	private Depth depth;
+	private ChildVisitCounter counter;
+
+	public DefaultFileTreePrettyPrintVisitor(
+		DepthFormatter depthFormatter,
+		ChildrenLimitConfig childrenLimitConfig, FileNameFormatter fileNameFormatter
+	) {
+		super();
+		this.depthFormatter = depthFormatter;
+		this.childrenLimitConfig = childrenLimitConfig;
+		this.fileNameFormatter = fileNameFormatter;
+
+		reset();
+	}
+
+	@Override
+	public String getResult() {
+		return buff.toString();
+	}
+
+	@Override
+	public void reset() {
+		this.buff = new StringBuilder();
+		this.depth = new Depth();
+		this.counter = new ChildVisitCounter(childrenLimitConfig.getChildrenLimitFunction());
+	}
+
+	@Override
+	public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
+		// DEPTH
+		updateDepth(dir);
+		_appendBuff_depth();
+		depth = depth.append(DepthSymbol.NON_LAST_FILE); // assume not last until proven otherwise
+
+		// FILE
+		_appendBuff_path(fileNameFormatter.formatDirectoryBegin(dir, attrs));
+
+		// COUNTER
+		counter.registerChildVisitInCurrentDir(dir);
+		counter.enterNewDirectory(dir);
+
+		return FileVisitResult.CONTINUE;
+	}
+
+	@Override
+	public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+		// COUNTER
+		if (counter.exceedsCurrentLimit()) {
+			return FileVisitResult.SKIP_SIBLINGS;
+		}
+		counter.registerChildVisitInCurrentDir(file);
+
+		// DEPTH
+		updateDepth(file);
+		_appendBuff_depth();
+
+		// FILE
+		_appendBuff_path(fileNameFormatter.formatFile(file, attrs));
+
+		return FileVisitResult.CONTINUE;
+	}
+
+	@Override
+	public FileVisitResult visitFileFailed(Path file, @Nullable IOException exc) throws IOException {
+		// DEPTH
+		updateDepth(file);
+		_appendBuff_depth();
+
+		// FILE
+		if (exc != null) {
+			_appendBuff_path(fileNameFormatter.formatFileException(file, exc));
+		}
+
+		return FileVisitResult.CONTINUE;
+	}
+
+	@Override
+	public FileVisitResult postVisitDirectory(Path dir, @Nullable IOException exc) throws IOException {
+
+		if (exc != null) {
+			_appendBuff_path(fileNameFormatter.formatDirectoryException(dir, exc));
+		}
+
+		// DEPTH
+		depth = depth.pop();
+
+		// COUNTER
+		var limitReached = counter.exceedsCurrentLimit();
+		if (limitReached) {
+			depth = depth.append(DepthSymbol.LAST_FILE);
+			_appendBuff_depth();
+			_appendBuff_path(
+				childrenLimitConfig.getFormatter().formatLimitReached(counter.notVisitedInCurrentDirCount())
+			);
+			depth = depth.pop();
+		}
+		counter.exitCurrentDirectory();
+
+		if (limitReached) {
+			return FileVisitResult.SKIP_SIBLINGS;
+		}
+		return FileVisitResult.CONTINUE;
+	}
+
+	private void updateDepth(Path path) {
+		if (depth.isEmpty()) {
+			return;
+		}
+
+		var isLast = isLastChild(path);
+		depth = depth.pop();
+		depth = depth.append(isLast ? DepthSymbol.LAST_FILE : DepthSymbol.NON_LAST_FILE);
+	}
+
+	private boolean isLastChild(Path path) {
+		Path parent = path.getParent();
+		File[] siblings = parent.toFile().listFiles();
+		return siblings != null && siblings[siblings.length - 1].toPath().equals(path);
+	}
+
+	private void _appendBuff_depth() {
+		buff.append(depthFormatter.format(depth));
+	}
+
+	private void _appendBuff_path(@Nullable String str) {
+		if (str != null) {
+			buff.append(str).append('\n');
+		}
+	}
+
+}