pr-checkmate 1.23.5 → 1.23.6

package/README.md

@@ -9,7 +9,7 @@
 ![jscpd](https://img.shields.io/badge/jscpd-5-blue)
 [![API Docs](https://img.shields.io/badge/API_docs-TypeDoc-9600FF?logo=readthedocs&logoColor=white)](https://pr-checkmate-docs.pages.dev)
 
-> PR CheckMate is a universal PR quality checker: one `npm install`, 49 checks across
+> PR CheckMate is a universal PR quality checker: one `npm install`, 50 checks across
 > 11 languages, running in CI on every pull request. The bundled languages need no
 > per-language toolchain setup.
 
@@ -108,7 +108,7 @@ skipped, not failed.
 
 ## Checks
 
-49 checks, grouped by category and run in parallel within each phase:
+50 checks, grouped by category and run in parallel within each phase:
 
 - Universal git-diff (18) — language-agnostic and bundled: merge-conflict markers,
   secret scan, diff security (JS/TS/Python/Go/Kotlin), GitHub Actions and Dockerfile
@@ -118,7 +118,7 @@ skipped, not failed.
 - Dependencies (7) — unused/missing, circular, outdated, license compliance, npm audit,
   a cross-language vuln scan (osv-scanner, opt-in), and a direct-dependency vuln scan
   (grype, on by default).
-- Quality (4) — duplicate code, dead code, multi-language spellcheck, markdown lint.
+- Quality (5) — duplicate code, dead code, multi-language spellcheck, markdown lint, YAML lint.
 - PR hygiene (4) — size, title, body, and commit-message convention.
 - Per-language (16) — lint, format, and type-check for the languages listed above.
 

package/dist/cli.js

@@ -19,6 +19,7 @@ const COMMAND_TO_CHECK = {
     'pr-title': 'PR Title',
     outdated: 'Outdated Deps',
     markdown: 'Markdown',
+    'yaml-lint': 'YAML Lint',
     typecheck: 'TypeScript',
     'diff-smell': 'Diff Smells',
     'diff-security': 'Diff Security',

package/dist/config/constants.js

@@ -240,6 +240,7 @@ exports.KNOWN_CONFIG_KEYS = new Set([
     'spellcheck',
     'cspell',
     'markdownlint',
+    'yamlLint',
     'typecheck',
     // security
     'security',

package/dist/core/checks/quality/yaml-lint.d.ts

@@ -0,0 +1,13 @@
+import { Check } from '../../types';
+/**
+ * Bundled YAML linter (the `yaml` package — no runner dependency, always
+ * available like Markdown/Spellcheck). Parses every changed `.yml`/`.yaml` file
+ * and reports the parser's own errors and warnings: syntax errors, duplicate map
+ * keys, tabs used as indentation, and other structural problems. Multi-document
+ * files (`---`-separated) are each parsed. ON by default — runs unless
+ * `yamlLint.enabled` is explicitly `false`. Findings are a hard error by default
+ * (a YAML problem fails the run); downgrade to advisory with
+ * `yamlLint.severity: "warn"`. Clients can exclude paths with `yamlLint.ignore`
+ * (glob patterns) in pr-checkmate.json.
+ */
+export declare const yamlLintCheck: Check;

package/dist/core/checks/quality/yaml-lint.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.yamlLintCheck = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const yaml_1 = require("yaml");
+const utils_1 = require("../../../utils");
+const targets_1 = require("../../targets");
+const types_1 = require("../../types");
+const findings_1 = require("../findings");
+/** First line of a `yaml` error/warning message, stripped of its source excerpt. */
+function shortMessage(message) {
+    return message.split('\n')[0].trim();
+}
+/**
+ * Bundled YAML linter (the `yaml` package — no runner dependency, always
+ * available like Markdown/Spellcheck). Parses every changed `.yml`/`.yaml` file
+ * and reports the parser's own errors and warnings: syntax errors, duplicate map
+ * keys, tabs used as indentation, and other structural problems. Multi-document
+ * files (`---`-separated) are each parsed. ON by default — runs unless
+ * `yamlLint.enabled` is explicitly `false`. Findings are a hard error by default
+ * (a YAML problem fails the run); downgrade to advisory with
+ * `yamlLint.severity: "warn"`. Clients can exclude paths with `yamlLint.ignore`
+ * (glob patterns) in pr-checkmate.json.
+ */
+exports.yamlLintCheck = {
+    name: 'YAML Lint',
+    phase: 'blocking',
+    applies(ctx) {
+        return ctx.config.yamlLint?.enabled !== false;
+    },
+    async run(ctx) {
+        const allTargets = await (0, targets_1.resolveTargetFiles)(ctx, ['*.yml', '*.yaml']);
+        if (allTargets === null)
+            return (0, types_1.skip)('git unavailable');
+        if (allTargets.length === 0)
+            return (0, types_1.skip)('no YAML files');
+        const ignore = ctx.config.yamlLint?.ignore ?? [];
+        const targets = ignore.length > 0 ? allTargets.filter(f => !(0, utils_1.matchesAnyGlob)(f, ignore)) : allTargets;
+        if (targets.length === 0)
+            return (0, types_1.skip)('all YAML files ignored');
+        const issues = [];
+        for (const file of targets) {
+            let source;
+            try {
+                source = node_fs_1.default.readFileSync(node_path_1.default.join(ctx.cwd, file), 'utf-8');
+            }
+            catch (err) {
+                utils_1.logger.warn(`[YAML Lint]: ⚠️ Could not read ${file}: ${err}`);
+                continue;
+            }
+            // parseAllDocuments never throws — it collects problems on each document,
+            // so a single malformed file cannot abort the whole check.
+            const docs = (0, yaml_1.parseAllDocuments)(source, { prettyErrors: true });
+            for (const doc of docs) {
+                for (const problem of [...doc.errors, ...doc.warnings]) {
+                    const pos = problem.linePos?.[0];
+                    issues.push({
+                        file,
+                        line: pos?.line,
+                        col: pos?.col,
+                        message: shortMessage(problem.message),
+                    });
+                }
+            }
+        }
+        if (issues.length === 0)
+            return (0, types_1.pass)();
+        // YAML problems are a hard error by default; a repo may downgrade to `warn`
+        // via `yamlLint.severity`.
+        const sev = (0, findings_1.severityEmitter)(ctx.config.yamlLint?.severity, 'error');
+        issues.slice(0, 10).forEach(i => {
+            const where = i.line ? `:${i.line}${i.col ? `:${i.col}` : ''}` : '';
+            sev.log(`[YAML Lint]: ${sev.icon} ${i.file}${where} — ${i.message}`);
+        });
+        if (issues.length > 10)
+            sev.log(`[YAML Lint]:   ... and ${issues.length - 10} more`);
+        return sev.emit(`${issues.length} YAML issue(s) found`);
+    },
+};

package/dist/core/registry.js

@@ -45,6 +45,7 @@ const duplicate_check_1 = require("./checks/quality/duplicate-check");
 const license_header_1 = require("./checks/quality/license-header");
 const markdown_lint_1 = require("./checks/quality/markdown-lint");
 const spellcheck_1 = require("./checks/quality/spellcheck");
+const yaml_lint_1 = require("./checks/quality/yaml-lint");
 const diff_security_1 = require("./checks/security/diff-security");
 const dockerfile_security_1 = require("./checks/security/dockerfile-security");
 const migration_safety_1 = require("./checks/security/migration-safety");
@@ -93,6 +94,7 @@ exports.REGISTRY = [
     outdated_deps_1.outdatedDepsCheck,
     markdown_lint_1.markdownLintCheck,
     spellcheck_1.spellcheckCheck,
+    yaml_lint_1.yamlLintCheck,
     python_lint_1.pythonLintCheck,
     python_typecheck_1.pythonTypecheckCheck,
     dead_code_1.deadCodeCheck,

package/dist/init.js

@@ -68,6 +68,14 @@ const DEFAULT_CONFIG = {
         rules: {},
         ignores: [],
     },
+    // YAML lint (bundled `yaml` parser). Reports syntax errors, duplicate keys,
+    // and tab/indentation problems in .yml/.yaml files. Blocking by default
+    // (severity "error"); set severity "warn" to make it advisory, or enabled
+    // false to disable. `ignore` takes glob patterns to skip (e.g. "charts/**").
+    yamlLint: {
+        enabled: true,
+        ignore: [],
+    },
     // TypeScript type check
     typecheck: {
         enabled: true,

package/dist/interfaces/index.d.ts

@@ -197,6 +197,11 @@ export interface PRCheckMateConfig {
     configValidation?: {
         enabled?: boolean;
     };
+    yamlLint?: {
+        enabled?: boolean;
+        severity?: 'error' | 'warn';
+        ignore?: string[];
+    };
     vulnScan?: {
         enabled?: boolean;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.23.5",
+    "version": "1.23.6",
     "description": "Automated PR quality checks: linting, formatting, dependency analysis, and spellcheck",
     "keywords": [
         "github-actions",
@@ -99,7 +99,8 @@
         "prettier": ">=3.0.0",
         "ts-node": "^10.9.1",
         "ts-unused-exports": "^11.0.1",
-        "typescript": "^6.0.3"
+        "typescript": "^6.0.3",
+        "yaml": "^2.9.0"
     },
     "devDependencies": {
         "standard-version": "^9.5.0",

package/pr-checkmate.schema.json

@@ -148,6 +148,14 @@
     "caseCollision": { "$ref": "#/$defs/toggle" },
     "sensitiveFileGuard": { "$ref": "#/$defs/toggle" },
     "configValidation": { "$ref": "#/$defs/toggle" },
+    "yamlLint": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] },
+        "ignore": { "type": "array", "items": { "type": "string" } }
+      }
+    },
     "typecheck": { "$ref": "#/$defs/toggle" },
     "prBody": {
       "type": "object",

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

@@ -148,6 +148,14 @@
     "caseCollision": { "$ref": "#/$defs/toggle" },
     "sensitiveFileGuard": { "$ref": "#/$defs/toggle" },
     "configValidation": { "$ref": "#/$defs/toggle" },
+    "yamlLint": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "severity": { "enum": ["error", "warn"] },
+        "ignore": { "type": "array", "items": { "type": "string" } }
+      }
+    },
     "typecheck": { "$ref": "#/$defs/toggle" },
     "prBody": {
       "type": "object",