npm-regret/README.md

AI-powered dependency analyzer

<h1 align="center">npm-regret</h1>

> AI-powered dependency analyzer – unused, missing, outdated + witty AI feedback.

![npm_regret banner](https://raw.githubusercontent.com/intojhanurag/npm-regret/refs/heads/main/Gemini_Generated_Image_fn9di9fn9di9fn9.jpeg)

## Install / Run

Run directly in your project directory:

```bash
npx npm-regret
```

Optionally enable AI feedback (Groq):

```bash
export GROQ_API_KEY=your_key_here
npx npm-regret
```

## What it does

- Finds unused dependencies by scanning imports/require/dynamic imports
- Flags missing dependencies used in code but not installed
- Lists outdated dependencies via `npm outdated --json`
- Sends a summary to Groq LLM for concise, witty guidance

## Notes / Caveats

- This is a static scan; false positives can happen (e.g., runtime `require` paths, plugin resolvers).
- Node core modules like `fs`/`path` may appear as missing in certain edge cases when scanning this repo; ignore core modules in your interpretation.

## CI

- GitHub Actions run tests on pushes and PRs to `main`.
- GitHub Pages deploys the static site in `website/`.

## Development

```bash
npm i
npm test
npm start
```

## Maintainers
- Anurag Ojha: [@ojhaverse](https://x.com/ojhaverse23)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT – see [LICENSE](LICENSE).