pr-checkmate 1.23.19 → 1.23.20

package/cspell.json

@@ -1237,23 +1237,23 @@
     "רטינול"
   ],
   "ignorePaths": [
-    "**/node_modules/**",
-    "**/dist/**",
-    "**/.git/**",
-    "**/build/**",
-    "**/coverage/**",
-    "**/.next/**",
-    "**/.nuxt/**",
-    "**/out/**",
-    "**/__pycache__/**",
-    "**/.pytest_cache/**",
-    "**/.venv/**",
-    "**/venv/**",
-    "**/package-lock.json",
-    "**/yarn.lock",
-    "**/pnpm-lock.yaml",
-    "**/*.min.js",
-    "**/*.min.css"
+    "/**/node_modules/**",
+    "/**/dist/**",
+    "/**/.git/**",
+    "/**/build/**",
+    "/**/coverage/**",
+    "/**/.next/**",
+    "/**/.nuxt/**",
+    "/**/out/**",
+    "/**/__pycache__/**",
+    "/**/.pytest_cache/**",
+    "/**/.venv/**",
+    "/**/venv/**",
+    "/**/package-lock.json",
+    "/**/yarn.lock",
+    "/**/pnpm-lock.yaml",
+    "/**/*.min.js",
+    "/**/*.min.css"
   ],
   "enableFiletypes": ["typescript", "javascript", "markdown", "json"],
   "ignoreRegExpList": ["/https?:\\/\\/[^\\s]+/g", "/\\b[0-9a-f]{7,40}\\b/gi"]

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

@@ -1,2 +1,27 @@
+import { CspellConfig } from '../../../interfaces';
 import { Check } from '../../types';
+/**
+ * Anchors an ignore glob to the repository root.
+ *
+ * cspell matches `ignorePaths` against each file's ABSOLUTE path, so an unanchored
+ * `**\/build/**` also matches every ancestor directory of the workspace. On Bitbucket
+ * Pipelines the clone lives in `/opt/atlassian/pipelines/agent/build`, so that one
+ * pattern excluded the entire repository and the check silently spellchecked nothing.
+ * A leading `/` anchors the pattern to the config's directory (the repo root) while
+ * `/**\/dir/**` still matches at any depth INSIDE the repo — verified against cspell 10.
+ *
+ * Patterns that are already anchored (`/…`) or plainly relative (`dir/**`,
+ * `CHANGELOG.md`) are left untouched: they cannot match an ancestor.
+ */
+export declare function anchorIgnoreGlob(pattern: string): string;
+/**
+ * Folds the client's `cspell` block from pr-checkmate.json into the bundled
+ * defaults. `enabled` is deliberately not carried over — it gates the check
+ * itself (see `applies`) and is not a cspell setting.
+ *
+ * Lists are appended so a client extends the curated vocabulary instead of
+ * replacing it; `language` is the one exception and replaces the default, because
+ * a client writing `"en"` means exactly that and appending would be meaningless.
+ */
+export declare function mergeCspellConfig(defaultConfig: CspellConfig, userConfig: Partial<CspellConfig>): CspellConfig;
 export declare const spellcheckCheck: Check;

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

@@ -4,6 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.spellcheckCheck = void 0;
+exports.anchorIgnoreGlob = anchorIgnoreGlob;
+exports.mergeCspellConfig = mergeCspellConfig;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const config_1 = require("../../../config");
@@ -23,6 +25,47 @@ function loadUserCspellConfig(cwd) {
         return {};
     }
 }
