shipproof 0.1.0 → 0.2.0

package/README.es.md

@@ -6,6 +6,13 @@
   Comprobaciones sin configuración para saber si un proyecto creado con ayuda de IA está listo para publicarse.
 </p>
 
+<p align="center">
+  <a href="https://github.com/CalvaryBloom/shipproof/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/CalvaryBloom/shipproof/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://www.npmjs.com/package/shipproof"><img alt="versión en npm" src="https://img.shields.io/npm/v/shipproof?logo=npm&color=cb3837"></a>
+  <a href="https://www.npmjs.com/package/shipproof"><img alt="descargas en npm" src="https://img.shields.io/npm/dm/shipproof?logo=npm"></a>
+  <a href="LICENSE"><img alt="Licencia MIT" src="https://img.shields.io/badge/license-MIT-22c55e"></a>
+</p>
+
 <p align="center">
   <a href="README.md">English</a> · Español
 </p>
@@ -62,6 +69,29 @@ npx shipproof --no-fail
 
 Por defecto, ShipProof termina con código `1` si encuentra al menos un problema bloqueante y con código `2` cuando la entrada no es válida. Los avisos reducen la puntuación, pero no cambian el código de salida.
 
+## GitHub Action
+
+Añade ShipProof a tus pull requests sin instalar ni configurar nada en el repositorio:
+
+```yaml
+name: ShipProof
+
+on: pull_request
+
+permissions:
+  contents: read
+
+jobs:
+  readiness:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: CalvaryBloom/shipproof@v0.2.0
+        id: shipproof
+```
+
+La acción añade al resumen del workflow la puntuación y los hallazgos que requieren atención. Por defecto falla si encuentra un problema bloqueante; usa `fail-on-issues: false` para obtener solo un informe. Los pasos posteriores pueden consultar los outputs `score`, `readiness`, `warnings` y `failed`.
+
 ## Puntuación
 
 Cada comprobación aplicable tiene un peso explícito. Un resultado correcto obtiene todo el peso, un aviso obtiene la mitad y un fallo no obtiene puntos.
@@ -89,10 +119,10 @@ ShipProof no tiene dependencias en tiempo de ejecución. TypeScript y las declar
 
 ## Próximos objetivos
 
-- Acción de GitHub con un resumen compacto para cada pull request.
 - Umbrales configurables mediante `shipproof.config.json`.
 - Comprobaciones más profundas para Python, Rust y Go.
 - Salida SARIF compatible con el análisis de código de GitHub.
+- Comentarios opcionales en pull requests con la evolución de la puntuación.
 - Catálogo público de comprobaciones y falsos positivos conocidos.
 - Publicación automatizada y con procedencia verificable para las próximas versiones.
 

package/README.md

@@ -8,6 +8,8 @@
 
 <p align="center">
   <a href="https://github.com/CalvaryBloom/shipproof/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/CalvaryBloom/shipproof/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://www.npmjs.com/package/shipproof"><img alt="npm version" src="https://img.shields.io/npm/v/shipproof?logo=npm&color=cb3837"></a>
+  <a href="https://www.npmjs.com/package/shipproof"><img alt="npm downloads" src="https://img.shields.io/npm/dm/shipproof?logo=npm"></a>
   <a href="LICENSE"><img alt="MIT License" src="https://img.shields.io/badge/license-MIT-22c55e"></a>
   <img alt="Node 22.13+" src="https://img.shields.io/badge/node-%3E%3D22.13-339933">
 </p>
@@ -81,6 +83,29 @@ shipproof [path] [options]
 
 By default, ShipProof exits with code `1` when at least one blocking issue is found and `2` for invalid input. This makes it useful in continuous integration. Warnings lower the score but do not change the exit code.
 
+## GitHub Action
+
+Add ShipProof to pull requests without installing or configuring anything in the repository:
+
+```yaml
+name: ShipProof
+
+on: pull_request
+
+permissions:
+  contents: read
+
+jobs:
+  readiness:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: CalvaryBloom/shipproof@v0.2.0
+        id: shipproof
+```
+
+The action writes a compact score and its actionable findings to the workflow summary. It fails the job when a blocking issue is found; set `fail-on-issues: false` to use it as an advisory check. The outputs `score`, `readiness`, `warnings`, and `failed` are available to later steps.
+
 ## Scoring
 
 Each applicable check has an explicit weight. Passing earns the full weight, a warning earns half, and a failure earns none.
@@ -108,10 +133,10 @@ ShipProof has no runtime dependencies. TypeScript and its Node.js declarations a
 
 ## Roadmap
 
