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 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:
  - 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:e8b99c6ab4f2dd799a37cdbff9e4b6d6def5b9477be3c931a7ab16748260e0c7","contract":["auditReport.reporters exposes install, detail, json, and quiet reporter functions plus reporters.install.summary","reporters.install and reporters.detail format zero-vulnerability and high-severity vulnerability audit payloads using a provided chalk-compatible formatter object","reporters.json serializes the audit payload with the requested indent and reporters.quiet returns an empty string"],"goal":"verify reporters in pkg:npm/npm-audit-report@6.0.0","kind":"HOW","packages":["pkg:npm/npm-audit-report@6.0.0"],"schemaVersion":1,"symbols":["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":["reporters"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-npm-audit-report-reporters",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-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": "sample-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 reporters in pkg:npm/npm-audit-report@6.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/npm-audit-report@6.0.0"
  ],
  "symbols": [
    "reporters"
  ]
}

import auditReport from 'npm-audit-report'

const { reporters } = auditReport

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

export function runAllReporters(auditData, { chalk = plainChalk, indent = 2 } = {}) {
  return {
    install: reporters.install(auditData, { chalk }),
    installSummary: reporters.install.summary(auditData, { chalk }),
    detail: reporters.detail(auditData, { chalk }),
    json: reporters.json(auditData, { indent }),
    quiet: reporters.quiet(auditData, { chalk }),
  }
}

export { reporters }

import assert from 'node:assert/strict'
import auditReport from 'npm-audit-report'
import { reporters, plainChalk, runAllReporters } from '../src/index.mjs'

// 1. Verify reporters object structure and exported keys
assert.equal(reporters, auditReport.reporters)
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')

// 2. Verify zero-vulnerability audit data across all reporters
const cleanAuditData = {
  vulnerabilities: {},
  metadata: {
    vulnerabilities: {
      info: 0,
      low: 0,
      moderate: 0,
      high: 0,
      critical: 0,
      total: 0,
    },
  },
}

const cleanOut = runAllReporters(cleanAuditData)
assert.equal(cleanOut.install, 'found 0 vulnerabilities')
assert.equal(cleanOut.installSummary, 'found 0 vulnerabilities')
assert.equal(cleanOut.detail, 'found 0 vulnerabilities')
assert.equal(cleanOut.quiet, '')
assert.deepEqual(JSON.parse(cleanOut.json), cleanAuditData)

// 3. Verify vulnerable audit data across install, detail, json, and quiet reporters
const vulnAuditData = {
  vulnerabilities: {
    'sample-pkg': {
      name: 'sample-pkg',
      severity: 'high',
      isDirect: true,
      via: [
        {
          source: 1001,
          name: 'sample-pkg',
          dependency: 'sample-pkg',
          title: 'Prototype Pollution in sample-pkg',
          url: 'https://example.com/advisories/1001',
          severity: 'high',
          range: '<1.2.0',
        },
      ],
      effects: [],
      range: '<1.2.0',
      nodes: ['node_modules/sample-pkg'],
      fixAvailable: true,
    },
  },
  metadata: {
    vulnerabilities: {
      info: 0,
      low: 0,
      moderate: 0,
      high: 1,
      critical: 0,
      total: 1,
    },
  },
}

const vulnOut = runAllReporters(vulnAuditData, { chalk: plainChalk, indent: 2 })
assert.ok(vulnOut.install.includes('1 high severity vulnerability'))
assert.ok(vulnOut.install.includes('npm audit fix'))
assert.ok(vulnOut.install.includes('Run `npm audit` for details.'))
assert.ok(!vulnOut.installSummary.includes('Run `npm audit` for details.'))
assert.ok(vulnOut.detail.includes('# npm audit report'))
assert.ok(vulnOut.detail.includes('Prototype Pollution in sample-pkg - https://example.com/advisories/1001'))
assert.ok(vulnOut.detail.includes('fix available via `npm audit fix`'))
assert.equal(vulnOut.quiet, '')
assert.equal(vulnOut.json, JSON.stringify(vulnAuditData, null, 2))