pr-checkmate 1.22.8 → 1.23.0

package/dist/core/checks/{pr-size-check.js → pr/pr-size-check.js}

@@ -1,20 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.prSizeCheck = void 0;
-const utils_1 = require("../../utils");
-const execa_1 = require("../../utils/execa");
-const types_1 = require("../types");
-const WARN_FILES = 50;
-const WARN_LINES = 1000;
+const utils_1 = require("../../../utils");
+const execa_1 = require("../../../utils/execa");
+const types_1 = require("../../types");
+const DEFAULT_MAX_FILES = 50;
+const DEFAULT_MAX_LINES = 1000;
 exports.prSizeCheck = {
     name: 'PR Size',
     phase: 'informational',
     applies(ctx) {
-        return Boolean(ctx.baseSha);
+        return ctx.config.prSize?.enabled !== false && Boolean(ctx.baseSha);
     },
     async run(ctx) {
+        const maxFiles = ctx.config.prSize?.maxFiles ?? DEFAULT_MAX_FILES;
+        const maxLines = ctx.config.prSize?.maxLines ?? DEFAULT_MAX_LINES;
         try {
-            const { stdout } = await (0, execa_1.execa)('git', ['diff', '--shortstat', ctx.baseSha, 'HEAD'], {
+            const { stdout } = await (0, execa_1.execa)('git', ['diff', '--shortstat', ctx.baseSha, ctx.headSha ?? 'HEAD'], {
                 cwd: ctx.cwd,
             });
             // "5 files changed, 123 insertions(+), 45 deletions(-)"
@@ -24,10 +26,10 @@ exports.prSizeCheck = {
             const lines = insertions + deletions;
             utils_1.logger.info(`[PR Size]: ${fileCount} files changed, ${lines} lines`);
             const issues = [];
-            if (fileCount > WARN_FILES)
-                issues.push(`${fileCount} files (recommended < ${WARN_FILES})`);
-            if (lines > WARN_LINES)
-                issues.push(`${lines} lines (recommended < ${WARN_LINES})`);
+            if (fileCount > maxFiles)
+                issues.push(`${fileCount} files (recommended < ${maxFiles})`);
+            if (lines > maxLines)
+                issues.push(`${lines} lines (recommended < ${maxLines})`);
             if (issues.length > 0) {
                 issues.forEach(i => utils_1.logger.warn(`[PR Size]: ⚠️ Large PR: ${i}`));
                 return (0, types_1.warn)(issues.join(', '));

package/dist/core/checks/{pr-title-lint.d.ts → pr/pr-title-lint.d.ts}

@@ -1,2 +1,2 @@
-import { Check } from '../types';
+import { Check } from '../../types';
 export declare const prTitleLintCheck: Check;

package/dist/core/checks/{pr-title-lint.js → pr/pr-title-lint.js}

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.prTitleLintCheck = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
-const utils_1 = require("../../utils");
-const types_1 = require("../types");
+const utils_1 = require("../../../utils");
+const types_1 = require("../../types");
 const CONVENTIONAL_PREFIX = /^(feat|fix|docs|style|refactor|test|chore|perf|ci|build|revert)(\(.+\))?!?: .+/;
 exports.prTitleLintCheck = {
     name: 'PR Title',

package/dist/core/checks/quality/case-collision.d.ts

@@ -0,0 +1,8 @@
+import { Check } from '../../types';
+/**
+ * Flags tracked files whose paths differ only by case (e.g. `Foo.ts` vs
+ * `foo.ts`). Such pairs coexist on Linux (case-sensitive) but collide on macOS/
+ * Windows and in many Docker layers, silently breaking checkouts and builds.
+ * Whole-repo scan (not delta), scoped to `sourcePath` and honouring `ignoreDirs`.
+ */
+export declare const caseCollisionCheck: Check;

package/dist/core/checks/quality/case-collision.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.caseCollisionCheck = void 0;
+const config_1 = require("../../../config");
+const utils_1 = require("../../../utils");
+const targets_1 = require("../../targets");
+const types_1 = require("../../types");
+/**
+ * Flags tracked files whose paths differ only by case (e.g. `Foo.ts` vs
+ * `foo.ts`). Such pairs coexist on Linux (case-sensitive) but collide on macOS/
+ * Windows and in many Docker layers, silently breaking checkouts and builds.
+ * Whole-repo scan (not delta), scoped to `sourcePath` and honouring `ignoreDirs`.
+ */
+exports.caseCollisionCheck = {
+    name: 'Case Collision',
+    phase: 'informational',
+    applies(ctx) {
+        return ctx.config.caseCollision?.enabled !== false;
+    },
+    async run(ctx) {
+        const files = await (0, targets_1.listTrackedFiles)(ctx, ['*'], (0, config_1.getSourcePaths)());
+        if (files.length === 0)
+            return (0, types_1.skip)('no tracked files');
+        const byLower = new Map();
+        for (const f of files) {
+            const key = f.toLowerCase();
+            let set = byLower.get(key);
+            if (!set) {
+                set = new Set();
+                byLower.set(key, set);
+            }
+            set.add(f);
+        }
+        const collisions = [...byLower.values()].filter(set => set.size > 1);
+        if (collisions.length === 0)
+            return (0, types_1.pass)();
+        collisions.forEach(set => utils_1.logger.warn(`[Case Collision]: ⚠️ ${[...set].join(' ↔ ')}`));
+        return (0, types_1.warn)(`${collisions.length} case-collision(s) — paths differing only by case`);
+    },
+};

package/dist/core/checks/quality/config-validation.d.ts

@@ -0,0 +1,8 @@
+import { Check } from '../../types';
+/**
+ * Validates pr-checkmate.json itself: warns on unknown top-level keys (typos
+ * like `mergeConfict` that silently do nothing) and on invalid values in the
+ * `severity` map. Reads the raw file so it checks what the user actually wrote,
+ * not the merged defaults. `//`-comment keys and `$schema` are ignored.
+ */
+export declare const configValidationCheck: Check;

package/dist/core/checks/quality/config-validation.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configValidationCheck = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const config_1 = require("../../../config");
+const utils_1 = require("../../../utils");
+const types_1 = require("../../types");
+const VALID_SEVERITIES = ['error', 'warn', 'off'];
+/**
+ * Validates pr-checkmate.json itself: warns on unknown top-level keys (typos
+ * like `mergeConfict` that silently do nothing) and on invalid values in the
+ * `severity` map. Reads the raw file so it checks what the user actually wrote,
+ * not the merged defaults. `//`-comment keys and `$schema` are ignored.
+ */
+exports.configValidationCheck = {
+    name: 'Config Validation',
+    phase: 'informational',
+    applies(ctx) {
+        return ctx.config.configValidation?.enabled !== false;
+    },
+    async run(ctx) {
+        const file = node_path_1.default.join(ctx.cwd, 'pr-checkmate.json');
+        let raw;
+        try {
+            raw = node_fs_1.default.readFileSync(file, 'utf-8');
+        }
+        catch {
+            return (0, types_1.skip)('no pr-checkmate.json');
+        }
+        let json;
+        try {
+            json = JSON.parse(raw);
+        }
+        catch (err) {
+            const msg = err instanceof Error ? err.message.split('\n')[0] : String(err);
+            return (0, types_1.warn)(`pr-checkmate.json is not valid JSON: ${msg}`);
+        }
+        const issues = [];
+        for (const key of Object.keys(json)) {
+            if (key.startsWith('//') || key === '$schema')
+                continue;
+            if (!config_1.KNOWN_CONFIG_KEYS.has(key))
+                issues.push(`unknown key "${key}"`);
+        }
+        const sev = json.severity;
+        if (sev && typeof sev === 'object') {
+            for (const [name, val] of Object.entries(sev)) {
+                if (!VALID_SEVERITIES.includes(val)) {
+                    issues.push(`severity["${name}"] must be error|warn|off (got ${JSON.stringify(val)})`);
+                }
+            }
+        }
+        if (issues.length === 0)
+            return (0, types_1.pass)();
+        issues.slice(0, 10).forEach(i => utils_1.logger.warn(`[Config Validation]: ⚠️ ${i}`));
+        const sample = issues.slice(0, 3).join('; ');
+        return (0, types_1.warn)(`${issues.length} config issue(s): ${sample}${issues.length > 3 ? ' …' : ''}`);
+    },
+};

package/dist/core/checks/quality/coverage.d.ts

@@ -0,0 +1,2 @@
+import { Check } from '../../types';
+export declare const coverageCheck: Check;

package/dist/core/checks/quality/coverage.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.coverageCheck = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const types_1 = require("../../types");
+const findings_1 = require("../findings");
+/**
+ * Common coverage-report locations across languages/tools. Presence of any one
+ * means the test step produced coverage. Reports are usually git-ignored, so we
+ * probe the working tree with fs, not git. A client with a non-standard path
+ * sets `coverage.reportPath`.
+ */
+const DEFAULT_REPORTS = [
+    'coverage/lcov.info', // JS/TS (lcov), C++
+    'lcov.info',
+    'coverage/coverage-final.json', // istanbul
+    'coverage/coverage-summary.json',
+    'coverage/cobertura-coverage.xml', // Cobertura (JS, Python)
+    'coverage/clover.xml',
+    'coverage.xml', // Python (pytest-cov / coverage.py)
+    'coverage.out', // Go
+    'build/reports/jacoco/test/jacocoTestReport.xml', // Kotlin/Java (Gradle)
+    'target/site/jacoco/jacoco.xml', // Java (Maven)
+];
+exports.coverageCheck = {
+    name: 'Coverage',
+    phase: 'informational',
+    /**
+     * Opt-in: only runs when a repo explicitly enables it (`coverage.enabled:
+     * true`). Presence-warning by default everywhere would be pure noise in repos
+     * that don't collect coverage — so a client turns it on to say "we produce
+     * coverage", and the check then guards against the report silently going
+     * missing (a broken `--coverage` flag, tests not running, etc.).
+     */
+    applies(ctx) {
+        return ctx.config.coverage?.enabled === true;
+    },
+    async run(ctx) {
+        const cfg = ctx.config.coverage;
+        const candidates = cfg?.reportPath
+            ? Array.isArray(cfg.reportPath)
+                ? cfg.reportPath
+                : [cfg.reportPath]
+            : DEFAULT_REPORTS;
+        const found = candidates.find(rel => {
+            try {
+                return node_fs_1.default.statSync(node_path_1.default.join(ctx.cwd, rel)).size > 0;
+            }
+            catch {
+                return false;
+            }
+        });
+        if (found)
+            return (0, types_1.pass)(`coverage report found: ${found}`);
+        const sev = (0, findings_1.severityEmitter)(cfg?.severity, 'warn');
+        sev.log(`[Coverage]: ${sev.icon} no coverage report found (looked for ${candidates.length} location(s), e.g. ${candidates.slice(0, 3).join(', ')})`);
+        return sev.emit('no coverage report found — is the test step running with coverage enabled?');
+    },
+};

package/dist/core/checks/{dead-code.d.ts → quality/dead-code.d.ts}

@@ -1,2 +1,2 @@
-import { Check } from '../types';
+import { Check } from '../../types';
 export declare const deadCodeCheck: Check;

package/dist/core/checks/{dead-code.js → quality/dead-code.js}

@@ -6,10 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deadCodeCheck = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
-const constants_1 = require("../../config/constants");
-const utils_1 = require("../../utils");
-const execa_1 = require("../../utils/execa");
-const types_1 = require("../types");
+const constants_1 = require("../../../config/constants");
+const utils_1 = require("../../../utils");
+const execa_1 = require("../../../utils/execa");
+const types_1 = require("../../types");
 exports.deadCodeCheck = {
     name: 'Dead Code',
     phase: 'informational',

package/dist/core/checks/{duplicate-check.d.ts → quality/duplicate-check.d.ts}

@@ -1,2 +1,2 @@
-import { Check } from '../types';
+import { Check } from '../../types';
 export declare const duplicateCheck: Check;

package/dist/core/checks/{duplicate-check.js → quality/duplicate-check.js}

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.duplicateCheck = void 0;
-const config_1 = require("../../config");
-const constants_1 = require("../../config/constants");
-const utils_1 = require("../../utils");
-const execa_1 = require("../../utils/execa");
-const targets_1 = require("../targets");
-const types_1 = require("../types");
+const config_1 = require("../../../config");
+const constants_1 = require("../../../config/constants");
+const utils_1 = require("../../../utils");
+const execa_1 = require("../../../utils/execa");
+const targets_1 = require("../../targets");
+const types_1 = require("../../types");
 // Always excluded regardless of client config — scanning these never yields
 // meaningful production duplication. Config files (eslint/*.config.*) are data,
 // not logic, and are commonly shipped in two formats (e.g. .eslintrc + flat

package/dist/core/checks/quality/license-header.d.ts

@@ -0,0 +1,7 @@
+import { Check } from '../../types';
+/**
+ * Requires a license/copyright header (a configured regex) in the first N lines
+ * of newly ADDED source files. Opt-in — needs `licenseHeader.pattern`; does
+ * nothing until a repo configures one. Advisory (warn).
+ */
+export declare const licenseHeaderCheck: Check;

package/dist/core/checks/quality/license-header.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.licenseHeaderCheck = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const utils_1 = require("../../../utils");
+const execa_1 = require("../../../utils/execa");
+const types_1 = require("../../types");
+/** Source extensions a license header is expected on. */
+const SOURCE_EXT = /\.(ts|tsx|js|jsx|mjs|cjs|py|kt|java|go|rs|cs|rb|php|swift|c|cc|cpp|h|hpp)$/i;
+const DEFAULT_HEADER_LINES = 10;
+/**
+ * Requires a license/copyright header (a configured regex) in the first N lines
+ * of newly ADDED source files. Opt-in — needs `licenseHeader.pattern`; does
+ * nothing until a repo configures one. Advisory (warn).
+ */
+exports.licenseHeaderCheck = {
+    name: 'License Header',
+    phase: 'informational',
+    applies(ctx) {
+        return ctx.config.licenseHeader?.enabled === true && Boolean(ctx.baseSha);
+    },
+    async run(ctx) {
+        const patternSrc = ctx.config.licenseHeader?.pattern;
+        if (!patternSrc)
+            return (0, types_1.skip)('no licenseHeader.pattern configured');
+        let header;
+        try {
+            header = new RegExp(patternSrc);
+        }
+        catch (err) {
+            utils_1.logger.warn(`[License Header]: ⚠️ invalid pattern\n${err}`);
+            return (0, types_1.skip)('invalid licenseHeader.pattern');
+        }
+        const maxLines = ctx.config.licenseHeader?.lines ?? DEFAULT_HEADER_LINES;
+        let added;
+        try {
+            const { stdout } = await (0, execa_1.execa)('git', ['diff', '--name-only', '--diff-filter=A', ctx.baseSha, ctx.headSha ?? 'HEAD'], { cwd: ctx.cwd });
+            added = stdout
+                .split('\n')
+                .filter(Boolean)
+                .filter(f => SOURCE_EXT.test(f));
+        }
+        catch (err) {
+            utils_1.logger.warn(`[License Header]: ⚠️ Could not analyze diff\n${err}`);
+            return (0, types_1.skip)('diff unavailable');
+        }
+        const missing = [];
+        for (const file of added) {
+            let head;
+            try {
+                head = node_fs_1.default
+                    .readFileSync(node_path_1.default.join(ctx.cwd, file), 'utf-8')
+                    .split('\n')
+                    .slice(0, maxLines)
+                    .join('\n');
+            }
+            catch {
+                continue; // removed/renamed between diff and read
+            }
+            if (!header.test(head))
+                missing.push(file);
+        }
+        if (missing.length === 0)
+            return (0, types_1.pass)();
+        missing.slice(0, 10).forEach(f => utils_1.logger.warn(`[License Header]: ⚠️ missing header: ${f}`));
+        if (missing.length > 10)
+            utils_1.logger.warn(`[License Header]: ⚠️ ... and ${missing.length - 10} more`);
+        return (0, types_1.warn)(`${missing.length} new source file(s) missing the license header`);
+    },
+};

package/dist/core/checks/{markdown-lint.d.ts → quality/markdown-lint.d.ts}

@@ -1,2 +1,2 @@
-import { Check } from '../types';
+import { Check } from '../../types';
 export declare const markdownLintCheck: Check;

package/dist/core/checks/{markdown-lint.js → quality/markdown-lint.js}

@@ -7,11 +7,11 @@ exports.markdownLintCheck = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_os_1 = __importDefault(require("node:os"));
 const node_path_1 = __importDefault(require("node:path"));
-const config_1 = require("../../config");
-const utils_1 = require("../../utils");
-const execa_1 = require("../../utils/execa");
-const targets_1 = require("../targets");
-const types_1 = require("../types");
+const config_1 = require("../../../config");
+const utils_1 = require("../../../utils");
+const execa_1 = require("../../../utils/execa");
+const targets_1 = require("../../targets");
+const types_1 = require("../../types");
 function loadUserMarkdownConfig(cwd) {
     const configPath = node_path_1.default.join(cwd, 'pr-checkmate.json');
     if (!node_fs_1.default.existsSync(configPath))

package/dist/core/checks/{spellcheck.d.ts → quality/spellcheck.d.ts}

@@ -1,2 +1,2 @@
-import { Check } from '../types';
+import { Check } from '../../types';
 export declare const spellcheckCheck: Check;

package/dist/core/checks/{spellcheck.js → quality/spellcheck.js}

@@ -6,11 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.spellcheckCheck = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
-const config_1 = require("../../config");
-const utils_1 = require("../../utils");
-const execa_1 = require("../../utils/execa");
-const targets_1 = require("../targets");
-const types_1 = require("../types");
+const config_1 = require("../../../config");
+const utils_1 = require("../../../utils");
+const execa_1 = require("../../../utils/execa");
+const targets_1 = require("../../targets");
+const types_1 = require("../../types");
 function loadUserCspellConfig(cwd) {
     const configPath = node_path_1.default.join(cwd, 'pr-checkmate.json');
     if (!node_fs_1.default.existsSync(configPath))

package/dist/core/checks/{diff-security.d.ts → security/diff-security.d.ts}

@@ -1,2 +1,2 @@
-import { Check } from '../types';
+import { Check } from '../../types';
 export declare const diffSecurityCheck: Check;