pr-checkmate 1.21.0 → 1.21.2

package/dist/scripts/pr-summary.js

@@ -0,0 +1,119 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runPrSummary = runPrSummary;
+const utils_1 = require("../utils");
+const result_collector_1 = require("../utils/result-collector");
+const node_fs_1 = __importDefault(require("node:fs"));
+const STATUS_ICON = {
+    pass: '✅',
+    warn: '⚠️',
+    fail: '❌',
+    skip: '⏭️',
+};
+// Unique marker so we can find and update the comment on re-runs
+const COMMENT_MARKER = '<!-- pr-checkmate-summary -->';
+function getPrContext() {
+    const token = process.env.GITHUB_TOKEN;
+    const repository = process.env.GITHUB_REPOSITORY;
+    const eventPath = process.env.GITHUB_EVENT_PATH;
+    if (!token || !repository || !eventPath || !node_fs_1.default.existsSync(eventPath)) {
+        return null;
+    }
+    try {
+        const event = JSON.parse(node_fs_1.default.readFileSync(eventPath, 'utf-8'));
+        const prNumber = event?.pull_request?.number;
+        if (!prNumber)
+            return null;
+        const [owner, repo] = repository.split('/');
+        return { token, owner, repo, prNumber };
+    }
+    catch {
+        return null;
+    }
+}
+function buildMarkdownReport(results) {
+    const { passed, warned, failed, skipped } = result_collector_1.resultCollector.getSummary();
+    const rows = results
+        .map(r => {
+        const icon = STATUS_ICON[r.status];
+        const details = r.details ? ` — ${r.details}` : '';
+        return `| ${r.name} | ${icon} ${r.status}${details} |`;
+    })
+        .join('\n');
+    return [
+        COMMENT_MARKER,
+        '## 🔍 PR CheckMate Summary',
+        '',
+        `**${passed} passed** · **${warned} warnings** · **${failed} failed** · **${skipped} skipped**`,
+        '',
+        '| Check | Result |',
+        '|---|---|',
+        rows,
+        '',
+        '_Generated by [PR CheckMate](https://www.npmjs.com/package/pr-checkmate)_',
+    ].join('\n');
+}
+async function upsertGithubComment(body) {
+    const ctx = getPrContext();
+    if (!ctx) {
+        utils_1.logger.info('[runPrSummary]: Skipping GitHub comment (not in PR context or GITHUB_TOKEN missing)');
+        return;
+    }
+    const { token, owner, repo, prNumber } = ctx;
+    const apiBase = `https://api.github.com/repos/${owner}/${repo}`;
+    const headers = {
+        Authorization: `Bearer ${token}`,
+        'User-Agent': 'pr-checkmate',
+        Accept: 'application/vnd.github.v3+json',
+        'Content-Type': 'application/json',
+    };
+    try {
+        // Look for an existing pr-checkmate comment to update (avoids spam on repeated pushes)
+        const listRes = await fetch(`${apiBase}/issues/${prNumber}/comments`, { headers });
+        if (listRes.ok) {
+            const comments = (await listRes.json());
+            const existing = comments.find(c => typeof c.body === 'string' && c.body.includes(COMMENT_MARKER));
+            if (existing) {
+                await fetch(`${apiBase}/issues/comments/${existing.id}`, {
+                    method: 'PATCH',
+                    headers,
+                    body: JSON.stringify({ body }),
+                });
+                utils_1.logger.info('[runPrSummary]: ✅ Updated PR CheckMate comment on PR');
+                return;
+            }
+        }
+        // No existing comment — post a new one
+        await fetch(`${apiBase}/issues/${prNumber}/comments`, {
+            method: 'POST',
+            headers,
+            body: JSON.stringify({ body }),
+        });
+        utils_1.logger.info('[runPrSummary]: ✅ Posted PR CheckMate summary comment to PR');
+    }
+    catch (err) {
+        utils_1.logger.warn(`[runPrSummary]: ⚠️ Could not post GitHub comment: ${err}`);
+    }
+}
+async function runPrSummary() {
+    const results = result_collector_1.resultCollector.getResults();
+    if (results.length === 0)
+        return;
+    const { passed, warned, failed, skipped } = result_collector_1.resultCollector.getSummary();
+    utils_1.logger.info('');
+    utils_1.logger.info('═══════════════════════════════════════════════════════════════');
+    utils_1.logger.info('  PR CheckMate Summary');
+    utils_1.logger.info('═══════════════════════════════════════════════════════════════');
+    for (const r of results) {
+        const icon = STATUS_ICON[r.status];
+        const details = r.details ? `: ${r.details}` : '';
+        utils_1.logger.info(`  ${icon}  ${r.name}${details}`);
+    }
+    utils_1.logger.info('───────────────────────────────────────────────────────────────');
+    utils_1.logger.info(`  ✅ ${passed} passed  ⚠️ ${warned} warnings  ❌ ${failed} failed  ⏭️ ${skipped} skipped`);
+    utils_1.logger.info('═══════════════════════════════════════════════════════════════');
+    await upsertGithubComment(buildMarkdownReport(results));
+}

