pr-checkmate 1.22.8 → 1.23.1

package/dist/scripts/copy-configs.js

@@ -17,6 +17,7 @@ const configFiles = [
     { source: 'src/config/cspell.json', dest: 'cspell.json' },
     { source: 'tsconfig.json', dest: 'tsconfig.json' },
     { source: 'src/config/pr-checkmate-workflow.yml', dest: 'dist/config/pr-checkmate-workflow.yml' },
+    { source: 'src/config/pr-checkmate.schema.json', dest: 'pr-checkmate.schema.json' },
 ];
 /**
  *

package/dist/utils/detect-language.d.ts

@@ -1,4 +1,4 @@
-export type Language = 'typescript' | 'javascript' | 'python' | 'cpp' | 'swift' | 'kotlin';
+export type Language = 'typescript' | 'javascript' | 'python' | 'cpp' | 'swift' | 'kotlin' | 'go' | 'rust' | 'csharp' | 'ruby' | 'php';
 /**
  * Detects which languages a repository uses, combining marker files (definitive)
  * with tracked source-file counts (breadth). A language is reported when it has a

package/dist/utils/detect-language.js

@@ -7,6 +7,7 @@ exports.detectLanguages = detectLanguages;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const execa_1 = require("./execa");
+const glob_1 = require("./glob");
 const logger_1 = require("./logger");
 /**
  * Marker files that unambiguously indicate a language's presence, independent of
@@ -26,6 +27,13 @@ const MARKER_FILES = {
         'settings.gradle.kts',
         'AndroidManifest.xml',
     ],
+    go: ['go.mod'],
+    rust: ['Cargo.toml'],
+    // Glob markers (`*.csproj`/`*.sln`) — matched against root dir entries, since
+    // C# projects have no single fixed marker filename.
+    csharp: ['*.csproj', '*.sln'],
+    ruby: ['Gemfile', '.rubocop.yml'],
+    php: ['composer.json'],
 };
 /**
  * Source extensions per language, used to count tracked files via `git ls-files`.
@@ -37,9 +45,25 @@ const EXTENSIONS = {
     cpp: ['.cpp', '.cc', '.cxx', '.c++', '.hpp', '.hh', '.hxx'],
     swift: ['.swift'],
     kotlin: ['.kt', '.kts', '.java'],
+    go: ['.go'],
+    rust: ['.rs'],
+    csharp: ['.cs'],
+    ruby: ['.rb', '.rake'],
+    php: ['.php'],
 };
 function hasMarker(root, lang) {
-    return MARKER_FILES[lang].some(name => node_fs_1.default.existsSync(node_path_1.default.join(root, name)));
+    return MARKER_FILES[lang].some(name => {
+        if (!name.includes('*'))
+            return node_fs_1.default.existsSync(node_path_1.default.join(root, name));
+        // Glob marker (e.g. `*.csproj`): match against root-directory entries.
+        try {
+            const re = (0, glob_1.globToRegExp)(name);
+            return node_fs_1.default.readdirSync(root).some(entry => re.test(entry));
+        }
+        catch {
+            return false;
+        }
+    });
 }
 /**
  * Counts tracked files per language using `git ls-files`. Returns an empty map
@@ -54,6 +78,11 @@ async function countTrackedFiles(root) {
         cpp: 0,
         swift: 0,
         kotlin: 0,
+        go: 0,
+        rust: 0,
+        csharp: 0,
+        ruby: 0,
+        php: 0,
     };
     try {
         const { stdout } = await (0, execa_1.execa)('git', ['ls-files'], { cwd: root });
@@ -87,7 +116,7 @@ async function detectLanguages(root = process.cwd()) {
     const counts = await countTrackedFiles(root);
     const detected = Object.keys(EXTENSIONS).filter(lang => hasMarker(root, lang) || counts[lang] > 0);
     detected.sort((a, b) => counts[b] - counts[a]);
-    logger_1.logger.info(`[detectLanguages]: Detected ${detected.length ? detected.join(', ') : 'none'} ` +
-        `(counts: ts=${counts.typescript}, js=${counts.javascript}, py=${counts.python}, cpp=${counts.cpp}, swift=${counts.swift}, kt=${counts.kotlin})`);
+    const countStr = Object.keys(counts).map(l => `${l}=${counts[l]}`).join(', ');
+    logger_1.logger.info(`[detectLanguages]: Detected ${detected.length ? detected.join(', ') : 'none'} (counts: ${countStr})`);
     return detected;
 }

package/dist/utils/glob.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Minimal glob → RegExp for path matching against config patterns. Supports `*`
+ * (matches within a path segment), `**` (across segments), and a leading `** /`
+ * that also matches the repo root (zero segments). Anchored to the whole path.
+ * Not a full glob implementation — enough for the allow/ignore lists in
+ * pr-checkmate.json (e.g. "assets/**", "*.png", "** / *.d.ts").
+ */
+export declare function globToRegExp(glob: string): RegExp;
+/** True when `file` matches any of the glob `patterns`. */
+export declare function matchesAnyGlob(file: string, patterns: string[]): boolean;

