@deployanyway/ship-it-meter 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.2.0 — 2026-10-08
+
+- Preflight, with a parachute: `preflight(input)` returns the same score, verdict and reasons as `shipIt`, plus actionable `actions`. CLI `--checklist` includes them in text or JSON output. It uses only supplied evidence and is not a deployment guarantee.
+- Add npm and CI badges to the published README.
+
 ## 0.1.1 — 2026-10-08
 
 - Correct npm installation and npx documentation after the initial publication.

package/README.md

@@ -1,5 +1,8 @@
 # ship-it-meter
 
+[![npm version](https://img.shields.io/npm/v/%40deployanyway%2Fship-it-meter)](https://www.npmjs.com/package/@deployanyway/ship-it-meter)
+[![CI](https://github.com/DeployAnyway/ship-it-meter/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/DeployAnyway/ship-it-meter/actions/workflows/ci.yml)
+
 Explainable deployment readiness scoring for tests, coverage, and builds. Turns questionable confidence into a number.
 
 ```text
@@ -150,3 +153,17 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
 - [doggo-log](https://github.com/DeployAnyway/doggo-log)
 - [ship-it-meter](https://github.com/DeployAnyway/ship-it-meter)
 - [bro-say](https://github.com/DeployAnyway/bro-say)
+
+## Preflight, with a parachute
+
+`preflight(input)` returns the same score, verdict and reasons as `shipIt`, plus actionable `actions`. CLI `--checklist` includes them in text or JSON output. It uses only supplied evidence and is not a deployment guarantee.
+
+```sh
+npx @deployanyway/ship-it-meter --tests 125 --coverage 82 --build pass --day friday --checklist
+```
+
+API (import the named functions from this package):
+
+```js
+preflight({ tests: 125, coverage: 82, build: true, day: "friday" });
+```

package/bin/cli.js

@@ -2,7 +2,7 @@
 import { parseArgs } from "node:util";
 import { readFileSync } from "node:fs";
 import { URL } from "node:url";
-import { shipIt } from "../src/index.js";
+import { shipIt, preflight } from "../src/index.js";
 
 try {
   const { values } = parseArgs({
@@ -10,6 +10,7 @@ try {
       help: { type: "boolean", short: "h" },
       version: { type: "boolean", short: "v" },
       json: { type: "boolean" },
+      checklist: { type: "boolean" },
       tests: { type: "string" },
       failing: { type: "string" },
       coverage: { type: "string" },
@@ -23,7 +24,7 @@ try {
   });
   if (values.help) {
     console.log(
-      "Usage: ship-it-meter [options]\n\nOptions:\n  --tests number    Total tests\n  --failing number  Failing tests\n  --coverage number Coverage percent\n  --build pass|fail Build result\n  --critical number Open critical issues\n  --lint number     Lint failures\n  --dirty           Uncommitted changes\n  --branch name     Branch name\n  --day weekday     Full weekday name\n  --json            Structured output\n  -h, --help        Help\n  -v, --version     Version\n\nMissing test, coverage, and build evidence reduces readiness.\nExit codes: 0 scored successfully; 2 invalid arguments.",
+      "Usage: ship-it-meter [options]\n\nOptions:\n  --tests number    Total tests\n  --failing number  Failing tests\n  --coverage number Coverage percent\n  --build pass|fail Build result\n  --critical number Open critical issues\n  --lint number     Lint failures\n  --dirty           Uncommitted changes\n  --branch name     Branch name\n  --day weekday     Full weekday name\n  --checklist       Actionable, mildly concerned preflight\n  --json            Structured output\n  -h, --help        Help\n  -v, --version     Version\n\nMissing test, coverage, and build evidence reduces readiness.\nExit codes: 0 scored successfully; 2 invalid arguments.",
     );
   } else if (values.version) {
     console.log(
@@ -54,11 +55,11 @@ try {
     for (const key of ["day", "branch"])
       if (values[key] !== undefined) input[key] = values[key];
     if (values.dirty) input.uncommittedChanges = true;
-    const result = shipIt(input);
+    const result = values.checklist ? preflight(input) : shipIt(input);
     console.log(
       values.json
         ? JSON.stringify(result, null, 2)
-        : `${result.score}/100 — ${result.verdict}\n${result.reasons.map((reason) => `- ${reason}`).join("\n")}`,
+        : `${result.score}/100 — ${result.verdict}\n${result.reasons.map((reason) => `- ${reason}`).join("\n")}${result.actions ? "\n\nBefore you ship:\n" + result.actions.map((action) => `[ ] ${action}`).join("\n") : ""}`,
     );
   }
 } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deployanyway/ship-it-meter",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Explainable deployment readiness scoring for tests, coverage, and builds. Turns questionable confidence into a number.",
   "type": "module",
   "exports": "./src/index.js",

package/src/index.js

@@ -123,3 +123,38 @@ export function shipIt(input = {}) {
             : "Suspiciously Ready";
   return { score, verdict, reasons };
 }
+
+/** Return actionable preflight tasks alongside the existing score. */
+export function preflight(input = {}) {
+  const result = shipIt(input);
+  const actions = [];
+  if (input.build !== true)
+    actions.push("Get a passing build. Confidence is not a build artifact.");
+  if (!input.tests)
+    actions.push("Run tests and report the count. Vibes are not assertions.");
+  if (input.failingTests)
+    actions.push("Fix failing tests. Red is not a festive deployment theme.");
+  if (input.coverage === undefined || input.coverage < 80)
+    actions.push(
+      "Measure coverage and review untested paths. The bugs enjoy privacy.",
+    );
+  if (input.criticalIssues)
+    actions.push(
+      "Resolve critical issues. The incident channel deserves a quiet afternoon.",
+    );
+  if (input.lintFailures)
+    actions.push("Fix lint failures. Let the semicolons retire in peace.");
+  if (input.uncommittedChanges)
+    actions.push(
+      "Commit or stash local changes. Your laptop is not the release archive.",
+    );
+  if (input.day?.trim().toLowerCase() === "friday")
+    actions.push(
+      "Confirm rollback and on-call cover. The weekend has other plans.",
+    );
+  if (!actions.length)
+    actions.push(
+      "Confirm monitoring and rollback. Even excellent evidence needs a parachute.",
+    );
+  return { ...result, actions };
+}