-- GitHub Action with a compact pull-request summary.
 - Configurable thresholds through `shipproof.config.json`.
 - Deeper Python, Rust, and Go checks.
 - SARIF output for GitHub code scanning.
+- Optional pull-request comments with score changes.
 - A public check catalog with evidence and false-positive guidance.
 - Automated trusted publishing with provenance for future releases.
 

package/dist/src/action.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=action.d.ts.map

package/dist/src/action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/action.ts"],"names":[],"mappings":""}

package/dist/src/action.js

@@ -0,0 +1,55 @@
+import { appendFileSync, statSync } from "node:fs";
+import { resolve } from "node:path";
+import { analyzeProject } from "./analyze.js";
+import { renderGitHubSummary } from "./reporters/github.js";
+import { renderTerminal } from "./reporters/terminal.js";
+function input(name, fallback) {
+    const value = process.env[`INPUT_${name.toUpperCase()}`]?.trim();
+    return value ? value : fallback;
+}
+function booleanInput(name, fallback) {
+    const value = input(name, String(fallback)).toLowerCase();
+    if (value !== "true" && value !== "false") {
+        throw new Error(`Input '${name}' must be either 'true' or 'false'.`);
+    }
+    return value === "true";
+}
+function appendEnvironmentFile(path, values) {
+    if (!path)
+        return;
+    const content = Object.entries(values)
+        .map(([name, value]) => `${name}=${value}`)
+        .join("\n");
+    appendFileSync(path, `${content}\n`, "utf8");
+}
+function main() {
+    const workspace = process.env.GITHUB_WORKSPACE ?? process.cwd();
+    const targetInput = input("PATH", ".");
+    const failOnIssues = booleanInput("FAIL-ON-ISSUES", true);
+    const target = resolve(workspace, targetInput);
+    if (!statSync(target).isDirectory()) {
+        throw new Error(`Cannot analyze '${targetInput}': the target is not a directory.`);
+    }
+    const result = analyzeProject(target);
+    process.stdout.write(renderTerminal(result, false));
+    const summaryPath = process.env.GITHUB_STEP_SUMMARY;
+    if (summaryPath)
+        appendFileSync(summaryPath, `${renderGitHubSummary(result)}\n`, "utf8");
+    appendEnvironmentFile(process.env.GITHUB_OUTPUT, {
+        score: result.score,
+        readiness: result.readiness,
+        warnings: result.summary.warnings,
+        failed: result.summary.failed,
+    });
+    if (failOnIssues && result.summary.failed > 0)
+        process.exitCode = 1;
+}
+try {
+    main();
+}
+catch (error) {
+    const message = error instanceof Error ? error.message : "Unexpected action failure.";
+    process.stderr.write(`ShipProof action: ${message}\n`);
+    process.exitCode = 2;
+}
+//# sourceMappingURL=action.js.map

package/dist/src/action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","sourceRoot":"","sources":["../../src/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,SAAS,KAAK,CAAC,IAAY,EAAE,QAAgB;IAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;IACjE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AAClC,CAAC;AAED,SAAS,YAAY,CAAC,IAAY,EAAE,QAAiB;IACnD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC1D,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,qCAAqC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,KAAK,KAAK,MAAM,CAAC;AAC1B,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAwB,EAAE,MAAuC;IAC9F,IAAI,CAAC,IAAI;QAAE,OAAO;IAClB,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SACnC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,KAAK,EAAE,CAAC;SAC1C,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,cAAc,CAAC,IAAI,EAAE,GAAG,OAAO,IAAI,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,IAAI;IACX,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAChE,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvC,MAAM,YAAY,GAAG,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAE/C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,mBAAmB,WAAW,mCAAmC,CAAC,CAAC;IACrF,CAAC;IAED,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAEpD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IACpD,IAAI,WAAW;QAAE,cAAc,CAAC,WAAW,EAAE,GAAG,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEzF,qBAAqB,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE;QAC/C,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ;QACjC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM;KAC9B,CAAC,CAAC;IAEH,IAAI,YAAY,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACtE,CAAC;AAED,IAAI,CAAC;IACH,IAAI,EAAE,CAAC;AACT,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,4BAA4B,CAAC;IACtF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,OAAO,IAAI,CAAC,CAAC;IACvD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC"}

package/dist/src/analyze.d.ts

@@ -1,4 +1,4 @@
 import type { AnalysisResult } from "./types.js";
