check-pr-readiness

Run typecheck, lint, format, and tests on JavaScript/TypeScript branch diffs.

22|3|Updated Jul 28, 2024
One-click install
npx skills add https://github.com/webdevcody/go-mailing-list --skill check-pr-readiness-webdevcody
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-pr-readiness
Source: https://github.com/webdevcody/go-mailing-list/tree/main/.claude/skills/check-pr-readiness
Command: npx skills add https://github.com/webdevcody/go-mailing-list --skill check-pr-readiness-webdevcody

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents low-quality or risky pull requests from being merged by systematically validating only the changes between your branch and the chosen base commit.

Core Features & Use Cases

  • Diff-scoped preflight: Fixes the base ref and changed-file set so checks reflect exactly what you’re about to submit.
  • Deterministic gate sequence: Runs typecheck, lint, format, then tests in order, stopping immediately on the first failure to reduce noise.
  • Residue sweep: Flags risky “left behind” additions (like newly introduced console.log, .only/.skip, debugger, TODO/FIXME in changed lines, and large/binary additions) and reports them clearly.

Use case: Before opening or finalizing a PR, validate that new code typechecks, conforms to lint/format standards, passes tests, and doesn’t include accidental debugging statements or TODOs introduced by the changes.

Quick Start

Run the check-pr-readiness skill against your current branch to produce a PR readiness verdict with the exact commands and any failing files.

Frequently Asked Questions about check-pr-readiness

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I run a pre-PR check on my branch diff to catch typecheck, lint, and test failures?

Run a PR readiness check to validate your branch diff against a fixed base commit, executing typecheck, lint, format, and tests sequentially while stopping immediately on the first failure to reduce noise.

Can I automatically detect debugging residue like console.log or debugger statements in my changed lines before opening a pull request?

Yes, a residue sweep flags risky left-behind additions in changed source lines, including newly introduced console.log, .only, .skip, debugger statements, and TODO or FIXME markers before opening a pull request.

Does this PR readiness check work with my JavaScript and TypeScript project setup?

Yes, it applies to JavaScript and TypeScript projects by detecting available tooling directly from your package.json and optional configurations, then executing concrete commands without guessing.

What is the best way to prevent risky code with large or binary files from being merged via a pull request?

A PR gauntlet prevents risky code from being merged by performing a residue sweep that flags large or binary additions in your changed files, reporting them clearly alongside standard formatting and lint failures.

How does diff-scoped preflight ensure pull request checks only validate my new code?

Diff-scoped preflight fixes the base ref and changed-file set so pull request readiness checks reflect exactly the code you are about to submit, validating only the changes between your branch and the base commit.

Why does my PR readiness check stop after the first linting or formatting failure?

The deterministic gate sequence runs typecheck, lint, format, and tests in order, stopping immediately on the first failure to reduce noise and report the exact failing files without running subsequent checks.