package/dist/scripts/typecheck.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runTypecheck = runTypecheck;
+const execa_1 = require("execa");
+const utils_1 = require("../utils");
+const loader_1 = require("../config/loader");
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+async function runTypecheck() {
+    const cfg = (0, loader_1.loadProjectConfig)();
+    if (cfg.typecheck?.enabled === false) {
+        utils_1.logger.info('[runTypecheck]: Disabled in pr-checkmate.json, skipping');
+        return;
+    }
+    utils_1.logger.info('[runTypecheck]: Running TypeScript type check...');
+    const tsConfigPath = node_path_1.default.join(process.cwd(), 'tsconfig.json');
+    if (!node_fs_1.default.existsSync(tsConfigPath)) {
+        utils_1.logger.info('[runTypecheck]: No tsconfig.json found, skipping');
+        return;
+    }
+    const result = await (0, execa_1.execa)('npx', ['tsc', '--noEmit'], { reject: false });
+    if (result.exitCode !== 0) {
+        const output = [result.stdout, result.stderr].filter(Boolean).join('\n');
+        const errorCount = (output.match(/error TS\d+/g) ?? []).length;
+        utils_1.logger.warn(`[runTypecheck]: ⚠️ TypeScript found ${errorCount} type error(s):`);
+        if (output)
+            utils_1.logger.warn(output);
+        throw new Error(`TypeScript: ${errorCount} type error(s)`);
+    }
+    utils_1.logger.info('[runTypecheck]: ✅ TypeScript type check passed');
+}

package/dist/utils/index.js

@@ -22,6 +22,7 @@ const node_fs_1 = __importDefault(require("node:fs"));
 const logger_1 = require("./logger");
 __exportStar(require("./logger"), exports);
 __exportStar(require("./delta"), exports);
+__exportStar(require("./result-collector"), exports);
 function cleanupTempFile(filePath) {
     try {
         if (node_fs_1.default.existsSync(filePath)) {

package/dist/utils/result-collector.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resultCollector = void 0;
+class ResultCollector {
+    constructor() {
+        this.results = [];
+    }
+    register(name, status, details) {
+        const idx = this.results.findIndex(r => r.name === name);
+        const entry = { name, status, ...(details && { details }) };
+        if (idx >= 0) {
+            this.results[idx] = entry;
+        }
+        else {
+            this.results.push(entry);
+        }
+    }
+    getResults() {
+        return [...this.results];
+    }
+    clear() {
+        this.results = [];
+    }
+    getSummary() {
+        return {
+            passed: this.results.filter(r => r.status === 'pass').length,
+            warned: this.results.filter(r => r.status === 'warn').length,
+            failed: this.results.filter(r => r.status === 'fail').length,
+            skipped: this.results.filter(r => r.status === 'skip').length,
+        };
+    }
+}
+exports.resultCollector = new ResultCollector();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.21.0",
+    "version": "1.21.2",
     "description": "Automated PR quality checks: linting, formatting, dependency analysis, and spellcheck",
     "keywords": [
         "github-actions",
@@ -26,6 +26,7 @@
         ".eslintignore",
         "cspell.json",
         "src/config/pr-checkmate-workflow.yml",
+        ".markdownlint.json",
         "LICENSE"
     ],
     "scripts": {
@@ -73,6 +74,8 @@
         "eslint-plugin-prettier": "^5.5.4",
         "execa": "^9.6.0",
         "gitleaks-secret-scanner-fixed": "^2.1.3",
+        "jscpd": "^3.5.10",
+        "markdownlint-cli": "^0.45.0",
         "inquirer": "^13.0.1",
         "prettier": ">=3.0.0",
         "ts-node": "^10.9.1",

package/src/config/pr-checkmate-workflow.yml

@@ -242,3 +242,112 @@ jobs:
       - name: Check Outdated Dependencies
         run: npx pr-checkmate outdated
         continue-on-error: true
+
+  markdown-lint:
+    name: Markdown Lint
+    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 dependencies
+        run: npm ci
+
+      - name: Run Markdown Lint
+        run: npx pr-checkmate markdown
+        continue-on-error: true
+
+  typecheck:
+    name: TypeScript Type Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run TypeScript Type Check
+        run: npx pr-checkmate typecheck
+        continue-on-error: true
+
+  diff-smell:
+    name: Diff Code Smell
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Scan Diff for Code Smells
+        run: npx pr-checkmate diff-smell
+        continue-on-error: true
+
+  pr-body:
+    name: PR Description
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check PR Description
+        run: npx pr-checkmate pr-body
+        continue-on-error: true
+
+  duplicate-check:
+    name: Duplicate Code
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check for Duplicate Code
+        run: npx pr-checkmate duplicate
+        continue-on-error: true