repo-roast

Roast your repository, then turn the joke into a practical quality checklist.

npx @hevman/repo-roast

Example output:

repo-roast

my-app
Score: 72/100

Roast:
This repo ships, but it also trusts vibes where a checklist would cost less emotional damage.

Findings:
x ERROR No test script
  package.json has no scripts.test.
! WARNING Thin README
  README exists, but it is too short to sell or explain the project.

Next fixes:
1. Add a test script, even if it starts with a tiny smoke test.
2. Expand README so a stranger can use the project in under one minute.

Why

Most project audits are boring. Most jokes are useless. repo-roast tries to land in the useful middle: it gives you a shareable roast, a score and a short list of fixes that actually improve the repo.

It checks for:

• missing or thin README,
• missing license,
• missing test script,
• missing GitHub Actions workflow,
• weak npm metadata,
• TODO/FIXME pileups,
• large source files,
• possible committed secrets.

Install

npm install -D @hevman/repo-roast

CLI

repo-roast
repo-roast --path ../my-project
repo-roast --json
repo-roast --strict

--strict exits with code 1 when the score is below 80, which makes it usable in CI.

Library

import { analyzeRepo, formatReport } from "@hevman/repo-roast";

const report = await analyzeRepo({ root: process.cwd() });
console.log(formatReport(report));

Publishing

npm test
npm pack --dry-run
npm publish --access public

License

MIT