Package Exports

pr-checkmate
pr-checkmate/dist/cli.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pr-checkmate) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🔍 PR CheckMate

PR CheckMate is an npm package for automating Pull Request checks.
It helps teams maintain code quality by automatically validating linting, formatting, dependencies, and spelling before merging to main.

⚡ Why PR CheckMate?

✅ Automatic checks on every PR without extra setup.
✅ No need to install ESLint, Prettier, or cspell in your project — all included.
✅ Enforces a unified code style across repositories.
✅ Checks package.json / package-lock.json for dependency changes.
✅ Spellcheck for code, documentation, and JSON files.
✅ Package Vulnerabilities Check
✅ Scans for secrets using

> ⚠️ **Note:** Currently, PR CheckMate only supports **Node.js projects**.

🛠 How It Works

1. Install

npm install --save-dev pr-checkmate

2. Initialize

npx pr-checkmate init

This creates a pr-checkmate.json config file, where you can specify the source code path.

3. Run Checks

npx pr-checkmate <job>

⚡ Jobs

Job	Description
`all`	Run all checks: ESLint, dependency check, Prettier, spellcheck
`lint`	Lint code using ESLint
`prettier`	Format code using Prettier
`deps`	Check project dependencies
`security`	Run security scan for secrets
`spellcheck`	Run spellcheck via cspell
`audit`	Run `npm audit --audit-level=moderate` to check for vulnerable packages

📦 Example GitHub Actions Workflow

name: PR CheckMate Quality Checks

on:
  pull_request:

jobs:
  pr-checks:
    runs-on: ubuntu-latest
    steps:
      - name: 📥 Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
        
      - name: 🔧 Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
        
      - name: 📦 Install project dependencies
        run: npm ci
      
      - name: 🔍 Run PR CheckMate
        run: npx pr-checkmate all

Fully automated process: no need to install ESLint, Prettier, or cspell in your repository.

📌 Benefits

✅ Self-contained — the package handles all checks internally
✅ Works locally and in CI/CD (GitHub Actions, GitLab CI, etc.)
✅ Enforces a unified code style across repositories
✅ Automatic formatting and commits when needed
✅ Minimal setup — just init and npx pr-checkmate all

🧰 Tech Stack

Node.js 20 — executes CLI scripts
TypeScript — fully typed code
ESLint + @typescript-eslint — code linting
Prettier — auto-formatting
cspell — spellchecking
execa — running CLI commands from Node.js

pr-checkmate