{"id":29625343,"url":"https://github.com/manjunani/propcreep","last_synced_at":"2025-07-21T06:35:52.896Z","repository":{"id":295265139,"uuid":"989564148","full_name":"manjunani/PropCreep","owner":"manjunani","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-24T15:48:21.000Z","size":844,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-24T15:50:02.722Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manjunani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-24T11:04:13.000Z","updated_at":"2025-05-24T15:48:24.000Z","dependencies_parsed_at":"2025-05-24T15:50:08.902Z","dependency_job_id":null,"html_url":"https://github.com/manjunani/PropCreep","commit_stats":null,"previous_names":["manjunani/propcreep"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/manjunani/PropCreep","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manjunani%2FPropCreep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manjunani%2FPropCreep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manjunani%2FPropCreep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manjunani%2FPropCreep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manjunani","download_url":"https://codeload.github.com/manjunani/PropCreep/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manjunani%2FPropCreep/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266253862,"owners_count":23900056,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-21T06:35:48.396Z","updated_at":"2025-07-21T06:35:52.885Z","avatar_url":"https://github.com/manjunani.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 PropCreep Insight\n\n\u003e 🔎 A fast, offline-first React component explorer with built-in AI docgen superpowers — like Storybook met VS Code's tree view and got real.\n\n---\n\n## 📦 TL;DR\n\n```bash\n# Basic static docgen\nnpx propcreep-insight --input ./src --output ./docs\n\n# Default (static) with viewer\nnpx propcreep-insight --view\n\n# OpenAI mode\nnpx propcreep-insight --ai openai --openai-key sk-abc123 --view\n\n# Gemini mode\nnpx propcreep-insight --ai gemini --gemini-key gem-abc123 --view\n```\n\n- 🧩 Visualizes component structure  \n- 📜 Generates static docs with prop metadata  \n- 📊 Shows per-component size insights  \n- 🧬 Mermaid-powered component trees  \n- 🤖 Optional GPT/Gemini doc generation  \n- 🛠 Works 100% offline (unless AI is enabled)\n\n---\n\n## 🎯 Why PropCreep?\n\n| Feature                   | ✅ PropCreep Insight | 🧸 Storybook | 📦 Bundle Analyzer |\n|---------------------------|----------------------|--------------|--------------------|\n| 🗂 Component Tree Viewer   | ✅ Yes                | ❌ No         | ❌ No               |\n| 📜 Static Docgen           | ✅ Built-in           | ❌ Separate   | ❌ N/A              |\n| ⚡ File Size + Weight      | ✅ Yes                | ❌ No         | ✅ Yes              |\n| 🔁 AI-Generated Comments   | ✅ GPT/Gemini (opt-in)| ❌            | ❌                  |\n| 📈 Mermaid Graph Output    | ✅ Yes                | ❌ No         | ❌ No               |\n| 🛠 Works Offline           | ✅ Yes                | ❌            | ✅ Mostly           |\n\n---\n\n## 📥 Install \u0026 Use\n\n```bash\nnpm install -g propcreep-insight\n# or just run directly\nnpx propcreep-insight --input ./src --output ./docs --view\n```\n\nOutputs:\n\n- `components.json`\n- `component-tree.json`\n- `component-tree.mmd`\n- 📁 Self-contained viewer at `./propcreep-report/`\n\n---\n\n## 🧠 AI Doc Generation (Optional)\n\n```bash\n# OpenAI\nOPENAI_API_KEY=sk-xxx npx propcreep-insight --ai openai\n\n# Gemini\nGEMINI_API_KEY=xxx npx propcreep-insight --ai gemini\n```\n\nOr use a `.env` file:\n\n```env\nPROP_AI_MODE=gemini\nOPENAI_API_KEY=sk-xxx\nGEMINI_API_KEY=gem-xxx\n```\n\n---\n\n## 🖼 Viewer UI (Static Site)\n\nAfter generation, you’ll get:\n\n```\npropcreep-report/\n├── index.html\n├── assets/\n└── data/\n    ├── components.json\n    └── component-tree.json\n```\n\n### Launch locally\n\n```bash\nnpx propcreep-insight --view\n# or manually:\nnpx serve ./propcreep-report -l 5173 -s\n```\n\n---\n\n## 📈 Mermaid Graph\n\nFrom `component-tree.mmd`:\n\n```mermaid\ngraph TD\nroot--\u003ecomponents\ncomponents--\u003eButton\ncomponents--\u003eHeader\n```\n\n---\n\n## 🔧 CLI Flags\n\n| Flag             | Description                                 | Default          |\n|------------------|---------------------------------------------|------------------|\n| `--input` / `-i` | Input component directory                   | `./src`          |\n| `--output` / `-o`| Output folder for JSON/docs                 | `./docs`         |\n| `--ai`           | `openai`, `gemini`, or omit for static mode | `static`         |\n| `--openai-key`   | OpenAI API key                              | from `.env`      |\n| `--gemini-key`   | Gemini API key                              | from `.env`      |\n| `--view` / `-v`  | Launch the UI viewer after generation       | `false`          |\n\n---\n\n## 🧪 Local Dev (Viewer)\n\n```bash\ncd ui\nnpm install\nnpm run dev\n```\n\nTo test viewer with actual data:\n\n```bash\ncp -r ../docs ui/public/data\n```\n\nThen open [http://localhost:5173](http://localhost:5173)\n\n---\n\n## 💬 Feedback \u0026 Contributions\n\nHave ideas or bugs?\n\n- Submit feedback: [GitHub Issues](hhttps://github.com/manjunani/PropCreep/issues)\n- Or open a PR — we welcome contributions 🙌\n\n---\n\n## ✅ Roadmap\n\n- [x] Component tree generation  \n- [x] Static docgen  \n- [x] Mermaid graph export  \n- [x] File size analysis  \n- [x] AI-enhanced docgen (GPT/Gemini)  \n- [ ] Component churn tracking  \n- [ ] PR comment bot integration  \n- [ ] Markdown export for GitHub READMEs  \n\n---\n\n## 🧠 Powered By\n\n- React  \n- Babel parser  \n- Mermaid.js  \n- OpenAI + Gemini  \n- Commander.js  \n- fs-extra + globby  \n\n---\n\n## 🧙 About the Creator\n\n**PropCreep Insight** is built by [Manjunatha Sai Uppu](https://github.com/manjunani) with ❤️ to help frontend engineers stay fast, informed, and in control of their codebase.\n\n\u003e If you love it, ⭐ star it, share it, and send your feedback.\n\n---\n\n## 📜 License\n\nMIT — [LICENSE](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanjunani%2Fpropcreep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanjunani%2Fpropcreep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanjunani%2Fpropcreep/lists"}