Will It Vibe?
DOCS-005Info severity-2 points

Missing package.json description

Part of Documentation, UX & Accessibility, which counts for 15% of the overall score. When this check fires it deducts 2 points from that category, once per scan, no matter how many places it turns up.

What it detects

package.json has no description field, which shows up blank on npm/registry listings.

Why it matters

The description field is what npm, GitHub dependency views, and search tooling show next to your package name; when it is empty, listings render a blank line where your one-sentence pitch should be. It is also the first thing many editors and registries surface on hover. Filling it takes one line.

How to fix it

Add a "description" field to package.json: one plain sentence saying what the package or app does, no marketing language. If you publish to npm, this line is your search snippet, so lead with the concrete function ("CLI that converts CSV exports to iCal") rather than adjectives.

The paid report includes a ready-to-paste prompt for your AI coding agent for every check it finds, pointed at the exact findings from your scan. See pricing

Does your repo trip this check?

Paste a GitHub URL or drop a project folder. Scans run in your browser and take seconds.

Scan your repo

Related Documentation, UX & Accessibility checks