🧼 log-cleaner-cli

A CLI tool to clean debug logs like console.log, logger.debug, or print() from your source files. Perfect for tidying up before code reviews, production releases, or CI workflows.

---

✨ What This Tool Does

It automatically finds and removes debug logs like:

console.log("something");     // JavaScript
logger.debug("info");         // Logging libs
print("hello")                // Python

So you don’t have to go line-by-line manually cleaning them.

---

🚀 Features

• ✅ Clean console.log, logger.debug, print(), or custom regex
• 🛡 Dry-run mode for safe previews
• 🧾 Config support via .logcleanerrc.json
• 📂 Ignore folders using .logcleanerignore or config
• 🔍 Git-style diffs for visual clarity
• 📝 Cleanup reports with line counts
• 🗃 Backup files before editing

---

🪄 Quick Setup

1. Install it (if not done already)

Open your terminal and run:

npm install -g log-cleaner-cli

This installs the CLI tool globally so you can use it like any command.

---

2. Navigate to your project folder

Say your project is in:

D:\MyProjects\awesome-app

Then do:

cd D:\MyProjects\awesome-app

---

3. Run a quick dry-run to see what gets cleaned

log-cleaner --dry-run --path ./src

• --dry-run means: preview changes, don’t touch files
• --path ./src tells it to look inside the src folder

---

4. Actually clean your logs

Once you're happy with the preview:

log-cleaner --path ./src --mode delete

• --mode delete removes log lines
• Or use --mode comment to just comment them out

---

💡 Usage (More Examples)

Clean logs from .js files in ./src:

log-cleaner --path ./src --ext .js

Dry-run with Git-style preview:

log-cleaner --dry-run --diff --path ./src

Use config file:

// .logcleanerrc.json
{
  "path": "./src",
  "mode": "comment",
  "ext": [".js", ".ts"],
  "dryRun": true,
  "report": true,
  "backup": true,
  "ignore": ["node_modules", "dist"]
}

Then run:

log-cleaner

---

🔍 Diff Preview Example

- console.log("debug value");
+ // console.log("debug value");

---

📄 Cleanup Report

Generates log-cleaner-report.txt with info:

log-cleaner report - 4 Jul 2025
Target: ./src
Mode: comment
Extensions: .js, .ts

src/main.ts | 4 lines | Mode: comment
src/util.js | 2 lines | Mode: comment

---

🧪 Local Dev Setup

npm link
log-cleaner --dry-run --diff --path ./sample-folder

---

📁 Project Structure

log-cleaner-cli/
├─ bin/
│  └─ index.js         # CLI entry
├─ lib/
│  └─ cleaner.js       # Core logic
├─ .logcleanerrc.json  # Optional config
├─ .logcleanerignore   # Ignore folders
├─ sample-folder/      # Test files

---

🙌 Author

Made with ☕ and clean code vibes by Srinithi

---

📜 License

MIT