+/**
+ * Anchors an ignore glob to the repository root.
+ *
+ * cspell matches `ignorePaths` against each file's ABSOLUTE path, so an unanchored
+ * `**\/build/**` also matches every ancestor directory of the workspace. On Bitbucket
+ * Pipelines the clone lives in `/opt/atlassian/pipelines/agent/build`, so that one
+ * pattern excluded the entire repository and the check silently spellchecked nothing.
+ * A leading `/` anchors the pattern to the config's directory (the repo root) while
+ * `/**\/dir/**` still matches at any depth INSIDE the repo — verified against cspell 10.
+ *
+ * Patterns that are already anchored (`/…`) or plainly relative (`dir/**`,
+ * `CHANGELOG.md`) are left untouched: they cannot match an ancestor.
+ */
+function anchorIgnoreGlob(pattern) {
+    return pattern.startsWith('**/') ? `/${pattern}` : pattern;
+}
+/**
+ * Folds the client's `cspell` block from pr-checkmate.json into the bundled
+ * defaults. `enabled` is deliberately not carried over — it gates the check
+ * itself (see `applies`) and is not a cspell setting.
+ *
+ * Lists are appended so a client extends the curated vocabulary instead of
+ * replacing it; `language` is the one exception and replaces the default, because
+ * a client writing `"en"` means exactly that and appending would be meaningless.
+ */
+function mergeCspellConfig(defaultConfig, userConfig) {
+    const dictionaries = [...(defaultConfig.dictionaries ?? []), ...(userConfig.dictionaries ?? [])];
+    return {
+        ...defaultConfig,
+        language: userConfig.language || defaultConfig.language,
+        words: [...defaultConfig.words, ...(userConfig.words || [])],
+        // Client globs are anchored too — a repo's own pattern is meant to be relative
+        // to that repo, never to whatever directories sit above the checkout.
+        ignorePaths: [...defaultConfig.ignorePaths, ...(userConfig.ignorePaths || [])].map(anchorIgnoreGlob),
+        ignoreRegExpList: [...defaultConfig.ignoreRegExpList, ...(userConfig.ignoreRegExpList || [])],
+        // The bundled dictionaries arrive through `import`, so there is nothing to
+        // override here. cspell ignores names it cannot resolve, so a client typo
+        // costs coverage but never fails the run.
+        ...(dictionaries.length > 0 ? { dictionaries } : {}),
+    };
+}
 function createTempCspellConfig(cwd) {
     const packageConfigPath = (0, config_1.getPackageConfigPath)('cspell.json');
     const packageConfigDir = node_path_1.default.dirname(packageConfigPath);
@@ -40,11 +83,8 @@ function createTempCspellConfig(cwd) {
         }
     });
     const mergedConfig = {
-        ...defaultConfig,
+        ...mergeCspellConfig(defaultConfig, userConfig),
         import: resolvedImports,
-        words: [...defaultConfig.words, ...(userConfig.words || [])],
-        ignorePaths: [...defaultConfig.ignorePaths, ...(userConfig.ignorePaths || [])],
-        ignoreRegExpList: [...defaultConfig.ignoreRegExpList, ...(userConfig.ignoreRegExpList || [])],
     };
     const tempConfigPath = node_path_1.default.join(cwd, '.cspell.temp.json');
     node_fs_1.default.writeFileSync(tempConfigPath, JSON.stringify(mergedConfig, null, 2));
