pr-checkmate 1.22.7 → 1.23.0

package/eslint-default-rules.json

@@ -0,0 +1,62 @@
+{
+  "no-console": "warn",
+  "no-debugger": "error",
+  "prefer-const": "error",
+  "eqeqeq": ["error", "always"],
+  "@typescript-eslint/no-unused-vars": [
+    "error",
+    { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }
+  ],
+  "@typescript-eslint/explicit-function-return-type": ["warn"],
+  "@typescript-eslint/no-explicit-any": ["warn"],
+  "@typescript-eslint/no-floating-promises": ["error"],
+  "space-before-function-paren": "off",
+  "operator-linebreak": "off",
+  "max-len": ["warn", { "code": 100 }],
+  "semi": ["error", "always"],
+  "quotes": ["error", "single", { "avoidEscape": true }],
+  "object-curly-spacing": ["error", "always"],
+  "space-infix-ops": "error",
+  "keyword-spacing": ["error", { "before": true, "after": true }],
+  "padding-line-between-statements": [
+    "error",
+    { "blankLine": "always", "prev": "block", "next": "*" },
+    { "blankLine": "always", "prev": "*", "next": "return" }
+  ],
+  "sonarjs/cognitive-complexity": ["warn", 30],
+  "sonarjs/no-duplicate-string": ["warn", { "threshold": 3 }],
+  "sonarjs/no-identical-functions": "warn",
+  "import/order": [
+    "warn",
+    {
+      "groups": ["builtin", "external", "internal", "parent", "sibling", "index"],
+      "alphabetize": { "order": "asc", "caseInsensitive": true }
+    }
+  ],
+  "import/no-duplicates": "error",
+  "jsdoc/require-jsdoc": [
+    "warn",
+    {
+      "publicOnly": true,
+      "require": {
+        "FunctionDeclaration": true,
+        "MethodDefinition": true,
+        "ClassDeclaration": true,
+        "ArrowFunctionExpression": false
+      }
+    }
+  ],
+  "jsdoc/check-param-names": "warn",
+  "jsdoc/check-tag-names": "warn",
+  "jsdoc/check-types": "warn",
+  "prettier/prettier": [
+    "error",
+    {
+      "semi": true,
+      "singleQuote": true,
+      "bracketSpacing": true,
+      "arrowParens": "avoid",
+      "printWidth": 100
+    }
+  ]
+}

package/eslint.config.mjs

@@ -1,4 +1,5 @@
 import fs from 'fs';
+import { createRequire } from 'module';
 import path from 'path';
 import tsPlugin from '@typescript-eslint/eslint-plugin';
 import tsParser from '@typescript-eslint/parser';
@@ -8,73 +9,12 @@ import importPlugin from 'eslint-plugin-import-x';
 import jsdocPlugin from 'eslint-plugin-jsdoc';
 
 /**
- * Default ESLint rules - can be exported for use in init.ts
+ * Default ESLint rules — single source of truth, shared with init.ts so the
+ * pr-checkmate.json it generates lists exactly the rules applied here. Edit the
+ * rules in `eslint-default-rules.json` (shipped alongside this file).
  */
