npm-audit-report 6.0.0: reporters

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify npm-audit-report.reporters in pkg:npm/npm-audit-report@6.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/npm-audit-report@6.0.0
Demonstrate these symbols/APIs:
  - npm-audit-report.reporters

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:ea5605066ef0cf082e6df017dd981ec546d89cd875f27c030ef57b378f03f3b7","contract":["auditReport.reporters exposes install (with .summary), detail, json, and quiet functions","reporters.install(data, { chalk }) formats vulnerability summary with npm audit footer when vulnerabilities \u003e 0, or 'found 0 vulnerabilities' when clean","reporters.install.summary(data, { chalk }) formats summary without the 'Run `npm audit` for details.' footer","reporters.detail(data, { chalk }) renders '# npm audit report' with advisory details, severity, fix availability, and summary when vulnerabilities \u003e 0","reporters.json(data, { indent }) returns JSON.stringify(data, null, indent) and reporters.quiet() returns an empty string"],"goal":"verify npm-audit-report.reporters in pkg:npm/npm-audit-report@6.0.0","kind":"HOW","packages":["pkg:npm/npm-audit-report@6.0.0"],"schemaVersion":1,"symbols":["npm-audit-report.reporters"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/npm-audit-report@6.0.0"],"schemaVersion":1,"subject":"pkg:npm/npm-audit-report@6.0.0","symbols":["npm-audit-report.reporters"],"verifierAdapter":"node-typescript@1"}

{
  "name": "verify-npm-audit-report-reporters",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "verify-npm-audit-report-reporters",
      "version": "1.0.0",
      "dependencies": {
        "npm-audit-report": "6.0.0"
      }
    },
    "node_modules/npm-audit-report": {
      "version": "6.0.0",
      "resolved": "https://registry.npmjs.org/npm-audit-report/-/npm-audit-report-6.0.0.tgz",
      "integrity": "sha512-Ag6Y1irw/+CdSLqEEAn69T8JBgBThj5mw0vuFIKeP7hATYuQuS5jkMjK6xmVB8pr7U4g5Audbun0lHhBDMIBRA==",
      "license": "ISC",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    }
  }
}

{
  "name": "verify-npm-audit-report-reporters",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "npm-audit-report": "6.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify npm-audit-report.reporters in pkg:npm/npm-audit-report@6.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/npm-audit-report@6.0.0"
  ],
  "symbols": [
    "npm-audit-report.reporters"
  ]
}

import assert from 'node:assert/strict';
import auditReport from 'npm-audit-report';

const { reporters } = auditReport;

const mockChalk = {
  green: { bold: (s) => String(s) },
  red: { bold: (s) => String(s) },
  magenta: { bold: (s) => String(s) },
  yellow: { bold: (s) => String(s) },
  bold: (s) => String(s),
  dim: (s) => String(s),
};

// Verify reporters keys
assert.deepEqual(Object.keys(reporters).sort(), ['detail', 'install', 'json', 'quiet']);
assert.equal(typeof reporters.install, 'function');
assert.equal(typeof reporters.install.summary, 'function');
assert.equal(typeof reporters.detail, 'function');
assert.equal(typeof reporters.json, 'function');
assert.equal(typeof reporters.quiet, 'function');

// Clean audit data
const cleanData = {
  vulnerabilities: {},
  metadata: {
    vulnerabilities: {
      info: 0,
      low: 0,
      moderate: 0,
      high: 0,
      critical: 0,
      total: 0,
    },
  },
};

assert.equal(reporters.install(cleanData, { chalk: mockChalk }), 'found 0 vulnerabilities');
assert.equal(reporters.install.summary(cleanData, { chalk: mockChalk }), 'found 0 vulnerabilities');
assert.equal(reporters.detail(cleanData, { chalk: mockChalk }), 'found 0 vulnerabilities');
assert.equal(reporters.json(cleanData, { indent: 2 }), JSON.stringify(cleanData, null, 2));
assert.equal(reporters.quiet(cleanData, {}), '');

// Vulnerable audit data
const vulnData = {
  vulnerabilities: {
    'pkg-a': {
      name: 'pkg-a',
      severity: 'high',
      range: '<1.2.0',
      via: [
        {
          title: 'Prototype Pollution',
          url: 'https://example.com/advisories/1',
        },
      ],
      effects: [],
      nodes: ['node_modules/pkg-a'],
      fixAvailable: true,
    },
  },
  metadata: {
    vulnerabilities: {
      info: 0,
      low: 0,
      moderate: 0,
      high: 1,
      critical: 0,
      total: 1,
    },
  },
};

const installOut = reporters.install(vulnData, { chalk: mockChalk });
assert.ok(installOut.includes('1 high severity vulnerability'));
assert.ok(installOut.includes('npm audit fix'));
assert.ok(installOut.includes('Run `npm audit` for details.'));

const summaryOut = reporters.install.summary(vulnData, { chalk: mockChalk });
assert.ok(summaryOut.includes('1 high severity vulnerability'));
assert.ok(!summaryOut.includes('Run `npm audit` for details.'));

const detailOut = reporters.detail(vulnData, { chalk: mockChalk });
assert.ok(detailOut.includes('# npm audit report'));
assert.ok(detailOut.includes('pkg-a  <1.2.0'));
assert.ok(detailOut.includes('Severity: high'));
assert.ok(detailOut.includes('Prototype Pollution - https://example.com/advisories/1'));
assert.ok(detailOut.includes('fix available via `npm audit fix`'));

// Verify main function delegates to reporters
const mainResult = auditReport(vulnData, { reporter: 'detail', chalk: mockChalk });
assert.equal(mainResult.report, detailOut);
assert.equal(mainResult.exitCode, 1);