make-folder-txt 1.3.1 → 1.3.2

package/.txtignore

@@ -0,0 +1,2 @@
+LICENSE
+bin/make-folder-txt.js

package/bin/make-folder-txt.js

@@ -81,8 +81,11 @@ function collectFiles(
         return;
       }
 
-      // Check against .txtignore patterns
-      if (txtIgnore.has(entry.name) || txtIgnore.has(`${entry.name}/`)) {
+      // Get relative path for .txtignore pattern matching
+      const relPathForIgnore = path.relative(rootDir, path.join(dir, entry.name)).split(path.sep).join("/");
+      
+      // Check against .txtignore patterns (both dirname and relative path)
+      if (txtIgnore.has(entry.name) || txtIgnore.has(`${entry.name}/`) || txtIgnore.has(relPathForIgnore) || txtIgnore.has(`${relPathForIgnore}/`) || txtIgnore.has(`/${relPathForIgnore}/`)) {
         if (!hasOnlyFilters) {
           lines.push(`${indent}${connector}${entry.name}/  [skipped]`);
         }
@@ -122,8 +125,11 @@ function collectFiles(
     } else {
       if (ignoreFiles.has(entry.name)) return;
 
-      // Check against .txtignore patterns
-      if (txtIgnore.has(entry.name)) {
+      // Get relative path for .txtignore pattern matching
+      const relPathForIgnore = path.relative(rootDir, path.join(dir, entry.name)).split(path.sep).join("/");
+      
+      // Check against .txtignore patterns (both filename and relative path)
+      if (txtIgnore.has(entry.name) || txtIgnore.has(relPathForIgnore) || txtIgnore.has(`/${relPathForIgnore}`)) {
         return;
       }
 

package/make-folder-txt.txt

@@ -0,0 +1,278 @@
+================================================================================
+START OF FOLDER: make-folder-txt
+================================================================================
+
+================================================================================
+PROJECT STRUCTURE
+================================================================================
+Root: C:\Programming\make-folder-txt
+
+make-folder-txt/
+├── .git/  [skipped]
+├── bin/
+├── package.json
+└── README.md
+
+Total files: 2
+
+================================================================================
+FILE CONTENTS
+================================================================================
+
+--------------------------------------------------------------------------------
+FILE: /package.json
+--------------------------------------------------------------------------------
+{
+  "name": "make-folder-txt",
+  "version": "1.3.1",
+  "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": {
+    "make-folder-txt": "bin/make-folder-txt.js"
+  },
+  "scripts": {
+    "test": "echo \"No tests yet\" && exit 0"
+  },
+  "keywords": [
+    "folder",
+    "dump",
+    "project",
+    "structure",
+    "txt",
+    "cli",
+    "export"
+  ],
+  "author": "Muhammad Saad Amin",
+  "license": "MIT",
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}
+
+
+--------------------------------------------------------------------------------
+FILE: /README.md
+--------------------------------------------------------------------------------
+<div align="center">
+
+# 📁 make-folder-txt
+
+**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>
+
+---
+
+## ✨ 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
+```
+
+---
+
+## 🚀 Usage
+
+Navigate into your project folder and run:
+
+```bash
+cd my-project
+make-folder-txt
+```
+
+That's it. A `my-project.txt` file will be created in the same directory.
+
+Ignore specific folders/files by name:
+
+```bash
+make-folder-txt --ignore-folder examples extensions docs
+make-folder-txt --ignore-folder examples extensions "docs and explaination"
+make-folder-txt --ignore-folder examples extensions docs --ignore-file LICENSE
+make-folder-txt --ignore-file .env .env.local secrets.txt
+```
+
+Use a `.txtignore` file (works like `.gitignore`):
+
+```bash
+# Create a .txtignore file in your project root
+echo "node_modules/" > .txtignore
+echo "*.log" >> .txtignore
+echo ".env" >> .txtignore
+echo "coverage/" >> .txtignore
+
+# The tool will automatically read and respect .txtignore patterns
+make-folder-txt
+```
+
+The `.txtignore` file supports:
+- File and folder names (one per line)
+- Wildcard patterns (`*.log`, `temp-*`)
+- Comments (lines starting with `#`)
+- Folder patterns with trailing slash (`docs/`)
+
+Include only specific folders/files by name (everything else is ignored):
+
+```bash
+make-folder-txt --only-folder src docs
+make-folder-txt --only-file package.json README.md
+make-folder-txt --only-folder src --only-file package.json
+```
+
+---
+
+## 🎯 Real World Examples
+
+**Sharing with an AI tool (ChatGPT, Claude, etc.):**
+
+```bash
+cd "C:\Web Development\my-app\backend"
+make-folder-txt
+# → backend.txt created, ready to paste into any AI chat
+```
+
+**On macOS / Linux:**
+
+```bash
+cd /home/user/projects/my-app
+make-folder-txt
+# → my-app.txt created
+```
+
+---
+
+## 📄 Output Format
+
+The generated `.txt` file is structured in two clear sections:
+
+```
+================================================================================
+START OF FOLDER: my-project
+================================================================================
+
+================================================================================
+PROJECT STRUCTURE
+================================================================================
+Root: C:\Web Development\my-project
+
+my-project/
+├── src/
+│   ├── controllers/
+│   │   └── userController.js
+│   ├── models/
+│   │   └── User.js
+│   └── index.js
+├── node_modules/  [skipped]
+├── package.json
+└── README.md
+
+Total files: 5
+
+================================================================================
+FILE CONTENTS
+================================================================================
+
+--------------------------------------------------------------------------------
+FILE: /src/index.js
+--------------------------------------------------------------------------------
+const express = require('express');
+...
+
+--------------------------------------------------------------------------------
+FILE: /package.json
+--------------------------------------------------------------------------------
+{
+  "name": "my-project",
+  ...
+}
+
+================================================================================
+END OF FOLDER: my-project
+================================================================================
+```
+
+---
+
+## 🚫 What Gets Skipped
+
+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`                        |
+| 📄 Output file  | The generated `foldername.txt` file (to avoid infinite loops)   |
+| 📝 .txtignore   | Any files/folders specified in `.txtignore` file               |
+
+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
+
+**Muhammad Saad Amin**
+
+---
+
+## 📝 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!
+
+</div>
+
+
+================================================================================
+END OF FOLDER: make-folder-txt
+================================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "make-folder-txt",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "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": {