added depth and ignore files cmd arg support

Author: PratikDev

bun.lock

@@ -24,6 +24,17 @@
 	"peerDependencies": {
 		"typescript": "^5"
 	},
+	"keywords": [
+		"cli",
+		"directory",
+		"tree",
+		"json",
+		"filesystem",
+		"tool"
+	],
 	"author": "Pratik Dev",
-	"license": "MIT"
+	"license": "MIT",
+	"dependencies": {
+		"commander": "^14.0.2"
+	}
 }

package.json

@@ -1,12 +1,90 @@
+import { Command } from "commander";
+import { access } from "node:fs/promises";
+import { resolve } from "node:path";
+
+import CONFIG from "@/config";
 import { buildTree } from "@/tree";
+import type { CLIOptions } from "@/types/types";
+
+function parseDepth(value: string): number | "inf" {
+	if (value === "inf") {
+		return "inf";
+	}
+	const num = parseInt(value, 10);
+	if (isNaN(num) || num < 0) {
+		console.error(
+			`Error: Invalid depth value "${value}". Must be a positive number or "inf".`
+		);
+		process.exit(1);
+	}
+	return num;
+}
+
+function collectIgnorePatterns(value: string, previous: string[]): string[] {
+	return previous.concat([value]);
+}
 
 export async function main() {
+	const program = new Command();
+
+	program
+		.name(CONFIG.APP.NAME)
+		.description(CONFIG.APP.DESCRIPTION)
+		.version(
+			`TreeEx v${CONFIG.APP.VERSION}`,
+			"-v, --version",
+			"Show version number"
+		)
+		.argument("[path]", "Path to analyze", ".")
+		.option(
+			"-d, --depth <level>",
+			`Maximum depth level (use "inf" for unlimited)`,
+			String(CONFIG.DEFAULT_VALUES.MAX_DEPTH)
+		)
+		.option(
+			"-i, --ignore <pattern>",
+			"Additional glob pattern to ignore (can be used multiple times)",
+			collectIgnorePatterns,
+			[]
+		)
+		.option("--no-default-ignore", "Disable default ignore patterns")
+		.addHelpText("after", CONFIG.ARGS.HELP_TEXT);
+
+	program.parse();
+
+	const options = program.opts<CLIOptions>();
+	const targetPath = resolve(program.args[0] ?? ".");
 	try {
+		// Verify path exists and is accessible
+		try {
+			await access(targetPath);
+		} catch {
+			console.error(
+				`Error: Path "${targetPath}" does not exist or is not accessible.`
+			);
+			process.exit(1);
+		}
+
+		// Build ignore patterns
+		const ignorePatterns: string[] = [];
+		// Commander's --no-default-ignore sets options.defaultIgnore to false.
+		// If --no-default-ignore is NOT present, options.defaultIgnore is true (default).
+		if (options.defaultIgnore) {
+			ignorePatterns.push(...CONFIG.DEFAULT_VALUES.IGNORES);
+		}
+		if (options.ignore && Array.isArray(options.ignore)) {
+			ignorePatterns.push(...options.ignore);
+		}
+
+		// Parse depth
+		const depth = parseDepth(options.depth);
+
 		// Build and output tree
 		const tree = await buildTree({
-			path: ".",
+			path: targetPath,
 			options: {
-				depth: "inf",
+				depth: depth,
+				ignore: ignorePatterns,
 			},
 		});
 

src/cli.ts

@@ -1,20 +1,49 @@
+const DEFAULT_VALUES = {
+	MAX_DEPTH: 20,
+	IGNORES: [
+		".git",
+		"node_modules",
+		"build",
+		"dist",
+		"out",
+		".svn",
+		".hg",
+		".CVS",
+		".DS_Store",
+		"vendor",
+		".vscode",
+	],
+};
+
 const CONFIG = {
-	DEFAULT: {
-		MAX_DEPTH: 20,
-		IGNORES: [
-			".git",
-			"node_modules",
-			"build",
-			"dist",
-			"out",
-			".svn",
-			".hg",
-			".CVS",
-			".DS_Store",
-			"vendor",
-			".vscode",
-		],
+	APP: {
+		NAME: "TreeEx",
+		DESCRIPTION: "Directory tree analyzer with JSON output",
+		VERSION: "1.0.0",
 	},
-};
+	ARGS: {
+		HELP_TEXT: `
+			Default Ignore Patterns:
+				${DEFAULT_VALUES.IGNORES.join(", ")}
+
+			Examples:
+				$ treeEx                       Analyze current directory
+				$ treeEx ./src                 Analyze ./src directory
+				$ treeEx --depth 5             Limit depth to 5 levels
+				$ treeEx --depth inf           Unlimited depth
+				$ treeEx -i "*.log"            Ignore all .log files
+				$ treeEx --no-default-ignore   Don't ignore default patterns
+
+			Output:
+				JSON tree structure with the following format:
+				{
+					"name": "directory-name",
+					"type": "directory",
+					"children": [...]
+				}
+					`,
+	},
+	DEFAULT_VALUES,
+} as const;
 
 export default CONFIG;

src/config.ts

@@ -91,8 +91,8 @@ export async function buildTree({
 	path,
 	options = {},
 }: BuildTreeParams): Promise<Node> {
-	const ignorePatterns = options.ignore ?? CONFIG.DEFAULT.IGNORES;
-	const maxDepth = options.depth ?? CONFIG.DEFAULT.MAX_DEPTH;
+	const ignorePatterns = options.ignore ?? CONFIG.DEFAULT_VALUES.IGNORES;
+	const maxDepth = options.depth ?? CONFIG.DEFAULT_VALUES.MAX_DEPTH;
 
 	return await traverseDirectory({
 		currentPath: path,

src/tree.ts

@@ -11,7 +11,15 @@ export interface Node {
  * CLI options for the TreeEx command
  */
 export interface TreeExOptions {
-	path: string;
 	depth: number | "inf";
 	ignore: string[];
 }
+
+/**
+ * CLI options parsed from command line arguments
+ */
+export interface CLIOptions {
+	depth: string;
+	ignore: string[];
+	defaultIgnore: boolean; // This will be true by default, and false if --no-default-ignore is used
+}