pr-checkmate 3.2.2 → 3.3.0

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

@@ -204,12 +204,15 @@ function dropMissingLanguages(language, missing) {
  */
 function resolveFrom(cwd) {
     return id => {
-        try {
-            return require.resolve(id, { paths: [cwd] });
-        }
-        catch {
-            return require.resolve(id);
+        // The client's copy first, then the fetched `spellcheck` profile (cspell's own
+        // dictionaries live there), then our tree.
+        for (const root of [cwd, ...(0, index_js_2.registeredToolPaths)()]) {
+            try {
+                return require.resolve(id, { paths: [root] });
+            }
+            catch { }
         }
+        return require.resolve(id);
     };
 }
 function createTempCspellConfig(cwd) {

package/dist/cjs/core/install/doctor.js

@@ -16,6 +16,7 @@ const package_version_js_1 = require("../../utils/package-version.js");
 Object.defineProperty(exports, "packageVersion", { enumerable: true, get: function () { return package_version_js_1.packageVersion; } });
 const cache_js_1 = require("./cache.js");
 const ensure_js_1 = require("./ensure.js");
+const grype_db_js_1 = require("./grype-db.js");
 const prepare_js_1 = require("./prepare.js");
 const profiles_js_1 = require("./profiles.js");
 /**
@@ -142,6 +143,17 @@ async function runDoctor(cwd = process.cwd()) {
         lines.push(`  ${missing.length} profile(s) not installed yet. They are fetched on the next`);
         lines.push('  run, or now with: npx pr-checkmate install');
     }
+    if (config.grypeScan?.enabled !== false) {
+        const db = await (0, grype_db_js_1.grypeDbState)(cwd);
+        lines.push('');
+        lines.push('  Grype database (shared by all projects on this machine)');
+        if (db.state === 'missing-tool')
+            lines.push('    — grype is not installed (brew install grype)');
+        else if (db.state === 'ready')
+            lines.push(`    ✅ up to date${db.built ? ` (built ${db.built})` : ''}`);
+        else
+            lines.push(`    ⬇️  stale${db.built ? ` (built ${db.built})` : ''} — refresh: npx pr-checkmate install`);
+    }
     const stale = (0, cache_js_1.stalePaths)((0, package_version_js_1.packageVersion)(), config.install?.cacheDir);
     if (stale.length > 0) {
         lines.push('');

package/dist/cjs/core/install/grype-db.d.ts

@@ -0,0 +1,25 @@
+type GrypeDbState = {
+    state: 'missing-tool';
+} | {
+    state: 'ready';
+    built?: string;
+} | {
+    state: 'stale';
+    built?: string;
+};
+/**
+ * Is grype's vulnerability database usable right now? grype refuses one older than
+ * 5 days (exit code 1 from `db status`). The database lives in grype's own cache,
+ * shared by every project on the machine, so one refresh serves them all.
+ */
+export declare function grypeDbState(cwd: string): Promise<GrypeDbState>;
+/**
+ * Download a fresh database when the current one is missing or stale.
+ *
+ * `timeoutMs` bounds the download: a check inside a run passes one so it can never
+ * look like a hung commit, `install` passes none because a person asked for exactly
+ * this and the download is the whole job. Returns why it is still unusable, or
+ * `null` when it is ready.
+ */
+export declare function ensureGrypeDb(cwd: string, timeoutMs?: number): Promise<string | null>;
+export {};

package/dist/cjs/core/install/grype-db.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.grypeDbState = grypeDbState;
+exports.ensureGrypeDb = ensureGrypeDb;
+const execa_js_1 = require("../../utils/execa.js");
+const logger_js_1 = require("../../utils/logger.js");
+/** `Built:` line of `grype db status`, so `doctor` can say how old the data is. */
+const builtOf = (stdout) => typeof stdout === 'string' ? /^Built:\s*(.+)$/m.exec(stdout)?.[1]?.trim() : undefined;
+/**
+ * Is grype's vulnerability database usable right now? grype refuses one older than
+ * 5 days (exit code 1 from `db status`). The database lives in grype's own cache,
+ * shared by every project on the machine, so one refresh serves them all.
+ */
+async function grypeDbState(cwd) {
+    const status = await (0, execa_js_1.execa)('grype', ['db', 'status'], { cwd, reject: false, timeout: 30000 });
+    if (status.code === 'ENOENT')
+        return { state: 'missing-tool' };
+    const built = builtOf(status.stdout);
+    return status.exitCode === 0 ? { state: 'ready', built } : { state: 'stale', built };
+}
+/**
+ * Download a fresh database when the current one is missing or stale.
+ *
+ * `timeoutMs` bounds the download: a check inside a run passes one so it can never
+ * look like a hung commit, `install` passes none because a person asked for exactly
+ * this and the download is the whole job. Returns why it is still unusable, or
+ * `null` when it is ready.
+ */
+async function ensureGrypeDb(cwd, timeoutMs) {
+    const current = await grypeDbState(cwd);
+    if (current.state === 'missing-tool')
+        return 'ENOENT';
+    if (current.state === 'ready')
+        return null;
+    logger_js_1.logger.info('[Grype Scan]: vulnerability database missing or stale — updating it');
+    const update = await (0, execa_js_1.execa)('grype', ['db', 'update'], {
+        cwd,
+        reject: false,
+        ...(timeoutMs ? { timeout: timeoutMs } : {}),
+    });
+    if (update.timedOut) {
+        return `database update exceeded ${timeoutMs}ms — run "grype db update" once, then retry`;
+    }
+    return update.exitCode === 0 ? null : 'database update failed (offline?) — run "grype db update"';
+}

package/dist/cjs/core/install/profiles.d.ts

@@ -3,7 +3,7 @@ import type { Language, LanguageUsage } from '../../utils/detect-language.js';
 /**
  * A named bundle of tooling, and the checks that stop working without it.
  *
- * The package ships ~233 MB of tooling, and no repository needs all of it: a
+ * The tooling totals ~233 MB, and no repository needs all of it: a
  * Python service pays for the whole JavaScript toolchain, a repository with
  * Spellcheck switched off still pays for cspell. Profiles are how that stops —
  * they name which slice of the tooling a given repository actually needs.

package/dist/cjs/core/install/profiles.js

@@ -25,9 +25,9 @@ exports.PROFILES = [
             'typescript',
             'eslint',
             'eslint-config-prettier',
-            'eslint-plugin-import-x',
             'eslint-plugin-jsdoc',
             'eslint-plugin-prettier',
+            'eslint-plugin-simple-import-sort',
             'eslint-plugin-sonarjs',
             '@typescript-eslint/eslint-plugin',
             '@typescript-eslint/parser',

package/dist/cjs/core/install/reuse.js

@@ -12,15 +12,18 @@ const resolve_bin_js_1 = require("../../utils/resolve-bin.js");
 /**
  * The major version we declare for a tool, from our own manifest.
  *
- * Read from `dependencies` rather than from the installed tree: what matters is
+ * Read from the manifest rather than from the installed tree: what matters is
  * the version our configuration was written against, and a hoisted install can
  * resolve to something else entirely.
  */
 function ownMajor(pkgName) {
     try {
         const manifest = node_path_1.default.join((0, resolve_bin_js_1.ownPackageRoot)(), 'package.json');
-        const deps = JSON.parse(node_fs_1.default.readFileSync(manifest, 'utf-8')).dependencies;
-        const range = deps?.[pkgName];
+        const parsed = JSON.parse(node_fs_1.default.readFileSync(manifest, 'utf-8'));
+        // Profile tooling is declared in `devDependencies` — it is fetched on demand
+        // rather than installed with us — but it is still the version our config was
+        // written against, and the manifest keeps both.
+        const range = parsed.dependencies?.[pkgName] ?? parsed.devDependencies?.[pkgName];
         if (!range)
             return null;
         // `^10.6.0`, `>=3.0.0`, `~5.1` — the leading number is the major in every

package/dist/cjs/init.js

@@ -8,8 +8,8 @@ exports.setupWorkflow = setupWorkflow;
 exports.buildInitialConfig = buildInitialConfig;
 exports.init = init;
 const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
 const inquirer_1 = __importDefault(require("inquirer"));
+const path_1 = __importDefault(require("path"));
 const index_js_1 = require("./config/index.js");
 const findings_js_1 = require("./core/checks/findings.js");
 const index_js_2 = require("./utils/index.js");
@@ -270,8 +270,46 @@ const HOW_TO = [
     `Every option, annotated, with its default: ${index_js_1.FULL_CONFIG_URL}`,
     `Docs: ${index_js_1.DOCS_URL}`,
 ].join(' ');
+// Written out at its defaults so the options are visible and editable in the file
+// instead of having to be looked up. Same trade as `max-len`: the values stop
+// tracking the package, which is the price of being able to see them.
+const GRYPE_SCAN_SEED = {
+    '//': 'Anchore grype, cross-ecosystem. ON by default but skips when grype is absent from the runner. Only direct dependencies are reported.',
+    enabled: true,
+    minSeverity: 'medium',
+    '//ignore': 'Suppress by CVE/GHSA id or by package name.',
+    ignore: [],
+    '//timeoutMs': 'Cap on the scan. On timeout the check skips rather than fails.',
+    timeoutMs: 120000,
+    '//ci': 'Per-environment overrides (enabled, minSeverity, ignore, timeoutMs): "ci" applies on CI builds, "local" elsewhere. Example: "local": { "enabled": false }',
+    ci: {},
+    local: {},
+};
+/**
+ * Every option the template documents that the file does not already carry, at
+ * its default. Without this, options such as `vulnScan` (off by default) or
+ * `licenseCheck` exist only in the docs, and nobody edits what they cannot see.
+ * Comment keys travel with the option they describe, section headers with the
+ * first option after them.
+ */
+function templateExtras(existing) {
+    const templatePath = path_1.default.join(__dirname, 'config', 'pr-checkmate.template.json');
+    if (!fs_1.default.existsSync(templatePath)) {
+        return {};
+    }
+    const template = JSON.parse(fs_1.default.readFileSync(templatePath, 'utf-8'));
+    const extras = {};
+    for (const [key, value] of Object.entries(template)) {
+        const option = key.startsWith('//') ? key.slice(2) : key;
+        if (key in existing || option in existing) {
+            continue;
+        }
+        extras[key] = value;
+    }
+    return extras;
+}
 function buildInitialConfig(sourcePath, languages) {
-    return {
+    const base = {
         $schema: SCHEMA_PATH,
         '// how-to': HOW_TO,
         commands: index_js_1.DEFAULT_COMMANDS,
@@ -352,9 +390,13 @@ function buildInitialConfig(sourcePath, languages) {
             dataflowWindow: findings_js_1.DEFAULT_DATAFLOW_WINDOW,
             ignorePaths: [...index_js_1.DIFF_SECURITY_IGNORE_DEFAULTS],
         },
+        grypeScan: structuredClone(GRYPE_SCAN_SEED),
         documentation: index_js_1.documentation,
         languages,
     };
+    const extras = templateExtras(base);
+    const { documentation: docs, languages: langs, ...rest } = base;
+    return { ...rest, ...extras, documentation: docs, languages: langs };
 }
 /** First-run setup: prompt, write config, and scaffold workflow + tsconfig. */
 async function createConfig(root) {
@@ -403,6 +445,10 @@ async function updateConfig(root) {
             $schema: json.$schema ?? SCHEMA_PATH,
             '// how-to': json['// how-to'] ?? HOW_TO,
             ...json,
+            // An existing file predates this option, so nobody has seen it. Added only
+            // when missing; a client's own block is never touched.
+            grypeScan: json.grypeScan ?? structuredClone(GRYPE_SCAN_SEED),
+            ...templateExtras({ ...json, grypeScan: true }),
             languages,
         };
         fs_1.default.writeFileSync(CONFIG_FILE, `${JSON.stringify(updated, null, 2)}\n`);

package/dist/cjs/scripts/copy-configs.js

@@ -36,6 +36,15 @@ const configFiles = [
         source: 'src/config/pr-checkmate-workflow-docker.yml',
         dest: 'dist/esm/config/pr-checkmate-workflow-docker.yml',
     },
+    // Read by `init` to seed every option into a new pr-checkmate.json.
+    {
+        source: 'src/config/pr-checkmate.template.json',
+        dest: 'dist/cjs/config/pr-checkmate.template.json',
+    },
+    {
+        source: 'src/config/pr-checkmate.template.json',
+        dest: 'dist/esm/config/pr-checkmate.template.json',
+    },
     { source: 'src/config/pr-checkmate.schema.json', dest: 'pr-checkmate.schema.json' },
 ];
 /**

package/dist/cjs/utils/own-deps.js

@@ -7,6 +7,7 @@ exports.findOwnPackageRoot = findOwnPackageRoot;
 exports.getOwnDependencyClosure = getOwnDependencyClosure;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
+const profiles_js_1 = require("../core/install/profiles.js");
 const OWN_PACKAGE_NAME = 'pr-checkmate';
 const PACKAGE_JSON = 'package.json';
 let cachedClosure;
@@ -89,7 +90,13 @@ function getOwnDependencyClosure() {
     }
     // BFS over the dependency graph, resolving each package relative to the parent
     // that declared it so nested (non-hoisted) installs resolve correctly.
-    const queue = readDependencyNames(root).map(name => ({
+    //
+    // Profile tooling is ours even though it no longer sits in `dependencies`: it is
+    // fetched on demand, so the roots are what we declare plus what the profiles
+    // name. Without the second half every fetched tool is "the client's" and its
+    // licence blocks the client for a dependency they cannot remove.
+    const roots = new Set([...readDependencyNames(root), ...profiles_js_1.PROFILES.flatMap(p => p.packages)]);
+    const queue = [...roots].map(name => ({
         name,
         fromDir: root,
     }));

package/dist/cjs/utils/resolve-bin.d.ts

@@ -16,6 +16,8 @@ export interface ResolvedTool {
  * to a run from before there was anything to fetch.
  */
 export declare function registerToolPaths(dirs: string[]): void;
+/** The roots registered for this run, for tools that load plugins by themselves. */
+export declare function registeredToolPaths(): string[];
 /** Drop every registered profile root. For tests, and for a second run in-process. */
 export declare function clearToolPaths(): void;
 /** The root of the installed pr-checkmate package — where our own tooling lives. */

package/dist/cjs/utils/resolve-bin.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerToolPaths = registerToolPaths;
+exports.registeredToolPaths = registeredToolPaths;
 exports.clearToolPaths = clearToolPaths;
 exports.ownPackageRoot = ownPackageRoot;
 exports.packagePresent = packagePresent;
@@ -33,6 +34,10 @@ let profileRoots = [];
 function registerToolPaths(dirs) {
     profileRoots = [...dirs];
 }
+/** The roots registered for this run, for tools that load plugins by themselves. */
+function registeredToolPaths() {
+    return [...profileRoots];
+}
 /** Drop every registered profile root. For tests, and for a second run in-process. */
 function clearToolPaths() {
     profileRoots = [];

package/dist/esm/cli.js

@@ -1,9 +1,11 @@
 #!/usr/bin/env node
+import { loadProjectConfig } from './config/loader.js';
 import { COMMAND_TO_CHECK, FLAGS, STANDALONE_COMMANDS, TOOLING_COMMANDS } from './core/commands.js';
 import { runChecks } from './core/index.js';
 import { installProfiles, pruneCache, runDoctor } from './core/install/doctor.js';
+import { ensureGrypeDb } from './core/install/grype-db.js';
 import { init } from './init.js';
-import { logger, getUpdateNotice } from './utils/index.js';
+import { getUpdateNotice, logger } from './utils/index.js';
 const argv = process.argv.slice(2);
 /**
  * Flags are separated from positional arguments so they compose with every command
@@ -88,6 +90,17 @@ void (async () => {
             for (const result of failed) {
                 logger.error(`[install]: ❌ ${result.profiles.join(', ') || 'tooling'}: ${result.reason}`);
             }
+            // Warm grype's vulnerability database too, with no time cap: the download is
+            // hundreds of MB and the scan itself would only be allowed a couple of minutes.
+            // Best-effort — an absent grype or a failed download is a warning, not a
+            // failed install, since Grype Scan skips cleanly without it.
+            if (loadProjectConfig().grypeScan?.enabled !== false) {
+                const why = await ensureGrypeDb(process.cwd());
+                if (why && why !== 'ENOENT')
+                    logger.warn(`[install]: ⚠️ grype: ${why}`);
+                else if (!why)
+                    logger.info('[install]: grype vulnerability database is up to date');
+            }
             process.exit(failed.length > 0 ? 1 : 0);
         }
         if (cmd === 'doctor') {