npm - repomeld - Versions diffs - 2.0.3 → 2.0.5 - Mend

repomeld 2.0.3 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -2,7 +2,29 @@
 > Meld your entire repo into a single file — perfect for AI context, code reviews & sharing.
-> 💼 **Author [`susheelhbti@gmail.com`](mailto:susheelhbti@gmail.com) is open to freelance & full-time work.**
+[![npm version](https://badge.fury.io/js/repomeld.svg)](https://www.npmjs.com/package/repomeld)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+---
+> ## 💼 Open to Work
+> **The author is available for freelance & full-time work.**
+> 📧 [susheelhbti@gmail.com](mailto:susheelhbti@gmail.com) — reach out anytime!
+---
+## ✨ Features
+- 🚀 **Fast & Efficient** - Async scanning with real-time progress
+- 🎨 **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
+- 📦 **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
+- 🎯 **Force Include** - Override ignore rules when needed
 ---
@@ -12,6 +34,12 @@
 npm install -g repomeld
 ```
+Or use without installing:
+```bash
+npx repomeld
+```
 ---
 ## Quick Start
@@ -21,327 +49,410 @@ cd your-project
 repomeld
 ```
-**No flags needed.** repomeld will walk you through 7 quick questions and configure itself:
+That's it. repomeld walks your project, respects `.gitignore`, skips binary files, and writes everything into one readable file.
-```
-╔══════════════════════════════════════╗
-║          repomeld  v1.2.0            ║
-║   Meld your repo into one file 🔥   ║
-╚══════════════════════════════════════╝
-  💼 Author susheelhbti@gmail.com is open to freelance & full-time work
-  ┌─────────────────────────────────────────────────┐
-  │  Interactive setup — answer 7 quick questions   │
-  │  Press Enter to accept the [default] value      │
-  └─────────────────────────────────────────────────┘
-  📄 1/7  Output filename? [repomeld_output.txt]
-       >
-  🎨 2/7  Header style?
-         1) banner   — clear dividers with file info  (default)
-         2) markdown — great for pasting into AI prompts
-         3) minimal  — filename only, no extra formatting
-       >
-  🔍 3/7  Filter to specific file extensions?
-         e.g.  js ts php py    (leave blank = include ALL files)
-       >
-  🏗️  4/7  Enable structure-only mode? (y/n) [n]
-         Strips function bodies — keeps class names + signatures only.
-         Cuts a 400-line file to ~30 lines. Perfect for AI architecture review.
-       >
-  🔗 5/7  Generate a code review graph? (y/n) [n]
-         Adds a Mermaid call graph at the top of the output.
-         AI models read Mermaid natively — shows which files connect to which.
-       >
-  📋 6/7  Include a table of contents? (y/n) [y]
-       >
-  🧪 7/7  Dry run only? (y/n) [n]
-         Preview which files would be included without writing anything.
-       >
-```
+---
+## Auto-Numbered Output — No Overwriting
-After answering, it shows a summary and runs:
+Every time you run repomeld it creates a **new numbered file** so previous runs are never lost:
 ```
-  ┌─────────────────────────────────────────────────┐
-  │  Your configuration                              │
-  ├─────────────────────────────────────────────────┤
-  │  Output         : repomeld_output.txt            │
-  │  Style          : markdown                       │
-  │  Extensions     : php ts                         │
-  │  Structure only : yes ✅                         │
-  │  Review graph   : yes ✅                         │
-  │  Table of cont. : yes                            │
-  │  Dry run        : no                             │
-  └─────────────────────────────────────────────────┘
+repomeld_output.txt       ← first run
+repomeld_output__2.txt    ← second run
+repomeld_output__3.txt    ← third run
 ```
+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.
 ---
-## Skip the Wizard (Power Users)
+## All Options
+```
+Usage: repomeld [options]
-If you pass any flags, repomeld skips the wizard and runs directly:
+Options:
+  -V, --version                 Show version number
+  -h, --help                    Show help
-```bash
-repomeld --ext ts tsx --style markdown --output context.md
+Output:
+  -o, --output <filename>       Output file name
+                                Default: "repomeld_output.txt"
+                                Auto-numbered if the file already exists.
+Filtering:
+  -e, --ext <exts...>           Only include files with these extensions
+                                e.g.  --ext js ts jsx tsx
+  --include <patterns...>       Only include files whose path matches a pattern
+                                e.g.  --include src/
+  --exclude <patterns...>       Skip files whose path matches a pattern
+                                e.g.  --exclude test spec __tests__
+  -i, --ignore <names...>       Extra folder or file names to ignore
+                                e.g.  --ignore dist .next coverage
+  --force-include <names...>    Force-include something that would normally be ignored
+                                e.g.  --force-include vendor bootstrap
+  --max-size <kb>               Skip files larger than N kilobytes
+                                Default: 500
+  --no-gitignore                Ignore .gitignore file (include everything)
+Formatting:
+  -s, --style <style>           Header style for each file block:
+                                  banner   — clear dividers with file info  (default)
+                                  markdown — fenced code blocks, great for AI prompts
+                                  minimal  — filename only, no extra formatting
+  --no-toc                      Don't include a table of contents at the top
+  --no-meta                     Hide per-file metadata (line count, size, language)
+  --trim                        Trim leading/trailing whitespace from each file
+Advanced:
+  --lines-before <n>            Skip the first N lines of every file
+  --lines-after <n>             Skip the last N lines of every file
+  --dry-run                     Preview which files would be included — nothing is written
+  --no-backup                   Skip creating backup zip file
+  --no-update-check             Skip checking for updates
 ```
-Force the wizard at any time with:
+---
+## Examples
 ```bash
-repomeld --wizard
+# Basic — include everything, auto-numbered output
+repomeld
+# Only TypeScript files
+repomeld --ext ts tsx
+# Only files inside src/
+repomeld --include src/
+# Skip test files
+repomeld --exclude test spec __tests__
+# Markdown style — great for pasting into AI chats
+repomeld --style markdown --output context.md
+# Preview what would be included without writing anything
+repomeld --dry-run
+# Ignore extra folders on top of defaults
+repomeld --ignore coverage logs tmp
+# Respect gitignore (default) or ignore it
+repomeld --no-gitignore  # include everything
+# Only small files — skip anything over 100 KB
+repomeld --max-size 100
+# Force-include a vendor file that's normally ignored
+repomeld --force-include bootstrap
+# No table of contents, no metadata
+repomeld --no-toc --no-meta
+# Combine filters
+repomeld --ext php --include Controllers --exclude test --style markdown
+# Skip backup creation
+repomeld --no-backup
 ```
 ---
-## New Features in v1.2.0
+## Auto-Ignored by Default
-### `--structure-only` — Skeleton mode
+repomeld automatically skips these so your output stays clean:
-Extracts **class names + function signatures** from every file. Strips all body code.
+| Category        | What's skipped                                      |
+|-----------------|-----------------------------------------------------|
+| Dependencies    | `node_modules/`                                     |
+| Version control | `.git/`                                             |
+| Env / secrets   | `.env`, `.env.local`, `.env.production`             |
+| Lock files      | `package-lock.json`, `yarn.lock`, `pnpm-lock.yaml` |
+| Build output    | `dist/`, `build/`, `.next/`, `.nuxt/`, `.cache/`   |
+| OS files        | `.DS_Store`                                         |
+| repomeld output | `repomeld_output.txt` and all `repomeld_output__N.txt` files |
-```bash
-repomeld --structure-only
-```
+**Note:** `package.json` and `README.md` are **NOT** ignored by default — they contain important context for AI tools and code reviews.
+---
+## Custom Ignore Rules
+### Method 1: repomeld.ignore.json
+Create a `repomeld.ignore.json` in your project root:
-**Before** (400 lines of PHP):
-```php
-public function available(Request $request)
+```json
 {
-    $validated = $request->validate([...]);
-    $guards = SecurityGuard::with('user')
-        ->where('is_available', true)
-        ...
-    // 50 more lines
+  "ignore": [
+    "coverage",
+    "logs",
+    "tmp",
+    "*.min.js",
+    "**/generated/**"
+  ]
 }
 ```
-**After** (1 line):
-```php
-public function available(Request $request) { ... }
-```
-Supports **PHP, JavaScript, TypeScript, Python**. Other languages fall back to the first 30 lines.
+These are merged with the defaults every time repomeld runs.
-Perfect for:
-- Giving AI a full architecture overview without hitting context limits
-- Code review focusing on structure, not implementation
-- Onboarding — understand a codebase in seconds
+### Method 2: .gitignore
----
+repomeld automatically respects your `.gitignore` file. Use `--no-gitignore` to override.
-### `--review-graph` — Mermaid call graph
+### Method 3: CLI --ignore
-Generates a **Mermaid flowchart** at the top of your output showing which files import/call which.
+Override on the command line:
 ```bash
-repomeld --review-graph
+repomeld --ignore temp logs "*.tmp"
 ```
-Output (inside the file, readable by AI natively):
+---
+## Backup Zip Files
+When repomeld runs, it automatically creates a backup zip file in the `repomeld_repomeld/` folder:
-````
-```mermaid
-flowchart TD
-  %% Code Review Graph — generated by repomeld
+```
+repomeld_output.txt
+repomeld_repomeld/
+  └── repomeld_output.zip          ← contains all included files + output
-  src_index_js["📄 index.js\n[repomeld, getAllFiles, buildHeader]"]
-  src_utils_js["📄 utils.js\n[formatSize, getLanguage]"]
-  src_graph_js["📄 graph.js\n[buildReviewGraph]"]
+repomeld_output__2.txt
+repomeld_repomeld/
+  └── repomeld_output__2.zip       ← corresponding backup
-  src_index_js --> src_utils_js
-  src_index_js --> src_graph_js
+repomeld_output__3.txt
+repomeld_repomeld/
+  └── repomeld_output__3.zip       ← and so on...
 ```
-````
-AI models like Claude, GPT-4, and Gemini read Mermaid natively — no image needed.
+The zip file contains:
+- All source files included in the run (preserving folder structure)
+- The repomeld output file itself
+To disable backups: `repomeld --no-backup`
 ---
-### Power combo: both together
+## Output Format
+Each run produces a file like this:
-```bash
-repomeld --structure-only --review-graph
 ```
+# Generated by repomeld v2.0.4
+# Date     : 2025-04-23T10:00:00.000Z
+# Source   : /your/project
+# Files    : 12
+# Lines    : 847
-AI gets:
-1. **The map** — which files connect to which (graph)
-2. **The skeleton** — every class and function signature (structure)
-3. **Zero noise** — no implementation details
+TABLE OF CONTENTS
+════════════════════════════════════════════════════════════
+    1. src/index.js
+    2. src/utils.js
+    3. src/config.js
+   ...
+════════════════════════════════════════════════════════════
-This is the best way to give AI a complete understanding of a large codebase without wasting context.
+────────────────────────────────────────────────────────────
+  FILE: src/index.js  [120 lines | 3.2 KB | javascript]
+────────────────────────────────────────────────────────────
----
+... file contents ...
+```
-## Smart Auto-Ignore
-repomeld automatically skips common public libraries and vendor files.
-| Category | Examples |
-|---|---|
-| Project meta | `package.json`, `README.md`, `yarn.lock`, `.gitignore` |
-| Build output | `dist/`, `build/`, `.next/`, `.nuxt/`, `coverage/` |
-| Vendor folders | `vendor/`, `libs/`, `plugins/`, `assets/vendor/` |
-| Bootstrap | `bootstrap.min.css`, `bootstrap.bundle.min.js` |
-| jQuery | `jquery.min.js`, `jquery-ui.min.js` |
-| Font Awesome | `all.min.css`, `fontawesome-free/` |
-| Tailwind | `tailwind.min.css`, `tailwindcss/` |
-| Chart / D3 / Three | `chart.min.js`, `d3.min.js`, `three.min.js` |
-| Axios / Lodash | `axios.min.js`, `lodash.min.js` |
-| Rich text editors | `tinymce/`, `ckeditor/`, `codemirror/` |
-| Admin templates | `AdminLTE/`, `metronic/`, `coreui/` |
-| Env / Secrets | `.env`, `.env.local`, `.env.production` |
+### Markdown Style Example
----
+With `--style markdown` each file becomes a fenced code block:
-## All Options
+```markdown
+## 📄 src/index.js  [120 lines | 3.2 KB | javascript]
+```javascript
+// Your code here
 ```
-Usage: repomeld [options]
-Options:
-  -V, --version                     Show version
-  -h, --help                        Show help
-  --wizard                          Interactive step-by-step setup
-  Output:
-  -o, --output <filename>           Output file name (default: "repomeld_output.txt")
-  Filtering:
-  -e, --ext <exts...>               Only include specific extensions
-                                    e.g. --ext js ts jsx tsx
-  --include <patterns...>           Only include files matching patterns
-                                    e.g. --include src/
-  --exclude <patterns...>           Exclude files matching patterns
-                                    e.g. --exclude test spec
-  -i, --ignore <names...>           Extra folders/files to ignore
-  --force-include <names...>        Force-include files ignored by default
-  --max-size <kb>                   Skip files larger than N KB (default: 500)
-  Formatting:
-  -s, --style <style>               Header style: banner | markdown | minimal
-  --no-toc                          Disable table of contents
-  --no-meta                         Hide file metadata (lines, size, lang)
-  --trim                            Trim leading/trailing whitespace per file
-  Advanced:
-  --lines-before <n>                Skip first N lines of each file
-  --lines-after <n>                 Skip last N lines of each file
-  --dry-run                         Preview without writing output
-  AI / Code Review:
-  --structure-only                  Extract class + function signatures only (no body)
-  --review-graph                    Prepend a Mermaid call graph to the output
+## 📄 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!
-## Examples
+### Minimal Style Example
-```bash
-# Wizard mode (auto when no flags given)
-repomeld
+With `--style minimal`:
-# Force wizard even with flags
-repomeld --wizard
+```
+# src/index.js
+your code here
-# Only PHP controllers, structure only
-repomeld --ext php --include Controllers --structure-only
+# src/utils.js
+more code here
+```
-# Full code + call graph
-repomeld --review-graph
+---
-# Best for AI: skeleton + graph, markdown style
-repomeld --structure-only --review-graph --style markdown --output ai_context.md
+## Performance
-# Only TypeScript inside src/
-repomeld --ext ts tsx --include src/
+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
-# Exclude tests
-repomeld --exclude test spec __tests__
+Example output:
+```
+🔍 Scanning files...
+✅ Found 2453 files in 1.2s
-# Dry run — preview only
-repomeld --dry-run
+📝 Processing 2453 files...
-# Large repo: structure only, skip files over 100 KB
-repomeld --structure-only --max-size 100
+  [1245/2453] files (50.7%) | 2.3s elapsed | ETA: 2s
+  ✅ Completed 2453/2453 files in 4.7s
 ```
 ---
-## Output Format
+## Use Cases
-### With `--review-graph`
+### 🤖 AI Context Preparation
+```bash
+repomeld --ext js ts jsx py --style markdown --max-size 200
+```
+### 📋 Code Review
+```bash
+repomeld --include src/ --exclude test --style minimal --no-meta
 ```
-# Generated by repomeld v1.2.0
-# Date     : 2024-01-01T00:00:00.000Z
-# Source   : /your/project
-# Files    : 8
-# Lines    : 312
-# Graph    : review-graph enabled
-# Author   : susheelhbti@gmail.com (open to work)
-════════════════════════════════════════════════════════════
-  CODE REVIEW GRAPH
-════════════════════════════════════════════════════════════
+### 💾 Full Project Backup
+```bash
+repomeld --force-include . --max-size 10000 --no-toc --no-meta
+```
-```mermaid
-flowchart TD
-  ...
+### 📚 Documentation Generation
+```bash
+repomeld --ext md --include docs --style markdown --output documentation.md
 ```
-TABLE OF CONTENTS
-...
+### 🔍 Debug Specific Feature
+```bash
+repomeld --include feature-name --ext js css --output feature-context.txt
 ```
-### With `--structure-only` (PHP example)
+---
-```php
-namespace App\Http\Controllers;
-use App\Models\SecurityGuard;
-use App\Models\SecurityRequest;
+## FAQ
-class GuardController extends Controller
-{
-    /** Get guard's own profile */
-    public function profile() { ... }
-    public function updateProfile(Request $request) { ... }
-    public function bookings() { ... }
-    public function available(Request $request) { ... }
-    public function toggleAvailability() { ... }
-    public function rate(Request $request, $id) { ... }
-}
-```
+**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.
+**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.
 ---
-## Publish / Update
+## Development
 ```bash
-npm version patch   # 1.2.0 → 1.2.1
-npm publish
+# Clone the repo
+git clone https://github.com/susheel/repomeld.git
+cd repomeld
+# Install dependencies
+npm install
+# Run locally
+npm start -- --dry-run
+# Link for global testing
+npm link
+repomeld --help
 ```
 ---
 ## Contributing
-Found a popular library that should be in the ignore list? Open a PR!
+Contributions are welcome! Please feel free to submit a Pull Request.
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing`)
+5. Open 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
-MIT
+MIT © [Susheel](mailto:susheelhbti@gmail.com)
+---
+## Support & Contact
+- 🐛 **Issues**: [GitHub Issues](https://github.com/susheel/repomeld/issues)
+- 📧 **Email**: [susheelhbti@gmail.com](mailto:susheelhbti@gmail.com)
+- 💼 **Hire Me**: Available for freelance and full-time opportunities
+---
+> ## 💼 Hire the Author
+> Built by a developer available for **freelance and full-time opportunities**.
+> Got a project? Let's talk — 📧 **[susheelhbti@gmail.com](mailto:susheelhbti@gmail.com)**
+---
+## Star History
+[![Star History Chart](https://api.star-history.com/svg?repos=susheel/repomeld&type=Date)](https://star-history.com/#susheel/repomeld&Date)
 ---
-> 💼 **Looking to hire?** The author [`susheelhbti@gmail.com`](mailto:susheelhbti@gmail.com) is available for freelance and full-time work.
+**Made with ❤️ for developers who need better context for AI tools**