@jigneshdpanchal/project-tree 1.0.1

package/README.md

@@ -0,0 +1,208 @@
+# project-tree 🌳
+
+[![npm version](https://img.shields.io/npm/v/project-tree.svg?style=flat)](https://www.npmjs.com/package/project-tree)
+[![Downloads](https://img.shields.io/npm/dt/project-tree.svg)](https://www.npmjs.com/package/project-tree)
+[![License](https://img.shields.io/npm/l/project-tree.svg)](https://opensource.org/licenses/ISC)
+
+A simple and fast CLI tool to generate a clean directory tree for **any Node.js project**.  
+It automatically ignores common folders like `node_modules`, `.git`, build outputs, and more.
+
+Perfect for:
+- Project documentation
+- README files
+- Code reviews
+- Understanding unfamiliar codebases
+
+---
+
+## ✨ Features
+
+- 📂 Works with **any project structure** (frontend, backend, monorepo)
+- 🚫 Ignores common clutter (`node_modules`, `.git`, `dist`, etc.)
+- ⚡ Fast and dependency-free
+- 🖥 Cross-platform (Windows, macOS, Linux)
+- 📄 Clean, readable tree output
+
+---
+
+## 📦 Installation
+
+### Option 1: Use without installing (recommended)
+
+```bash
+npx project-tree
+
+```
+
+### Option 2: Install globally
+
+```bash
+npm install -g project-tree
+
+```
+
+### 🚀 Usage
+
+1. Generate tree for current directory
+
+```bash
+project-tree
+
+```
+
+2. Generate tree for a specific folder
+
+```bash
+project-tree src
+project-tree backend
+
+```
+
+### Example output
+
+project-tree
+├── bin
+│   └── project-tree.js
+├── package.json
+└── README.md
+
+### 🚫 Ignored by Default
+
+The following files and folders are ignored automatically:
+
+* node_modules
+* .git
+* .next
+* dist
+* build
+* coverage
+* .env
+* .DS_Store
+* Lock files (package-lock.json, yarn.lock, pnpm-lock.yaml)
+
+This keeps the output clean and readable.
+
+## ⚙ CLI Options
+
+| Option                   | Description                                |
+| ------------------------ | ------------------------------------------ |
+| `--help`, `-h`           | Show this help message                     |
+| `--depth <number>`       | Limit tree output to a specific depth      |
+| `--ignore <file/folder>  | Ignore additional files or folders         |
+| `--json`                 | Output tree as JSON (useful for scripting) |
+
+## Examples:
+
+```bash
+
+# Show help
+project-tree --help
+
+# Limit depth to 2 levels
+project-tree src --depth 2
+
+# Ignore additional folder
+project-tree --ignore logs
+
+# Output JSON
+project-tree backend --json
+
+```
+
+### 🧰 Requirements
+
+Node.js v14 or higher
+
+### 🛠 Development (Local Testing)
+
+1. Clone the repo and link it locally:
+
+```bash
+
+git clone https://github.com/yourusername/project-tree.git
+cd project-tree
+npm install
+npm link
+
+```
+
+2. Run anywhere:
+
+```bash
+project-tree
+
+```
+
+### 📌 Use cases
+
+* Add project structure to README
+* Quickly inspect backend projects
+* Share folder layout in documentation
+* Understand large repositories faster
+
+### 🤝 Contributing
+
+Contributions are welcome!
+
+1. Fork the repository
+
+2. Clone your fork:
+
+```bash
+
+git clone https://github.com/yourusername/project-tree.git
+cd project-tree
+
+```
+3. Install dependencies:
+
+```bash
+
+npm install
+
+```
+
+4. Link locally for testing:
+
+```bash
+
+npm link
+
+```
+
+5. Make your changes and test:
+
+```bash
+project-tree
+
+```
+
+6. Commit, push, and create a pull request
+
+### Coding Guidelines:
+
+* Use CommonJS modules (require)
+* Keep no unnecessary dependencies
+* Maintain cross-platform compatibility
+* Write clear and descriptive commit messages
+
+### 📄 License
+
+ISC License
+
+### ⭐ Support
+
+If you find this useful, consider starring the project ⭐
+Happy coding! 🚀
+
+
+---
+
+This version:
+
+- Adds **badges** for npm version, downloads, and license  
+- Adds **CLI options** section with examples  
+- Fixes spacing and markdown formatting  
+- Keeps **installation, usage, ignored files, and requirements** clear  
+- Adds **structured contributing guide**  
+

package/bin/project-tree.js

@@ -0,0 +1,165 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+
+// --------------------
+// CLI Argument Parsing
+// --------------------
+const args = process.argv.slice(2);
+
+// Default root directory
+let ROOT_DIR = ".";
+let MAX_DEPTH = Infinity;
+let JSON_OUTPUT = false;
+
+// Default ignore list
+const DEFAULT_IGNORE = new Set([
+  "node_modules",
+  ".git",
+  ".next",
+  "dist",
+  "build",
+  "coverage",
+  ".env",
+  ".DS_Store",
+  "package-lock.json",
+  "yarn.lock",
+  "pnpm-lock.yaml"
+]);
+
+// User-specified additional ignores
+const USER_IGNORE = new Set();
+
+// --------------------
+// Parse Arguments
+// --------------------
+for (let i = 0; i < args.length; i++) {
+  const arg = args[i];
+
+  switch (arg) {
+    case "--help":
+    case "-h":
+      console.log(`
+project-tree 🌳 - Generate a directory tree
+
+Usage:
+  project-tree [directory] [options]
+
+Options:
+  --help, -h           Show this help message
+  --depth <number>     Limit tree to a specific depth
+  --ignore <name>      Ignore additional files or folders
+  --json               Output tree as JSON
+
+Examples:
+  project-tree
+  project-tree src --depth 2 --ignore logs
+  project-tree backend --json
+      `);
+      process.exit(0);
+
+    case "--depth":
+      const depth = args[i + 1];
+      if (!depth || isNaN(depth)) {
+        console.error("Error: --depth requires a number");
+        process.exit(1);
+      }
+      MAX_DEPTH = parseInt(depth, 10);
+      i++;
+      break;
+
+    case "--ignore":
+      const ignoreName = args[i + 1];
+      if (!ignoreName) {
+        console.error("Error: --ignore requires a file or folder name");
+        process.exit(1);
+      }
+      USER_IGNORE.add(ignoreName);
+      i++;
+      break;
+
+    case "--json":
+      JSON_OUTPUT = true;
+      break;
+
+    default:
+      if (!arg.startsWith("-")) {
+        ROOT_DIR = arg;
+      }
+      break;
+  }
+}
+
+// --------------------
+// Tree Generation
+// --------------------
+function generateTree(dir, prefix = "", depth = 0) {
+  let items;
+  try {
+    items = fs.readdirSync(dir, { withFileTypes: true });
+  } catch {
+    return null;
+  }
+
+  // Filter ignored items
+  items = items.filter(
+    item => !DEFAULT_IGNORE.has(item.name) && !USER_IGNORE.has(item.name)
+  );
+
+  // Sort directories first, optional
+  items.sort((a, b) => (a.isDirectory() && !b.isDirectory() ? -1 : 0));
+
+  // Build tree structure
+  const tree = [];
+
+  items.forEach((item, index) => {
+    const isLast = index === items.length - 1;
+    const connector = isLast ? "└── " : "├── ";
+    const name = item.name;
+
+    const node = { name };
+
+    if (item.isDirectory() && depth + 1 < MAX_DEPTH) {
+      const children = generateTree(path.join(dir, name), prefix + (isLast ? "    " : "│   "), depth + 1);
+      if (children) node.children = children;
+    }
+
+    tree.push(node);
+
+    // Print text if not JSON
+    if (!JSON_OUTPUT) {
+      console.log(prefix + connector + name);
+      if (node.children && node.children.length > 0) {
+        printTree(node.children, prefix + (isLast ? "    " : "│   "));
+      }
+    }
+  });
+
+  return tree;
+}
+
+// Helper to print JSON-like tree in text mode
+function printTree(tree, prefix = "") {
+  tree.forEach((node, index) => {
+    const isLast = index === tree.length - 1;
+    const connector = isLast ? "└── " : "├── ";
+    console.log(prefix + connector + node.name);
+    if (node.children) {
+      printTree(node.children, prefix + (isLast ? "    " : "│   "));
+    }
+  });
+}
+
+// --------------------
+// Run CLI
+// --------------------
+const rootName = path.basename(path.resolve(ROOT_DIR)) || ".";
+
+if (JSON_OUTPUT) {
+  const jsonTree = { name: rootName, children: generateTree(ROOT_DIR) };
+  console.log(JSON.stringify(jsonTree, null, 2));
+} else {
+  console.log(rootName);
+  generateTree(ROOT_DIR);
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@jigneshdpanchal/project-tree",
+  "version": "1.0.1",
+  "description": "Generate a clean directory tree for any Node.js project",
+  "main": "index.js",
+  "bin": {
+    "project-tree": "bin/project-tree.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "tree",
+    "directory",
+    "cli",
+    "nodejs",
+    "project-tree"
+  ],
+  "author": "Jignesh Panchal",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jigneshdpanchal/project-tree.git"
+  },
+  "type": "commonjs"
+}