-export const defaultRules = {
-  'no-console': 'warn',
-  'no-debugger': 'error',
-  'prefer-const': 'error',
-  'eqeqeq': ['error', 'always'],
-  '@typescript-eslint/no-unused-vars': [
-    'error',
-    { argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
-  ],
-  '@typescript-eslint/explicit-function-return-type': ['warn'],
-  '@typescript-eslint/no-explicit-any': ['warn'],
-  '@typescript-eslint/no-floating-promises': ['error'],
-  'space-before-function-paren': 'off',
-  'operator-linebreak': 'off',
-  'max-len': ['warn', { code: 100 }],
-  'semi': ['error', 'always'],
-  'quotes': ['error', 'single', { avoidEscape: true }],
-  'object-curly-spacing': ['error', 'always'],
-  'space-infix-ops': 'error',
-  'keyword-spacing': ['error', { before: true, after: true }],
-  'padding-line-between-statements': [
-    'error',
-    { blankLine: 'always', prev: 'block', next: '*' },
-    { blankLine: 'always', prev: '*', next: 'return' },
-  ],
-  // Complexity analysis (#61)
-  'sonarjs/cognitive-complexity': ['warn', 30],
-  'sonarjs/no-duplicate-string': ['warn', { threshold: 3 }],
-  'sonarjs/no-identical-functions': 'warn',
-  // Import ordering (#65)
-  'import/order': [
-    'warn',
-    {
-      groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
-      alphabetize: { order: 'asc', caseInsensitive: true },
-    },
-  ],
-  'import/no-duplicates': 'error',
-  // Documentation (#62)
-  'jsdoc/require-jsdoc': [
-    'warn',
-    {
-      publicOnly: true,
-      require: {
-        FunctionDeclaration: true,
-        MethodDefinition: true,
-        ClassDeclaration: true,
-        ArrowFunctionExpression: false,
-      },
-    },
-  ],
-  'jsdoc/check-param-names': 'warn',
-  'jsdoc/check-tag-names': 'warn',
-  'jsdoc/check-types': 'warn',
-  'prettier/prettier': [
-    'error',
-    {
-      semi: true,
-      singleQuote: true,
-      bracketSpacing: true,
-      arrowParens: 'avoid',
-      printWidth: 100,
-    },
-  ],
-};
+const require = createRequire(import.meta.url);
+export const defaultRules = require('./eslint-default-rules.json');
 
 /**
  * Default ignore patterns

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.22.7",
+    "version": "1.23.0",
     "description": "Automated PR quality checks: linting, formatting, dependency analysis, and spellcheck",
     "keywords": [
         "github-actions",
@@ -29,10 +29,12 @@
         "README.md",
         "scripts/copy-configs.js",
         "eslint.config.mjs",
+        "eslint-default-rules.json",
         ".eslintrc.js",
         ".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,15 @@
     "litert",
     "SHTPB",
     "FUTX",
-    "subdirs"
+    "subdirs",
+    "clippy",
+    "mypy",
+    "pyright",
+    "jacoco",
+    "depcheckrc",
+    "gofmt",
+    "dotnet",
+    "rubocop"
   ],
   "ignorePaths": [
     "**/node_modules/**",

package/src/config/eslint-default-rules.json

@@ -0,0 +1,62 @@
+{
+  "no-console": "warn",
+  "no-debugger": "error",
+  "prefer-const": "error",
+  "eqeqeq": ["error", "always"],
+  "@typescript-eslint/no-unused-vars": [
+    "error",
+    { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }
+  ],
+  "@typescript-eslint/explicit-function-return-type": ["warn"],
+  "@typescript-eslint/no-explicit-any": ["warn"],
+  "@typescript-eslint/no-floating-promises": ["error"],
+  "space-before-function-paren": "off",
+  "operator-linebreak": "off",
+  "max-len": ["warn", { "code": 100 }],
+  "semi": ["error", "always"],
+  "quotes": ["error", "single", { "avoidEscape": true }],
+  "object-curly-spacing": ["error", "always"],
+  "space-infix-ops": "error",
+  "keyword-spacing": ["error", { "before": true, "after": true }],
+  "padding-line-between-statements": [
+    "error",
+    { "blankLine": "always", "prev": "block", "next": "*" },
+    { "blankLine": "always", "prev": "*", "next": "return" }
+  ],
+  "sonarjs/cognitive-complexity": ["warn", 30],
+  "sonarjs/no-duplicate-string": ["warn", { "threshold": 3 }],
+  "sonarjs/no-identical-functions": "warn",
+  "import/order": [
+    "warn",
+    {
+      "groups": ["builtin", "external", "internal", "parent", "sibling", "index"],
+      "alphabetize": { "order": "asc", "caseInsensitive": true }
+    }
+  ],
+  "import/no-duplicates": "error",
+  "jsdoc/require-jsdoc": [
+    "warn",
+    {
+      "publicOnly": true,
+      "require": {
+        "FunctionDeclaration": true,
+        "MethodDefinition": true,
+        "ClassDeclaration": true,
+        "ArrowFunctionExpression": false
+      }
+    }
+  ],
+  "jsdoc/check-param-names": "warn",
+  "jsdoc/check-tag-names": "warn",
+  "jsdoc/check-types": "warn",
+  "prettier/prettier": [
+    "error",
+    {
+      "semi": true,
+      "singleQuote": true,
+      "bracketSpacing": true,
+      "arrowParens": "avoid",
+      "printWidth": 100
+    }
+  ]
+}

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" } }
+      }
+    }
+  }
+}