repomeld 2.0.5 → 3.0.1

package/README.md

@@ -15,16 +15,18 @@
 
 ## ✨ Features
 
-- 🚀 **Fast & Efficient** - Async scanning with real-time progress
+- 🚀 **Fast & Efficient** - Async scanning with real-time progress and binary caching
 - 🎨 **Multiple Styles** - Banner, Markdown, or Minimal output
 - 🔍 **Smart Filtering** - Extension, pattern, and size-based filtering
 - 📁 **Gitignore Support** - Respects your .gitignore rules automatically
-- 💾 **Binary Detection** - Intelligently skips binary files
+- 💾 **Binary Detection** - Intelligent caching for binary file detection
 - 📦 **Single File Output** - Perfect for AI context windows
 - 🔄 **Auto-Numbering** - Never overwrites existing files
-- 💿 **Zip Backup** - Creates timestamped backups of all included files
-- 🔔 **Update Notifications** - Know when new versions are available
+- 💿 **Zip Backup** - Creates auto-numbered backups in `repomeld_zips/` folder
+- 🔔 **Update Notifications** - Non-intrusive version checking
 - 🎯 **Force Include** - Override ignore rules when needed
+- 📊 **Dependency Graph** - Optional Mermaid diagram of file dependencies
+- 🌍 **Cross-Platform** - Works perfectly on Windows, macOS, and Linux
 
 ---
 
@@ -49,7 +51,7 @@ cd your-project
 repomeld
 ```
 
-That's it. repomeld walks your project, respects `.gitignore`, skips binary files, and writes everything into one readable file.
+That's it. repomeld walks your project, respects `.gitignore`, skips binary files, and writes everything into one readable file with optional dependency graphs.
 
 ---
 
@@ -61,9 +63,13 @@ Every time you run repomeld it creates a **new numbered file** so previous runs
 repomeld_output.txt       ← first run
 repomeld_output__2.txt    ← second run
 repomeld_output__3.txt    ← third run
+repomeld_zips/            ← backup folder
+  ├── repomeld_output.zip
+  ├── repomeld_output__2.zip
+  └── repomeld_output__3.zip
 ```
 
-All previous output files are also **automatically excluded** from the next run's content — so you'll never get repomeld's own output included inside itself.
+All previous output files and zips are **automatically excluded** from the next run — so you'll never get repomeld's own output included inside itself.
 
 ---
 
@@ -191,16 +197,20 @@ repomeld automatically skips these so your output stays clean:
 
 ### Method 1: repomeld.ignore.json
 
-Create a `repomeld.ignore.json` in your project root:
+Create a `repomeld.ignore.json` in your project root for comprehensive ignore patterns:
 
 ```json
 {
+  "_comment": "repomeld.ignore.json — auto-ignored files and folders",
   "ignore": [
     "coverage",
     "logs",
     "tmp",
     "*.min.js",
-    "**/generated/**"
+    "**/generated/**",
+    "vendor/**/bootstrap*",
+    "**/jquery*",
+    "**/fontawesome*"
   ]
 }
 ```
@@ -223,19 +233,19 @@ repomeld --ignore temp logs "*.tmp"
 
 ## Backup Zip Files
 
-When repomeld runs, it automatically creates a backup zip file in the `repomeld_repomeld/` folder:
+When repomeld runs, it automatically creates a backup zip file in the `repomeld_zips/` folder:
 
 ```
 repomeld_output.txt
-repomeld_repomeld/
+repomeld_zips/
   └── repomeld_output.zip          ← contains all included files + output
 
 repomeld_output__2.txt
-repomeld_repomeld/
+repomeld_zips/
   └── repomeld_output__2.zip       ← corresponding backup
 
 repomeld_output__3.txt
-repomeld_repomeld/
+repomeld_zips/
   └── repomeld_output__3.zip       ← and so on...
 ```
 
@@ -246,74 +256,18 @@ The zip file contains:
 To disable backups: `repomeld --no-backup`
 
 ---
+ 
 
