@workstarlab/release-readiness

A fast, dependency-free baseline check for Node.js repositories. It catches missing release hygiene before a handoff or deployment: documentation, license, CI, lockfile, scripts, runtime metadata and obvious unignored environment files.

This is a deterministic preflight tool, not a security audit, compliance certification or substitute for tests and human review.

Run without installing

npx @workstarlab/release-readiness .

Use machine-readable output in CI, or fail on warnings as well as errors:

npx @workstarlab/release-readiness . --json
npx @workstarlab/release-readiness . --strict

Library

import { inspectRepository } from "@workstarlab/release-readiness";

const report = await inspectRepository(process.cwd());
if (!report.ready) {
  console.error(report.checks.filter((check) => check.status === "fail"));
}

The CLI exits with status 1 when required checks fail. --strict also treats warnings as a failing result.

What it checks

• valid package.json and common package metadata;
• repeatable build, test, type/static-check and lint/format scripts;
• README, license, security policy and dependency lockfile;
• a GitHub Actions workflow and .gitignore;
• obvious .env variants that exist without an explicit ignore rule.

The environment-file check is intentionally narrow and never reads or prints secret values.

Development

npm install
npm run verify

Requires Node.js 20 or newer. Licensed under MIT.