package/dist/utils/glob.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.globToRegExp = globToRegExp;
+exports.matchesAnyGlob = matchesAnyGlob;
+/**
+ * Minimal glob → RegExp for path matching against config patterns. Supports `*`
+ * (matches within a path segment), `**` (across segments), and a leading `** /`
+ * that also matches the repo root (zero segments). Anchored to the whole path.
+ * Not a full glob implementation — enough for the allow/ignore lists in
+ * pr-checkmate.json (e.g. "assets/**", "*.png", "** / *.d.ts").
+ */
+function globToRegExp(glob) {
+    const re = glob
+        .replace(/[.+^${}()|[\]\\]/g, '\\$&') // escape regex specials (not * or /)
+        .replace(/\*\*\//g, ' dir ') // `**/` → optional leading dirs (matches root too)
+        .replace(/\*\*/g, ' any ') // bare `**` → across segments
+        .replace(/\*/g, '[^/]*') // `*` → within a segment
+        .replace(/ dir /g, '(?:.*/)?')
+        .replace(/ any /g, '.*');
+    return new RegExp(`^${re}$`);
+}
+/** True when `file` matches any of the glob `patterns`. */
+function matchesAnyGlob(file, patterns) {
+    return patterns.some(p => globToRegExp(p).test(file));
+}

package/dist/utils/index.d.ts

@@ -3,6 +3,8 @@ export * from './result-collector';
 export * from './resolve-bin';
 export * from './own-deps';
 export * from './detect-language';
+export * from './glob';
+export * from './update-notifier';
 /**
  *
  */

package/dist/utils/index.js

@@ -25,6 +25,8 @@ __exportStar(require("./result-collector"), exports);
 __exportStar(require("./resolve-bin"), exports);
 __exportStar(require("./own-deps"), exports);
 __exportStar(require("./detect-language"), exports);
+__exportStar(require("./glob"), exports);
+__exportStar(require("./update-notifier"), exports);
 /**
  *
  */

package/dist/utils/update-notifier.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Best-effort check for a newer published version. Returns the notice lines when
+ * an update exists, or `null` (up-to-date, offline, timed out, or opted out).
+ * Non-blocking and fully silent on any failure: short timeout, swallowed errors,
+ * opt-out via `PR_CHECKMATE_NO_UPDATE_CHECK`. Returns lines instead of logging so
+ * the caller can print them at the very end — after the summary — where they're
+ * noticeable. Deliberately called ONLY from the CLI (not `runChecks`) so
+ * programmatic consumers (e.g. a wrapping SDK) never trigger a network call.
+ */
+export declare function getUpdateNotice(timeoutMs?: number): Promise<string[] | null>;

package/dist/utils/update-notifier.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUpdateNotice = getUpdateNotice;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+/** Compare dotted versions; true when `latest` is strictly greater than `current`. */
+function isNewer(latest, current) {
+    const a = latest.split('.').map(n => parseInt(n, 10) || 0);
+    const b = current.split('.').map(n => parseInt(n, 10) || 0);
+    for (let i = 0; i < 3; i++) {
+        if ((a[i] ?? 0) !== (b[i] ?? 0))
+            return (a[i] ?? 0) > (b[i] ?? 0);
+    }
+    return false;
+}
+/**
+ * Best-effort check for a newer published version. Returns the notice lines when
+ * an update exists, or `null` (up-to-date, offline, timed out, or opted out).
+ * Non-blocking and fully silent on any failure: short timeout, swallowed errors,
+ * opt-out via `PR_CHECKMATE_NO_UPDATE_CHECK`. Returns lines instead of logging so
+ * the caller can print them at the very end — after the summary — where they're
+ * noticeable. Deliberately called ONLY from the CLI (not `runChecks`) so
+ * programmatic consumers (e.g. a wrapping SDK) never trigger a network call.
+ */
+async function getUpdateNotice(timeoutMs = 2500) {
+    if (process.env.PR_CHECKMATE_NO_UPDATE_CHECK)
+        return null;
+    try {
+        const pkgPath = node_path_1.default.resolve(__dirname, '../..', 'package.json');
+        const pkg = JSON.parse(node_fs_1.default.readFileSync(pkgPath, 'utf-8'));
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), timeoutMs);
+        let latest;
+        try {
+            const res = await fetch(`https://registry.npmjs.org/${encodeURIComponent(pkg.name)}/latest`, {
+                signal: controller.signal,
+            });
+            if (res.ok)
+                latest = (await res.json()).version;
+        }
+        finally {
+            clearTimeout(timer);
+        }
+        if (latest && isNewer(latest, pkg.version)) {
+            return [
+                `⬆️  A new version of ${pkg.name} is available: ${pkg.version} → ${latest}`,
+                `    Update:  npm install ${pkg.name}@latest`,
+                '    Details: https://www.npmjs.com/package/pr-checkmate',
+            ];
+        }
+        return null;
+    }
+    catch {
+        // Best-effort only — never let an update check slow or break a run.
+        return null;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.22.8",
+    "version": "1.23.1",
     "description": "Automated PR quality checks: linting, formatting, dependency analysis, and spellcheck",
     "keywords": [
         "github-actions",
@@ -34,6 +34,7 @@
         ".prettierrc",
         "cspell.json",
         "src/config/pr-checkmate-workflow.yml",
+        "pr-checkmate.schema.json",
         ".markdownlint.json",
         "gitleaks.toml",
         "LICENSE"

package/pr-checkmate.schema.json

@@ -0,0 +1,166 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "PR CheckMate configuration",
+  "description": "Config for pr-checkmate. Unknown keys are reported by the Config Validation check.",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "$schema": { "type": "string" },
+    "sourcePath": {
+      "description": "Directory (or directories) checks are scoped to. Defaults to '.'.",
+      "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }]
+    },
+    "ignoreDirs": {
+      "description": "Directory names excluded from every check.",
+      "type": "array",
+      "items": { "type": "string" }
+    },
+    "severity": {
+      "description": "Universal per-check severity override, keyed by the check's display name.",
+      "type": "object",
+      "additionalProperties": { "enum": ["error", "warn", "off"] }
+    },
+    "customRules": {
+      "description": "User-defined regex rules run against the diff.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name", "pattern"],
+        "properties": {
+          "name": { "type": "string" },
+          "pattern": { "type": "string" },
+          "message": { "type": "string" },
+          "severity": { "enum": ["error", "warn"] },
+          "include": { "type": "array", "items": { "type": "string" } },
+          "exclude": { "type": "array", "items": { "type": "string" } },
+          "flags": { "type": "string" }
+        }
+      }
+    },
+    "bannedImports": {
+      "description": "Dependencies/imports that must not be added.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name"],
+        "properties": {
+          "name": { "type": "string" },
+          "message": { "type": "string" },
+          "severity": { "enum": ["error", "warn"] }
+        }
+      }
+    },
+    "prSize": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "maxFiles": { "type": "number" },
+        "maxLines": { "type": "number" }
+      }
+    },
+    "largeFiles": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] },
+        "maxSizeKb": { "type": "number" },
+        "allow": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "licenseHeader": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "pattern": { "type": "string" },
+        "lines": { "type": "number" }
+      }
+    },
+    "coverage": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] },
+        "reportPath": {
+          "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }]
+        }
+      }
+    },
+    "vulnScan": {
+      "type": "object",
+      "properties": { "enabled": { "type": "boolean" } }
+    },
+    "mergeConflict": { "$ref": "#/$defs/toggleSeverity" },
+    "leftoverDebug": { "$ref": "#/$defs/toggleSeverity" },
+    "lockfileDrift": { "$ref": "#/$defs/toggleSeverity" },
+    "missingTests": { "$ref": "#/$defs/toggleSeverity" },
+    "diffSecurity": { "$ref": "#/$defs/toggleIgnore" },
+    "workflowSecurity": { "$ref": "#/$defs/toggleIgnore" },
+    "dockerfileSecurity": { "$ref": "#/$defs/toggleIgnore" },
+    "migrationSafety": { "$ref": "#/$defs/toggleSeverity" },
+    "todoFixme": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] },
+        "requireTicket": { "type": "boolean" },
+        "keywords": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "diffSmell": { "$ref": "#/$defs/toggle" },
+    "caseCollision": { "$ref": "#/$defs/toggle" },
+    "sensitiveFileGuard": { "$ref": "#/$defs/toggle" },
+    "configValidation": { "$ref": "#/$defs/toggle" },
+    "typecheck": { "$ref": "#/$defs/toggle" },
+    "prBody": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "minLength": { "type": "number" },
+        "requireTicket": { "type": "boolean" }
+      }
+    },
+    "cpp": { "$ref": "#/$defs/toggle" },
+    "python": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "typecheck": { "type": "boolean" },
+        "typeChecker": { "enum": ["mypy", "pyright"] },
+        "ruff": {
+          "type": "object",
+          "properties": {
+            "lint": { "type": "boolean" },
+            "format": { "type": "boolean" }
+          }
+        }
+      }
+    },
+    "swift": { "$ref": "#/$defs/toggle" },
+    "kotlin": { "$ref": "#/$defs/toggle" },
+    "go": { "$ref": "#/$defs/toggle" },
+    "rust": { "$ref": "#/$defs/toggle" },
+    "csharp": { "$ref": "#/$defs/toggle" },
+    "ruby": { "$ref": "#/$defs/toggle" },
+    "php": { "$ref": "#/$defs/toggle" }
+  },
+  "$defs": {
+    "toggle": {
+      "type": "object",
+      "properties": { "enabled": { "type": "boolean" } }
+    },
+    "toggleSeverity": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] }
+      }
+    },
+    "toggleIgnore": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "ignore": { "type": "array", "items": { "type": "string" } }
+      }
+    }
+  }
+}