-export declare const SHIPPROOF_VERSION = "0.1.0";
+export declare const SHIPPROOF_VERSION = "0.2.0";
 export declare function analyzeProject(target: string): AnalysisResult;
 //# sourceMappingURL=analyze.d.ts.map

package/dist/src/analyze.js

@@ -1,6 +1,6 @@
 import { resolve } from "node:path";
 import { runReadinessChecks } from "./checks/readiness.js";
-export const SHIPPROOF_VERSION = "0.1.0";
+export const SHIPPROOF_VERSION = "0.2.0";
 const scoreFactors = {
     pass: 1,
     warn: 0.5,

package/dist/src/reporters/github.d.ts

@@ -0,0 +1,3 @@
+import type { AnalysisResult } from "../types.js";
+export declare function renderGitHubSummary(result: AnalysisResult): string;
+//# sourceMappingURL=github.d.ts.map

package/dist/src/reporters/github.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"github.d.ts","sourceRoot":"","sources":["../../../src/reporters/github.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAA0B,MAAM,aAAa,CAAC;AAoB1E,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,CAuBlE"}

package/dist/src/reporters/github.js

@@ -0,0 +1,35 @@
+const statusLabels = {
+    pass: "Pass",
+    warn: "Warning",
+    fail: "Failed",
+    info: "Info",
+};
+const readinessLabels = {
+    ready: "Ready to ship",
+    close: "Almost ready",
+    "work-needed": "Needs work",
+    "not-ready": "Not ready",
+};
+function markdownCell(value) {
+    return value.replaceAll("\\", "\\\\").replaceAll("|", "\\|").replace(/\r?\n/g, " ");
+}
+export function renderGitHubSummary(result) {
+    const findings = result.checks.filter((check) => check.status === "warn" || check.status === "fail");
+    const lines = [
+        `## ShipProof: ${result.score}/100`,
+        "",
+        `**${readinessLabels[result.readiness]}** · ${result.summary.passed} passed · ${result.summary.warnings} warnings · ${result.summary.failed} failed`,
+        "",
+    ];
+    if (findings.length === 0) {
+        lines.push("No blocking issues or warnings were found.");
+        return lines.join("\n");
+    }
+    lines.push("| Status | Check | Finding |", "| --- | --- | --- |");
+    for (const check of findings) {
+        const finding = check.suggestion ? `${check.message} Suggested fix: ${check.suggestion}` : check.message;
+        lines.push(`| ${statusLabels[check.status]} | ${markdownCell(check.title)} | ${markdownCell(finding)} |`);
+    }
+    return lines.join("\n");
+}
+//# sourceMappingURL=github.js.map

package/dist/src/reporters/github.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"github.js","sourceRoot":"","sources":["../../../src/reporters/github.ts"],"names":[],"mappings":"AAEA,MAAM,YAAY,GAAgC;IAChD,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,SAAS;IACf,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,MAAM;CACb,CAAC;AAEF,MAAM,eAAe,GAA8B;IACjD,KAAK,EAAE,eAAe;IACtB,KAAK,EAAE,cAAc;IACrB,aAAa,EAAE,YAAY;IAC3B,WAAW,EAAE,WAAW;CACzB,CAAC;AAEF,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AACtF,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,MAAsB;IACxD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IACrG,MAAM,KAAK,GAAG;QACZ,iBAAiB,MAAM,CAAC,KAAK,MAAM;QACnC,EAAE;QACF,KAAK,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,MAAM,CAAC,OAAO,CAAC,MAAM,aAAa,MAAM,CAAC,OAAO,CAAC,QAAQ,eAAe,MAAM,CAAC,OAAO,CAAC,MAAM,SAAS;QACpJ,EAAE;KACH,CAAC;IAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;QACzD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,8BAA8B,EAAE,qBAAqB,CAAC,CAAC;IAClE,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,mBAAmB,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;QACzG,KAAK,CAAC,IAAI,CACR,KAAK,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,YAAY,CAAC,OAAO,CAAC,IAAI,CAC9F,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipproof",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Zero-config release readiness checks for AI-assisted projects.",
   "type": "module",
   "bin": {
@@ -45,7 +45,7 @@
     "build": "tsc -p tsconfig.json",
     "check": "tsc -p tsconfig.json --noEmit",
     "lint": "tsc -p tsconfig.json --noEmit",
-    "test": "pnpm build && node --test dist/test/analyze.test.js",
+    "test": "pnpm build && node --test dist/test/analyze.test.js dist/test/github-action.test.js",
     "start": "node dist/src/cli.js"
   }
 }