pr-checkmate 1.23.22 → 1.23.23

package/.eslintrc.js

@@ -93,19 +93,9 @@ module.exports = {
       },
     ],
     'import-x/no-duplicates': 'error',
-    // Documentation (#62)
-    'jsdoc/require-jsdoc': [
-      'warn',
-      {
-        publicOnly: true,
-        require: {
-          FunctionDeclaration: true,
-          MethodDefinition: true,
-          ClassDeclaration: true,
-          ArrowFunctionExpression: false,
-        },
-      },
-    ],
+    // Documentation (#62). `jsdoc/require-jsdoc` is deliberately absent — see the
+    // note in eslint-flat-config.mjs. These three check docblocks that exist and
+    // fix only inside them; they never fabricate one.
     'jsdoc/check-param-names': 'warn',
     'jsdoc/check-tag-names': 'warn',
     'jsdoc/check-types': 'warn',

package/cspell.json

@@ -422,6 +422,7 @@
     "distroless",
     "dlib",
     "Doar",
+    "docblocks",
     "Doch",
     "dockerfiles",
     "dockerization",

package/eslint-default-rules.json

@@ -34,18 +34,6 @@
     }
   ],
   "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",

package/eslint.config.mjs

@@ -26,6 +26,28 @@ import jsdocPlugin from 'eslint-plugin-jsdoc';
  * `eslint.rules: { "prettier/prettier": "error" }` or
  * `severity: { "Prettier": "error" }` in pr-checkmate.json.
  *
+ * FIXERS THAT FABRICATE CONTENT ARE NOT SHIPPED. `jsdoc/require-jsdoc` used to be in
+ * this set at `warn`, and it is auto-fixable — but unlike `prettier/prettier`, whose
+ * fixer produces the right answer, this one has no answer to produce. It writes an
+ * empty stub:
+ *
+ *     \/**
+ *      *
+ *      *\/
+ *
+ * which satisfies the rule permanently. The check runs in write mode by default
+ * outside CI, so one run stamped 150 stubs across one client's `src` and reported zero
+ * warnings; inside CI the auto-format commit pushes them back to the branch, so
+ * deleting them by hand never holds. The rule therefore reported a real gap once, and
+ * from then on guaranteed that every public method looked documented while none of it
+ * was — the signal destroyed by the same run that raised it.
+ *
+ * Whether a method is worth explaining is a judgement a fixer cannot make. The three
+ * `jsdoc/check-*` rules stay: they validate docblocks that already exist and fix only
+ * within them, so they never invent content. Documentation coverage, if a repo wants
+ * to enforce it, belongs in review — or in `eslint.rules` of its own pr-checkmate.json,
+ * where whoever turns it on knows what the fixer will do.
+ *
  * A JSON file cannot carry this note, hence it lives here; `src/config/.eslintrc.js`
  * holds the same rule set for the legacy ESLint <9 path and must stay in sync.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pr-checkmate",
-    "version": "1.23.22",
+    "version": "1.23.23",
     "description": "Security-first PR gate for CI: secret scanning, grype dependency scanning, SBOM — plus linting and formatting across 11 languages",
     "keywords": [
         "github-actions",
@@ -120,8 +120,8 @@
         "tar": "7.5.22",
         "axios": "1.18.1",
         "form-data": "4.0.6",
-        "brace-expansion": "5.0.8",
-        "fast-uri": "4.1.1",
+        "brace-expansion": "5.0.9",
+        "fast-uri": "4.1.2",
         "follow-redirects": "1.16.0",
         "lodash": "4.18.1",
         "minimatch": "10.2.5",

package/src/config/.eslintrc.js

@@ -93,19 +93,9 @@ module.exports = {
       },
     ],
     'import-x/no-duplicates': 'error',
-    // Documentation (#62)
-    'jsdoc/require-jsdoc': [
-      'warn',
-      {
-        publicOnly: true,
-        require: {
-          FunctionDeclaration: true,
-          MethodDefinition: true,
-          ClassDeclaration: true,
-          ArrowFunctionExpression: false,
-        },
-      },
-    ],
+    // Documentation (#62). `jsdoc/require-jsdoc` is deliberately absent — see the
+    // note in eslint-flat-config.mjs. These three check docblocks that exist and
+    // fix only inside them; they never fabricate one.
     'jsdoc/check-param-names': 'warn',
     'jsdoc/check-tag-names': 'warn',
     'jsdoc/check-types': 'warn',

package/src/config/cspell.json

@@ -422,6 +422,7 @@
     "distroless",
     "dlib",
     "Doar",
+    "docblocks",
     "Doch",
     "dockerfiles",
     "dockerization",

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

@@ -34,18 +34,6 @@
     }
   ],
   "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",