@@ -53,26 +93,46 @@ function createTempCspellConfig(cwd) {
 exports.spellcheckCheck = {
     name: 'Spellcheck',
     phase: 'informational',
-    applies() {
-        return true;
+    /**
+     * Clients turn the check off with `cspell.enabled: false` (or the `spellcheck`
+     * alias the config interface uses). The universal `severity: { Spellcheck: "off" }`
+     * switch keeps working too — this is the per-check flag every other check exposes.
+     */
+    applies(ctx) {
+        return ctx.config.cspell?.enabled !== false && ctx.config.spellcheck?.enabled !== false;
     },
     async run(ctx) {
-        const files = await (0, targets_1.resolveScopedTargetFiles)(ctx, ['*.ts', '*.tsx', '*.js', '*.jsx', '*.md', '*.mdx', '*.json'], (0, config_1.getSourcePaths)());
-        if (files === null)
+        const targets = await (0, targets_1.resolveScopedTargetFiles)(ctx, ['*.ts', '*.tsx', '*.js', '*.jsx', '*.md', '*.mdx', '*.json'], (0, config_1.getSourcePaths)());
+        if (targets === null)
             return (0, types_1.skip)('git unavailable');
+        // Committed build output and test reports are dropped here, in JS, against
+        // repo-RELATIVE paths — a client cannot fix a typo in a generated file, so
+        // reporting one is noise that buries the real findings. Neither cspell
+        // mechanism can do this safely: `--exclude` ignores glob anchoring outright
+        // (`--exclude=/**/build/**` still matches an ancestor `build` dir, which on
+        // Bitbucket Pipelines is the checkout itself), and `ignorePaths` only reaches
+        // repos that have no cspell config of their own. Filtering the list keeps one
+        // rule for every repo. `ignoreDirs` already covers plain directory names via
+        // `resolveTargetFiles`; this adds the composite globs it cannot express
+        // (`**/cypress/videos/**`, `**/jest-html-reporters-*/**`).
+        const files = targets.filter(f => !(0, utils_1.matchesAnyGlob)(f, config_1.IGNORE_PATTERNS));
         if (files.length === 0)
             return (0, types_1.pass)('no files to spellcheck');
-        const patterns = [...files, ...config_1.IGNORE_PATTERNS.map(p => `--exclude=${p}`)];
         const hasLocal = (0, config_1.hasLocalConfig)(['cspell.json', '.cspell.json', 'cspell.config.json']);
         let tempConfigPath = null;
         const cspellBin = (0, utils_1.resolvePackageBin)('cspell', 'bin.mjs');
+        // `--no-must-find-files`: cspell exits 1 when it checked nothing, which the
+        // exit-code mapping below would report as "spelling issues found" — a warning
+        // about problems that do not exist. Every file being excluded is a pass, not a
+        // finding.
+        const baseArgs = [...files, '--no-progress', '--no-must-find-files'];
         let args;
         if (hasLocal) {
-            args = [...patterns, '--no-progress'];
+            args = baseArgs;
         }
         else {
             tempConfigPath = createTempCspellConfig(ctx.cwd);
-            args = [...patterns, '--config', tempConfigPath, '--no-progress'];
+            args = [...baseArgs, '--config', tempConfigPath];
         }
         try {
             const result = await (0, execa_1.execa)(process.execPath, [cspellBin, ...args], {

package/dist/init.js

@@ -58,8 +58,14 @@ const DEFAULT_CONFIG = {
     prettier: {
         rules: {},
     },
-    // Cspell customization
+    // Spellcheck (cspell). `enabled: false` turns the check off — that part always
+    // applies. The lists feed the cspell config pr-checkmate generates, so they are
+    // ignored when the repo has a cspell.json of its own; all of them are appended to
+    // the bundled defaults. `ignorePaths` takes globs to skip (e.g. "CHANGELOG.md",
+    // "generated/**"), anchored to the repo root so a pattern never matches a
+    // directory above the checkout.
     cspell: {
+        enabled: true,
         words: [],
         ignorePaths: [],
         ignoreRegExpList: [],

package/dist/interfaces/index.d.ts

@@ -19,6 +19,8 @@ export interface CspellConfig {
     ignorePaths: string[];
     enableFiletypes: string[];
     ignoreRegExpList: string[];
+    dictionaries?: string[];
+    enabled?: boolean;
 }
 export interface PRCheckMateConfig {
     sourcePath: string | string[];
@@ -42,10 +44,19 @@ export interface PRCheckMateConfig {
         config?: Record<string, any>;
     };
     spellcheck?: {
+        enabled?: boolean;
         words?: string[];
         ignoreWords?: string[];
         ignorePaths?: string[];
     };
+    cspell?: {
+        enabled?: boolean;
+        words?: string[];
+        ignorePaths?: string[];
+        ignoreRegExpList?: string[];
+        dictionaries?: string[];
+        language?: string;
+    };
     security?: {
         gitleaks?: {
             enabled?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.23.19",
+    "version": "1.23.20",
     "description": "Automated PR quality checks: linting, formatting, dependency analysis, and spellcheck",
     "keywords": [
         "github-actions",

package/pr-checkmate.schema.json

@@ -149,6 +149,18 @@
     "caseCollision": { "$ref": "#/$defs/toggle" },
     "sensitiveFileGuard": { "$ref": "#/$defs/toggle" },
     "configValidation": { "$ref": "#/$defs/toggle" },
+    "cspell": {
+      "description": "Spellcheck control. 'enabled: false' turns the check off. The other fields configure the cspell config pr-checkmate generates, so they apply only when the repository has no cspell.json of its own: 'words', 'ignorePaths', 'ignoreRegExpList' and 'dictionaries' are appended to the bundled defaults, 'language' replaces it. Ignore globs are anchored to the repository root, so '**/dist/**' never matches a directory above the checkout.",
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "language": { "type": "string" },
+        "words": { "type": "array", "items": { "type": "string" } },
+        "dictionaries": { "type": "array", "items": { "type": "string" } },
+        "ignorePaths": { "type": "array", "items": { "type": "string" } },
+        "ignoreRegExpList": { "type": "array", "items": { "type": "string" } }
+      }
+    },
     "yamlLint": {
       "type": "object",
       "properties": {

package/src/config/cspell.json

@@ -1237,23 +1237,23 @@
     "רטינול"
   ],
   "ignorePaths": [
-    "**/node_modules/**",
-    "**/dist/**",
-    "**/.git/**",
-    "**/build/**",
-    "**/coverage/**",
-    "**/.next/**",
-    "**/.nuxt/**",
-    "**/out/**",
-    "**/__pycache__/**",
-    "**/.pytest_cache/**",
-    "**/.venv/**",
-    "**/venv/**",
-    "**/package-lock.json",
-    "**/yarn.lock",
-    "**/pnpm-lock.yaml",
-    "**/*.min.js",
-    "**/*.min.css"
+    "/**/node_modules/**",
+    "/**/dist/**",
+    "/**/.git/**",
+    "/**/build/**",
+    "/**/coverage/**",
+    "/**/.next/**",
+    "/**/.nuxt/**",
+    "/**/out/**",
+    "/**/__pycache__/**",
+    "/**/.pytest_cache/**",
+    "/**/.venv/**",
+    "/**/venv/**",
+    "/**/package-lock.json",
+    "/**/yarn.lock",
+    "/**/pnpm-lock.yaml",
+    "/**/*.min.js",
+    "/**/*.min.css"
   ],
   "enableFiletypes": ["typescript", "javascript", "markdown", "json"],
   "ignoreRegExpList": ["/https?:\\/\\/[^\\s]+/g", "/\\b[0-9a-f]{7,40}\\b/gi"]

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

@@ -149,6 +149,18 @@
     "caseCollision": { "$ref": "#/$defs/toggle" },
     "sensitiveFileGuard": { "$ref": "#/$defs/toggle" },
     "configValidation": { "$ref": "#/$defs/toggle" },
+    "cspell": {
+      "description": "Spellcheck control. 'enabled: false' turns the check off. The other fields configure the cspell config pr-checkmate generates, so they apply only when the repository has no cspell.json of its own: 'words', 'ignorePaths', 'ignoreRegExpList' and 'dictionaries' are appended to the bundled defaults, 'language' replaces it. Ignore globs are anchored to the repository root, so '**/dist/**' never matches a directory above the checkout.",
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "language": { "type": "string" },
+        "words": { "type": "array", "items": { "type": "string" } },
+        "dictionaries": { "type": "array", "items": { "type": "string" } },
+        "ignorePaths": { "type": "array", "items": { "type": "string" } },
+        "ignoreRegExpList": { "type": "array", "items": { "type": "string" } }
+      }
+    },
     "yamlLint": {
       "type": "object",
       "properties": {