@saismrutiranjan18/why-slow 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,125 @@
+# why-slow
+
+> Diagnose why your Node.js project is slow — in seconds.
+
+`why-slow` is a zero-config CLI tool that scans your project and gives you an instant performance report: large source files, oversized images, circular dependencies, and unused packages.
+
+---
+
+## Installation
+
+```bash
+# Run instantly without installing
+npx @saismrutiranjan18/why-slow
+
+# Or install globally
+npm install -g @saismrutiranjan18/why-slow
+```
+
+---
+
+## Usage
+
+```bash
+# Run in any project directory
+why-slow
+
+# Generate an HTML report
+why-slow --html
+
+# Show help
+why-slow --help
+```
+
+---
+
+## What it checks
+
+| Check | What it flags |
+|---|---|
+|  **Large Source Files** | `.js/.ts/.jsx/.tsx` files over **200 KB** |
+|  **Large Images** | Images over **500 KB** (png, jpg, webp, svg) |
+|  **Circular Dependencies** | Modules that import each other in a loop |
+|  **Unused Dependencies** | Packages in `package.json` not used in code |
+|  **node_modules Size** | Total size of your installed dependencies |
+
+---
+
+## Example Output
+
+```
+WHY-SLOW v1.1
+────────────────────────────────────
+
+i Largest Source Files
+✓ No oversized source files found
+
+i Image Analysis
+! public/banner.png (1.2 MB)
+
+i Circular Dependencies
+✖ src/utils/format.js → src/helpers/date.js → src/utils/format.js
+
+i Unused Dependencies
+! lodash
+! moment
+
+i Dependencies
+i node_modules size: 214.5 MB
+
+────────────────────────────────────
+
+Performance Summary
+
+i Large Files: 0
+i Large Images: 1
+i Circular Dependencies: 1
+i Unused Dependencies: 2
+
+! Performance Score: 79/100
+
+────────────────────────────────────
+
+Scan completed successfully.
+```
+
+---
+
+## HTML Report
+
+Run with `--html` to generate a `performance-report.html` file in your project root — a clean, shareable report with all findings.
+
+```bash
+why-slow --html
+```
+
+---
+
+## Performance Score
+
+Your project gets a score out of **100**:
+
+| Issue | Penalty |
+|---|---|
+| Each large source file | −5 pts |
+| Each large image | −5 pts |
+| Each circular dependency | −10 pts |
+| Each unused dependency | −2 pts |
+
+| Score | Rating |
+|---|---|
+| 90–100 |  Great |
+| 70–89 |  Needs attention |
+| 0–69 |  Action required |
+
+---
+
+## Requirements
+
+- Node.js **18+**
+
+---
+
+## License
+
+MIT © [saismrutiranjan18](https://github.com/saismrutiranjan18)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saismrutiranjan18/why-slow",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "CLI tool to diagnose why your Node.js project is slow — scans for large files, oversized images, circular dependencies, and unused packages.",
   "type": "module",
   "bin": {
@@ -36,4 +36,4 @@
     "fs-extra": "^11.3.5",
     "madge": "^8.0.0"
   }
-}
+}