@reneturcios/greenlight 0.13.0 → 0.14.0

package/README.md

@@ -153,6 +153,14 @@ npx @reneturcios/greenlight ci https://github.com/reticlehq/reticle/pull/1620
 # JSON output for scripting
 npx @reneturcios/greenlight ci <pr-url> --json
 
+# CI pre-flight: run a repo's own PR checks locally before pushing (exit 1 on NO-GO)
+npx @reneturcios/greenlight ci-prep ~/work/bruno
+
+# [PASS] tests (workflow ci, job build)
+# [SKIPPED] publish (workflow release, job release) - publishes a package
+# [PASS] convention: DCO sign-off
+# Verdict: GO
+
 # Review triage for a PR with review feedback: which comments need you?
 npx @reneturcios/greenlight review https://github.com/n8n-io/n8n/pull/41235
 

package/dist/ci-prep.d.ts

@@ -0,0 +1,109 @@
+/**
+ * CI Pre-flight (`greenlight ci-prep` / MCP `ci_prep`).
+ *
+ * Answers one question with evidence, BEFORE a PR is pushed: would this
+ * repo's own pull_request workflows pass on the current tree?
+ *
+ * Pipeline:
+ *   1. DISCOVER: parse .github/workflows/*.yml for workflows triggered on
+ *      pull_request / pull_request_target; extract jobs and steps.
+ *   2. MAP + RUN (native mode): translate each step into a local check.
+ *      Steps that map to package scripts or common binaries (test, lint,
+ *      typecheck, build) are EXECUTED with a per-step timeout. Steps that
+ *      cannot run locally (deploys, secrets, external services, publishes)
+ *      are SKIPPED with the reason named. A check is never reported PASS
+ *      unless it actually ran.
+ *   3. CONVENTIONS: changeset requirement, conventional-commit subjects,
+ *      and DCO sign-off are checked against git history when the repo
+ *      signals that it requires them.
+ *   4. ACT MODE (--act): when `act` and a working docker daemon are both
+ *      present, the discovered PR workflows run through `act` for real;
+ *      otherwise the tool says so plainly and falls back to native mode.
+ *
+ * Honesty contract (same as verify.ts): this would rather say SKIPPED with
+ * a reason than report a verdict it cannot defend. Verdict is GO only
+ * when zero checks FAIL.
+ */
+export type CiPrepStatus = "PASS" | "FAIL" | "SKIPPED";
+export interface CiPrepCheck {
+    /** e.g. "test (workflow ci, job build)" or "convention: changesets". */
+    name: string;
+    kind: "workflow-step" | "convention" | "act";
+    status: CiPrepStatus;
+    /** One-line evidence: exit code, timing, or the skip reason. */
+    detail: string;
+    /** Last ~30 lines of captured output when the step was executed. */
+    outputTail?: string;
+}
+export interface CiPrepResult {
+    repoDir: string;
+    base: string | null;
+    verdict: "GO" | "NO-GO";
+    actMode: "used" | "unavailable" | "not-requested";
+    checks: CiPrepCheck[];
+    markdown: string;
+}
+export interface CiPrepOptions {
+    /** Base ref for convention checks (changesets/commits/DCO). */
+    base?: string;
+    /** Per-step execution timeout in seconds (default 300). */
+    timeoutSecs?: number;
+    /** Try act+docker; fall back to native mode when unavailable. */
+    useAct?: boolean;
+    /** Test seam: override the detected package manager. */
+    packageManager?: string;
+    /** Test seam: override act/docker detection. */
+    actAvailable?: boolean;
+}
+type YamlNode = string | number | boolean | null | YamlNode[] | {
+    [k: string]: YamlNode;
+};
+/** Parse a GitHub Actions workflow file into a plain object tree. Throws on structural problems. */
+export declare function parseWorkflowYaml(text: string): Record<string, YamlNode>;
+export interface WorkflowStep {
+    name: string;
+    uses?: string;
+    run?: string;
+    if?: string;
+    workingDirectory?: string;
+}
+export interface WorkflowJob {
+    id: string;
+    name: string;
+    steps: WorkflowStep[];
+    matrix?: string;
+}
+export interface DiscoveredWorkflow {
+    file: string;
+    jobs: WorkflowJob[];
+    /** Why this workflow was skipped entirely (unparseable, no PR trigger). */
+    skipReason?: string;
+}
+/** Does this workflow run on pull_request / pull_request_target? */
+export declare function triggersOnPullRequest(doc: Record<string, YamlNode>): boolean;
+export declare function discoverWorkflows(dir: string): DiscoveredWorkflow[];
+export type StepMapping = {
+    kind: "execute";
+    script: string;
+} | {
+    kind: "skip";
+    reason: string;
+};
+/**
+ * Decide what to do with a `run:` step. Conservative by design: anything
+ * that is not clearly a local test/lint/build invocation, or that touches
+ * secrets/publishes/deploys, becomes SKIPPED with a named reason.
+ */
+export declare function mapRunStep(script: string): StepMapping;
+export declare function mapUsesStep(uses: string): StepMapping;
+/** Push-only / main-only `if:` conditions make a step irrelevant to PRs. */
+export declare function isPushOnlyCondition(ifExpr: string): boolean;
+export declare function detectPackageManager(dir: string, override?: string): string | null;
+export declare function actAvailable(): boolean;
+export declare function runCiPrep(targetDir: string, opts?: CiPrepOptions): Promise<CiPrepResult>;
+export declare function renderCiPrepMarkdown(r: CiPrepResult): string;
+/** Human-readable console rendering (the --json flag prints the raw result). */
+export declare function formatCiPrepHuman(r: CiPrepResult): string;
+/** Ensure the tmp fixture helper can create scratch dirs outside the repo. */
+export declare function scratchDir(prefix: string): string;
+export {};