treeviz-cli 1.0.0

package/README.md

@@ -0,0 +1,47 @@
+# @treeviz/cli
+
+Generate ASCII directory trees from the terminal. Zero dependencies, powered by Bun.
+
+## Installation
+
+```bash
+bun add -g @treeviz/cli
+```
+
+## Usage
+
+```bash
+# Current directory
+treeviz
+
+# Specific path
+treeviz ./src
+
+# Add custom ignores
+treeviz --ignore .env,coverage
+
+# Disable default ignores
+treeviz --no-default-ignores
+
+# Copy output to clipboard
+treeviz --copy
+```
+
+## Options
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `[path]` | | Directory to visualize (default: `.`) |
+| `--ignore <folders>` | `-i` | Comma-separated folders to add to ignore list |
+| `--no-default-ignores` | | Disable the default ignore list |
+| `--copy` | `-c` | Copy output to clipboard |
+| `--help` | `-h` | Show help |
+| `--version` | `-v` | Show version |
+
+## Default Ignores
+
+`node_modules`, `.git`, `.next`, `.husky`, `.turbo`, `dist`, `build`, `.DS_Store`
+
+## Web Version
+
+Try the browser-based version at [treeviz.dev](https://treeviz.dev) — select a folder and get the same output with zero uploads.

package/dist/index.js

@@ -0,0 +1,182 @@
+#!/usr/bin/env bun
+// @bun
+
+// src/index.ts
+import { existsSync, statSync } from "fs";
+import { resolve } from "path";
+
+// src/tree-generator.ts
+import { readdirSync } from "fs";
+import { join, basename } from "path";
+var DEFAULT_IGNORES = [
+  "node_modules",
+  ".git",
+  ".next",
+  ".husky",
+  ".turbo",
+  "dist",
+  "build",
+  ".DS_Store"
+];
+function traverseDirectory(dirPath, ignoreList = DEFAULT_IGNORES) {
+  const entries = readdirSync(dirPath, { withFileTypes: true });
+  const children = [];
+  for (const entry of entries) {
+    if (ignoreList.includes(entry.name))
+      continue;
+    if (entry.isDirectory()) {
+      const childNode = traverseDirectory(join(dirPath, entry.name), ignoreList);
+      children.push(childNode);
+    } else {
+      children.push({ name: entry.name, type: "file" });
+    }
+  }
+  children.sort((a, b) => {
+    if (a.type !== b.type)
+      return a.type === "directory" ? -1 : 1;
+    return a.name.localeCompare(b.name);
+  });
+  return {
+    name: basename(dirPath),
+    type: "directory",
+    children
+  };
+}
+function generateAsciiTree(node, prefix = "", isRoot = true) {
+  let result = "";
+  if (isRoot) {
+    result += node.name + `/
+`;
+  }
+  const children = node.children ?? [];
+  children.forEach((child, index) => {
+    const isLast = index === children.length - 1;
+    const connector = isLast ? "\u2514\u2500\u2500 " : "\u251C\u2500\u2500 ";
+    const childPrefix = isLast ? "    " : "\u2502   ";
+    const suffix = child.type === "directory" ? "/" : "";
+    result += prefix + connector + child.name + suffix + `
+`;
+    if (child.type === "directory" && child.children?.length) {
+      result += generateAsciiTree(child, prefix + childPrefix, false);
+    }
+  });
+  return result;
+}
+
+// src/index.ts
+var VERSION = "1.0.0";
+var HELP = `
+treeviz - Generate ASCII directory trees
+
+Usage:
+  treeviz [path] [options]
+
+Arguments:
+  path                    Directory to visualize (default: current directory)
+
+Options:
+  -i, --ignore <folders>  Comma-separated folders to ignore (added to defaults)
+  --no-default-ignores    Disable the default ignore list
+  -c, --copy              Copy output to clipboard
+  -h, --help              Show this help message
+  -v, --version           Show version
+
+Default ignores:
+  ${DEFAULT_IGNORES.join(", ")}
+
+Examples:
+  treeviz
+  treeviz ./src
+  treeviz --ignore .env,coverage
+  treeviz --no-default-ignores
+  treeviz --copy
+`.trim();
+function parseArgs(argv) {
+  const args = argv.slice(2);
+  let targetPath = ".";
+  let extraIgnores = [];
+  let useDefaultIgnores = true;
+  let copyToClipboard = false;
+  for (let i = 0;i < args.length; i++) {
+    const arg = args[i];
+    if (arg === "-h" || arg === "--help") {
+      console.log(HELP);
+      process.exit(0);
+    }
+    if (arg === "-v" || arg === "--version") {
+      console.log(`treeviz v${VERSION}`);
+      process.exit(0);
+    }
+    if (arg === "--no-default-ignores") {
+      useDefaultIgnores = false;
+      continue;
+    }
+    if (arg === "-c" || arg === "--copy") {
+      copyToClipboard = true;
+      continue;
+    }
+    if (arg === "-i" || arg === "--ignore") {
+      const next = args[++i];
+      if (!next) {
+        console.error("Error: --ignore requires a value");
+        process.exit(1);
+      }
+      extraIgnores = next.split(",").map((s) => s.trim());
+      continue;
+    }
+    if (!arg.startsWith("-")) {
+      targetPath = arg;
+      continue;
+    }
+    console.error(`Unknown option: ${arg}`);
+    console.error('Run "treeviz --help" for usage');
+    process.exit(1);
+  }
+  return { targetPath, extraIgnores, useDefaultIgnores, copyToClipboard };
+}
+async function main() {
+  const { targetPath, extraIgnores, useDefaultIgnores, copyToClipboard } = parseArgs(process.argv);
+  const fullPath = resolve(targetPath);
+  if (!existsSync(fullPath)) {
+    console.error(`Error: Path does not exist: ${fullPath}`);
+    process.exit(1);
+  }
+  if (!statSync(fullPath).isDirectory()) {
+    console.error(`Error: Not a directory: ${fullPath}`);
+    process.exit(1);
+  }
+  const ignoreList = [
+    ...useDefaultIgnores ? DEFAULT_IGNORES : [],
+    ...extraIgnores
+  ];
+  const tree = traverseDirectory(fullPath, ignoreList);
+  const output = generateAsciiTree(tree);
+  console.log(output);
+  if (copyToClipboard) {
+    try {
+      const proc = Bun.spawn(["pbcopy"], {
+        stdin: "pipe"
+      });
+      proc.stdin.write(output);
+      proc.stdin.end();
+      await proc.exited;
+      console.log(`
+\u2713 Copied to clipboard`);
+    } catch {
+      try {
+        const proc = Bun.spawn(["xclip", "-selection", "clipboard"], {
+          stdin: "pipe"
+        });
+        proc.stdin.write(output);
+        proc.stdin.end();
+        await proc.exited;
+        console.log(`
+\u2713 Copied to clipboard`);
+      } catch {
+        console.error(`
+\u2717 Could not copy to clipboard (pbcopy/xclip not found)`);
+      }
+    }
+  }
+}
+main();

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "treeviz-cli",
+  "version": "1.0.0",
+  "description": "Generate ASCII directory trees from the terminal",
+  "type": "module",
+  "bin": {
+    "treeviz": "./dist/index.js"
+  },
+  "scripts": {
+    "dev": "bun run src/index.ts",
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "tree",
+    "directory",
+    "ascii",
+    "cli",
+    "file-tree"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bireycikan/treeviz-cli"
+  },
+  "homepage": "https://github.com/bireycikan/treeviz-cli#readme",
+  "bugs": {
+    "url": "https://github.com/bireycikan/treeviz-cli/issues"
+  },
+  "devDependencies": {
+    "bun-types": "^1.3.8"
+  }
+}