package/src/config/cspell.json

@@ -693,7 +693,30 @@
     "litert",
     "SHTPB",
     "FUTX",
-    "subdirs"
+    "subdirs",
+    "clippy",
+    "mypy",
+    "pyright",
+    "jacoco",
+    "depcheckrc",
+    "gofmt",
+    "dotnet",
+    "rubocop",
+    "precommit",
+    "swiftpm",
+    "recognises",
+    "vulnerab",
+    "numstat",
+    "bpprint",
+    "pprint",
+    "bpdb",
+    "setext",
+    "Confict",
+    "bhashlib",
+    "bfmt",
+    "dockerfiles",
+    "footguns",
+    "materialises"
   ],
   "ignorePaths": [
     "**/node_modules/**",

package/src/config/pr-checkmate.schema.json

@@ -0,0 +1,166 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "PR CheckMate configuration",
+  "description": "Config for pr-checkmate. Unknown keys are reported by the Config Validation check.",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "$schema": { "type": "string" },
+    "sourcePath": {
+      "description": "Directory (or directories) checks are scoped to. Defaults to '.'.",
+      "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }]
+    },
+    "ignoreDirs": {
+      "description": "Directory names excluded from every check.",
+      "type": "array",
+      "items": { "type": "string" }
+    },
+    "severity": {
+      "description": "Universal per-check severity override, keyed by the check's display name.",
+      "type": "object",
+      "additionalProperties": { "enum": ["error", "warn", "off"] }
+    },
+    "customRules": {
+      "description": "User-defined regex rules run against the diff.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name", "pattern"],
+        "properties": {
+          "name": { "type": "string" },
+          "pattern": { "type": "string" },
+          "message": { "type": "string" },
+          "severity": { "enum": ["error", "warn"] },
+          "include": { "type": "array", "items": { "type": "string" } },
+          "exclude": { "type": "array", "items": { "type": "string" } },
+          "flags": { "type": "string" }
+        }
+      }
+    },
+    "bannedImports": {
+      "description": "Dependencies/imports that must not be added.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name"],
+        "properties": {
+          "name": { "type": "string" },
+          "message": { "type": "string" },
+          "severity": { "enum": ["error", "warn"] }
+        }
+      }
+    },
+    "prSize": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "maxFiles": { "type": "number" },
+        "maxLines": { "type": "number" }
+      }
+    },
+    "largeFiles": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] },
+        "maxSizeKb": { "type": "number" },
+        "allow": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "licenseHeader": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "pattern": { "type": "string" },
+        "lines": { "type": "number" }
+      }
+    },
+    "coverage": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] },
+        "reportPath": {
+          "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }]
+        }
+      }
+    },
+    "vulnScan": {
+      "type": "object",
+      "properties": { "enabled": { "type": "boolean" } }
+    },
+    "mergeConflict": { "$ref": "#/$defs/toggleSeverity" },
+    "leftoverDebug": { "$ref": "#/$defs/toggleSeverity" },
+    "lockfileDrift": { "$ref": "#/$defs/toggleSeverity" },
+    "missingTests": { "$ref": "#/$defs/toggleSeverity" },
+    "diffSecurity": { "$ref": "#/$defs/toggleIgnore" },
+    "workflowSecurity": { "$ref": "#/$defs/toggleIgnore" },
+    "dockerfileSecurity": { "$ref": "#/$defs/toggleIgnore" },
+    "migrationSafety": { "$ref": "#/$defs/toggleSeverity" },
+    "todoFixme": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] },
+        "requireTicket": { "type": "boolean" },
+        "keywords": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "diffSmell": { "$ref": "#/$defs/toggle" },
+    "caseCollision": { "$ref": "#/$defs/toggle" },
+    "sensitiveFileGuard": { "$ref": "#/$defs/toggle" },
+    "configValidation": { "$ref": "#/$defs/toggle" },
+    "typecheck": { "$ref": "#/$defs/toggle" },
+    "prBody": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "minLength": { "type": "number" },
+        "requireTicket": { "type": "boolean" }
+      }
+    },
+    "cpp": { "$ref": "#/$defs/toggle" },
+    "python": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "typecheck": { "type": "boolean" },
+        "typeChecker": { "enum": ["mypy", "pyright"] },
+        "ruff": {
+          "type": "object",
+          "properties": {
+            "lint": { "type": "boolean" },
+            "format": { "type": "boolean" }
+          }
+        }
+      }
+    },
+    "swift": { "$ref": "#/$defs/toggle" },
+    "kotlin": { "$ref": "#/$defs/toggle" },
+    "go": { "$ref": "#/$defs/toggle" },
+    "rust": { "$ref": "#/$defs/toggle" },
+    "csharp": { "$ref": "#/$defs/toggle" },
+    "ruby": { "$ref": "#/$defs/toggle" },
+    "php": { "$ref": "#/$defs/toggle" }
+  },
+  "$defs": {
+    "toggle": {
+      "type": "object",
+      "properties": { "enabled": { "type": "boolean" } }
+    },
+    "toggleSeverity": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] }
+      }
+    },
+    "toggleIgnore": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "ignore": { "type": "array", "items": { "type": "string" } }
+      }
+    }
+  }
+}