-## Output Format
-
-Each run produces a file like this:
-
-```
-# Generated by repomeld v2.0.4
-# Date     : 2025-04-23T10:00:00.000Z
-# Source   : /your/project
-# Files    : 12
-# Lines    : 847
-
-TABLE OF CONTENTS
-════════════════════════════════════════════════════════════
-    1. src/index.js
-    2. src/utils.js
-    3. src/config.js
-   ...
-════════════════════════════════════════════════════════════
-
-────────────────────────────────────────────────────────────
-  FILE: src/index.js  [120 lines | 3.2 KB | javascript]
-────────────────────────────────────────────────────────────
-
-... file contents ...
-```
-
-### Markdown Style Example
-
-With `--style markdown` each file becomes a fenced code block:
-
-```markdown
-## 📄 src/index.js  [120 lines | 3.2 KB | javascript]
-
-```javascript
-// Your code here
-```
-
-## 📄 src/utils.js  [45 lines | 1.1 KB | javascript]
-
-```javascript
-// More code here
-```
-```
-
-Perfect for pasting directly into Claude, ChatGPT, Cursor, or any AI tool!
-
-### Minimal Style Example
-
-With `--style minimal`:
-
-```
-# src/index.js
-your code here
-
-# src/utils.js
-more code here
-```
-
----
-
-## Performance
+## Performance Optimizations
 
 repomeld is optimized for large codebases:
-- Async file scanning (non-blocking)
-- Real-time progress indicator with ETA
-- Memory-efficient streaming
-- Handles repos with 10,000+ files easily
+
+- **Async file scanning** - Non-blocking operations
+- **Binary caching** - Extension-based detection cache
+- **Real-time progress** - Shows ETA and completion percentage
+- **Memory efficient** - Processes files in streams
+- **Smart filtering** - Early filtering to reduce processing
+- **Handles 50,000+ files** - Tested on large monorepos
 
 Example output:
 ```
@@ -322,8 +276,13 @@ Example output:
 
 📝 Processing 2453 files...
 
-  [1245/2453] files (50.7%) | 2.3s elapsed | ETA: 2s
-  ✅ Completed 2453/2453 files in 4.7s
+  Processing: 1245/2453 files (50.7%) | 2.3s elapsed
+  Processing: ✅ Completed 2453/2453 files in 4.7s
+```
+
+**Memory warning** for extremely large repos (>20,000 files):
+```
+⚠️ Large repository detected (~25347 files). Memory usage may be high.
 ```
 
 ---
@@ -355,29 +314,15 @@ repomeld --ext md --include docs --style markdown --output documentation.md
 repomeld --include feature-name --ext js css --output feature-context.txt
 ```
 
----
-
-## FAQ
-
-**Q: Why are package.json and README.md included now?**  
-A: They were removed in early versions but added back because they provide essential context for AI tools and code reviewers.
-
-**Q: How do I ignore package.json?**  
-A: Add it to `repomeld.ignore.json` or use `--ignore package.json`
-
-**Q: Can I use this in CI/CD?**  
-A: Yes! Use `--no-update-check` and `--no-backup` for automated environments.
-
-**Q: Does it work on Windows?**  
-A: Yes! Paths are normalized for cross-platform compatibility.
+### 🗺️ Dependency Analysis
+```bash
+repomeld --include src --style markdown --output analysis.md
+# Then render the Mermaid graph in the output
+```
 
-**Q: How do I get just the file list without content?**  
-A: Use `--dry-run` to preview without writing.
+---
 
-**Q: My binary files are being included?**  
-A: repomeld uses intelligent binary detection. If something slips through, use `--ext` to filter specific extensions.
 
----
 
 ## Development
 
@@ -395,8 +340,14 @@ npm start -- --dry-run
 # Link for global testing
 npm link
 repomeld --help
+
+# Run tests
+npm test
 ```
 
+---
+
+
 ---
 
 ## Contributing
@@ -411,23 +362,7 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 
 ---
 
-## Changelog
-
-### v2.0.4 (Current)
-- ✅ Added gitignore support with `ignore` package
-- ✅ Added zip backup feature (`repomeld_repomeld/` folder)
-- ✅ Added update notifications (non-intrusive)
-- ✅ Improved performance with async operations
-- ✅ Added progress indicator with ETA
-- ✅ Fixed Windows path compatibility
-- ✅ Improved binary detection
-- ✅ Added force-include for override scenarios
-- ✅ Removed `package.json` and `README.md` from default ignores
 
-### v1.0.0
-- Initial release with basic functionality
-
----
 
 ## License
 
@@ -455,4 +390,4 @@ MIT © [Susheel](mailto:susheelhbti@gmail.com)
 
 ---
 
-**Made with ❤️ for developers who need better context for AI tools**
+**Made with ❤️ for developers who need better context for AI tools**