make-folder-txt 1.0.1 → 1.0.3

package/README.md

@@ -1,12 +1,37 @@
-# make-folder-txt
+<div align="center">
 
-Generate a single `.txt` file containing the **full folder structure** and **contents of every file** in your project — perfect for sharing codebases with AI tools or teammates.
+# 📁 make-folder-txt
 
-Automatically ignores `node_modules`, `.git`, `dist`, `build`, and binary files.
+**Instantly dump your entire project into a single, readable `.txt` file.**
+
+[![npm version](https://img.shields.io/npm/v/make-folder-txt?color=crimson&style=flat-square)](https://www.npmjs.com/package/make-folder-txt)
+[![npm downloads](https://img.shields.io/npm/dm/make-folder-txt?color=orange&style=flat-square)](https://www.npmjs.com/package/make-folder-txt)
+[![license](https://img.shields.io/npm/l/make-folder-txt?color=blue&style=flat-square)](./LICENSE)
+[![node](https://img.shields.io/node/v/make-folder-txt?color=green&style=flat-square)](https://nodejs.org)
+
+Perfect for sharing your codebase with **AI tools**, **teammates**, or **code reviewers** — without zipping files or giving repo access.
+
+[Installation](#-installation) · [Usage](#-usage) · [Output Format](#-output-format) · [What Gets Skipped](#-what-gets-skipped) · [Contributing](#-contributing)
+
+</div>
 
 ---
 
-## Installation
+## ✨ Why make-folder-txt?
+
+Ever needed to share your entire project with ChatGPT, Claude, or a teammate — but copy-pasting every file one by one is painful? **make-folder-txt** solves that in one command.
+
+- ✅ Run it from any project directory — no arguments needed
+- ✅ Generates a clean folder tree + every file's content
+- ✅ Automatically skips `node_modules`, binaries, and junk files
+- ✅ Zero dependencies — pure Node.js
+- ✅ Works on Windows, macOS, and Linux
+
+---
+
+## 📦 Installation
+
+Install globally once, use anywhere:
 
 ```bash
 npm install -g make-folder-txt
@@ -14,28 +39,42 @@ npm install -g make-folder-txt
 
 ---
 
-## Usage
+## 🚀 Usage
+
+Navigate into your project folder and run:
 
 ```bash
-make-folder-txt <folder-path> [output-file.txt]
+cd my-project
+make-folder-txt
 ```
 
-### Examples
+That's it. A `my-project.txt` file will be created in the same directory.
+
+---
+
+## 🎯 Real World Examples
+
+**Sharing with an AI tool (ChatGPT, Claude, etc.):**
 
 ```bash
-# Basic — output saved as <folder-name>.txt in current directory
-make-folder-txt "C:\Web Development\my-project"
+cd "C:\Web Development\my-app\backend"
+make-folder-txt
+# → backend.txt created, ready to paste into any AI chat
+```
 
-# Custom output file name
-make-folder-txt "C:\Web Development\my-project" my-output.txt
+**On macOS / Linux:**
 
-# On Mac/Linux
-make-folder-txt /home/user/my-project
+```bash
+cd /home/user/projects/my-app
+make-folder-txt
+# → my-app.txt created
 ```
 
 ---
 
-## Output Format
+## 📄 Output Format
+
+The generated `.txt` file is structured in two clear sections:
 
 ```
 ================================================================================
@@ -49,13 +88,16 @@ Root: C:\Web Development\my-project
 
 my-project/
 ├── src/
-│   ├── index.js
-│   └── utils.js
+│   ├── controllers/
+│   │   └── userController.js
+│   ├── models/
+│   │   └── User.js
+│   └── index.js
 ├── node_modules/  [skipped]
 ├── package.json
 └── README.md
 
-Total files: 4
+Total files: 5
 
 ================================================================================
 FILE CONTENTS
@@ -64,7 +106,16 @@ FILE CONTENTS
 --------------------------------------------------------------------------------
 FILE: /src/index.js
 --------------------------------------------------------------------------------
-... file content here ...
+const express = require('express');
+...
+
+--------------------------------------------------------------------------------
+FILE: /package.json
+--------------------------------------------------------------------------------
+{
+  "name": "my-project",
+  ...
+}
 
 ================================================================================
 END OF FOLDER: my-project
@@ -73,17 +124,57 @@ END OF FOLDER: my-project
 
 ---
 
-## What Gets Skipped
+## 🚫 What Gets Skipped
 
-| Type | Details |
-|------|---------|
-| Folders | `node_modules`, `.git`, `.next`, `dist`, `build`, `.cache` |
-| Binary files | Images, fonts, zips, executables, media |
-| Large files | Any file over 500 KB |
-| System files | `.DS_Store`, `Thumbs.db`, `desktop.ini` |
+The tool is smart about what it ignores so your output stays clean and readable.
+
+| Category        | Details                                                        |
+| --------------- | -------------------------------------------------------------- |
+| 📁 Folders      | `node_modules`, `.git`, `.next`, `dist`, `build`, `.cache`     |
+| 🖼️ Binary files | Images (`.png`, `.jpg`, `.gif`...), fonts, videos, executables |
+| 📦 Archives     | `.zip`, `.tar`, `.gz`, `.rar`, `.7z`                           |
+| 🔤 Font files   | `.woff`, `.woff2`, `.ttf`, `.eot`, `.otf`                      |
+| 📋 Lock files   | `package-lock.json`, `yarn.lock`                               |
+| 📏 Large files  | Any file over **500 KB**                                       |
+| 🗑️ System files | `.DS_Store`, `Thumbs.db`, `desktop.ini`                        |
+
+Binary and skipped files are noted in the output as `[binary / skipped]` so you always know what was omitted.
+
+---
+
+## 🛠️ Requirements
+
+- **Node.js** v14.0.0 or higher
+- No other dependencies
+
+---
+
+## 🤝 Contributing
+
+Contributions, issues, and feature requests are welcome!
+
+1. Fork the repository
+2. Create your feature branch: `git checkout -b feature/my-feature`
+3. Commit your changes: `git commit -m 'Add my feature'`
+4. Push to the branch: `git push origin feature/my-feature`
+5. Open a Pull Request
+
+---
+
+## 👤 Author
+
+**AnnonymousThinker**
 
 ---
 
-## License
+## 📝 License
+
+This project is licensed under the **MIT License** — feel free to use it in personal and commercial projects.
+
+---
+
+<div align="center">
+
+If this tool saved you time, consider giving it a ⭐ on npm!
 
-MIT
+</div>

package/bin/make-folder-txt.js

@@ -2,6 +2,7 @@
 
 const fs = require("fs");
 const path = require("path");
+const { version } = require("../package.json");
 
 // ── config ────────────────────────────────────────────────────────────────────
 const IGNORE_DIRS = new Set(["node_modules", ".git", ".next", "dist", "build", ".cache"]);
@@ -70,12 +71,21 @@ function readContent(absPath) {
 
 // ── main ──────────────────────────────────────────────────────────────────────
 
+const args = process.argv.slice(2);
+
+if (args.includes("-v") || args.includes("--version")) {
+  console.log(`v${version}`);
+  console.log("Built by Muhammad Saad Amin");
+  process.exit(0);
+}
+
 const folderPath = process.cwd();
 
 const rootName = path.basename(folderPath);
 
-const outputFile = process.argv[3]
-  ? path.resolve(process.argv[3])
+const outputArg = args.find(arg => !arg.startsWith("-"));
+const outputFile = outputArg
+  ? path.resolve(outputArg)
   : path.join(process.cwd(), `${rootName}.txt`);
 
 console.log(`\n📂  Scanning: ${folderPath}`);
@@ -125,4 +135,4 @@ const sizeKB = (fs.statSync(outputFile).size / 1024).toFixed(1);
 console.log(`✅  Done!`);
 console.log(`📄  Output : ${outputFile}`);
 console.log(`📊  Size   : ${sizeKB} KB`);
-console.log(`🗂️   Files  : ${filePaths.length}\n`);
+console.log(`🗂️   Files  : ${filePaths.length}\n`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "make-folder-txt",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Generate a single .txt file containing the full folder structure and file contents of any project, ignoring node_modules and other junk.",
   "main": "bin/make-folder-txt.js",
   "bin": {