pr-checkmate 1.23.23 → 2.0.0

package/dist/utils/update-notifier.js

@@ -3,9 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMajorUpgrade = isMajorUpgrade;
 exports.getUpdateNotice = getUpdateNotice;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
+// Imported from the module rather than the `../config` barrel on purpose:
+// `config/index.ts` imports `../utils`, so going through the barrel would make
+// utils ⇄ config circular. `constants.ts` itself pulls in nothing from utils.
+const constants_1 = require("../config/constants");
+// Same widths as the run summary in `reporters.ts`, so the two boxes line up
+// when both are printed at the end of a run.
+const NOTICE_BORDER = '═'.repeat(63);
+const NOTICE_RULE = '─'.repeat(63);
 /** 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);
@@ -16,6 +25,33 @@ function isNewer(latest, current) {
     }
     return false;
 }
+/** True when the upgrade crosses a major version, i.e. behaviour may change. */
+function isMajorUpgrade(latest, current) {
+    return (parseInt(latest.split('.')[0], 10) || 0) > (parseInt(current.split('.')[0], 10) || 0);
+}
+/**
+ * Extra lines for a major upgrade. A patch bump is a routine "install it"; a
+ * major one can change what fails a build, and finding that out from a red PR is
+ * the wrong way to learn it. Says what to read and how to stage the rollout,
+ * because the answer to "everything went red" should arrive before it happens.
+ */
+function majorNotice(pkgName) {
+    return [
+        NOTICE_RULE,
+        '  ⚠️  MAJOR VERSION — behaviour changes, read before upgrading',
+        '',
+        '     Findings a check rates "error" now BLOCK the run. Previously they were',
+        '     reported and the run still passed, so a repo with existing findings will',
+        '     start failing its PRs.',
+        '',
+        '     To stage it, make everything advisory first and promote checks back one',
+        '     at a time — in pr-checkmate.json:',
+        '       "severityDefaults": { "failOn": "warn" }',
+        '       "severity": { "Security Scan": "error" }',
+        '',
+        `     Full notes: https://www.npmjs.com/package/${pkgName}?activeTab=versions`,
+    ];
+}
 /**
  * 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).
@@ -24,6 +60,13 @@ function isNewer(latest, current) {
  * 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.
+ *
+ * The notice is framed like the run summary so it is noticed, but it is now a
+ * one-liner: upgrading is just installing. It used to demand `npx pr-checkmate
+ * init` afterwards, because `init` copied the release's new defaults into the
+ * client's config — a step nobody could safely skip, for a file that should
+ * never have held those defaults in the first place. They are merged in when the
+ * config loads, so the second step no longer exists.
  */
 async function getUpdateNotice(timeoutMs = 2500) {
     if (process.env.PR_CHECKMATE_NO_UPDATE_CHECK)
@@ -45,10 +88,21 @@ async function getUpdateNotice(timeoutMs = 2500) {
             clearTimeout(timer);
         }
         if (latest && isNewer(latest, pkg.version)) {
+            const major = isMajorUpgrade(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',
+                NOTICE_BORDER,
+                `  ⬆️  UPDATE AVAILABLE — ${pkg.name} ${pkg.version} → ${latest}`,
+                ...(major ? majorNotice(pkg.name) : []),
+                NOTICE_RULE,
+                `  Install: npm install ${pkg.name}@latest`,
+                '',
+                '  That is the whole upgrade. New checks and new defaults apply on their',
+                '  own — your pr-checkmate.json holds only what you changed, and nothing',
+                '  in it needs topping up.',
+                NOTICE_RULE,
+                `  📚 Docs:    ${constants_1.DOCS_URL}`,
+                `  📦 Release: https://www.npmjs.com/package/${pkg.name}`,
+                NOTICE_BORDER,
             ];
         }
         return null;

package/eslint.config.mjs

@@ -101,6 +101,18 @@ function loadUserConfig() {
 const userConfig = loadUserConfig();
 const SRC = userConfig.sourcePath || 'src';
 
+/**
+ * Directories linted in addition to `sourcePath`.
+ *
+ * Test suites commonly live outside the source tree, and a pattern built from
+ * `sourcePath` alone silently skips them — the files most likely to accumulate
+ * dead helpers and stray `console.log` go unchecked, and nothing says so. A
+ * project without these directories simply matches nothing here.
+ */
+const EXTRA_LINT_DIRS = ['tests', 'test', '__tests__'];
+
+const LINT_GLOBS = [SRC, ...EXTRA_LINT_DIRS].map(dir => `${dir}/**/*.{ts,tsx,js,jsx}`);
+
 // Merge default rules with user-defined rules
 const mergedRules = {
   ...defaultRules,
@@ -144,7 +156,7 @@ if (customIgnoresCount > 0) {
   console.error(`🚫 Applied ${customIgnoresCount} custom ignore patterns`);
 }
 
-console.error(`ESLint checking: ${SRC}/**/*.{ts,tsx,js,jsx}`);
+console.error(`ESLint checking: ${LINT_GLOBS.join(', ')}`);
 
 export default [
   // Global ignores must be in a separate config object
@@ -152,7 +164,7 @@ export default [
     ignores: mergedIgnores,
   },
   {
-    files: [`${SRC}/**/*.{ts,tsx,js,jsx}`],
+    files: LINT_GLOBS,
 
     languageOptions: {
       parser: tsParser,