read-package-json-fast 4.0.0

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 pkg:npm/read-package-json-fast@4.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/read-package-json-fast@4.0.0

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:267dea31315f3b5b4328700806eea34109208c5f3c2260d36b0dbfbefea20af3","contract":["read-package-json-fast(path) reads a package.json file, strips leading-underscore keys, computes _id as name@version, removes optionalDependencies entries from dependencies, normalizes funding string to { url }, normalizes bundledDependencies/bundleDependencies, filters non-string scripts, and populates bin by walking directories.bin","read-package-json-fast.normalize(data) normalizes an in-memory package manifest object, computing _id, normalizing bin via npm-normalize-package-bin, and converting object bundleDependencies to an array of keys"],"goal":"verify pkg:npm/read-package-json-fast@4.0.0","kind":"HOW","packages":["pkg:npm/read-package-json-fast@4.0.0"],"schemaVersion":1,"symbols":["read-package-json-fast","read-package-json-fast.normalize"]},"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/read-package-json-fast@4.0.0"],"schemaVersion":1,"subject":"pkg:npm/read-package-json-fast@4.0.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-read-package-json-fast",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-read-package-json-fast",
      "version": "1.0.0",
      "dependencies": {
        "read-package-json-fast": "4.0.0"
      }
    },
    "node_modules/json-parse-even-better-errors": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-4.0.0.tgz",
      "integrity": "sha512-lR4MXjGNgkJc7tkQ97kb2nuEMnNCyU//XYVH0MKTGcXEiSudQ5MKGKen3C5QubYy0vmq+JGitUg92uuywGEwIA==",
      "license": "MIT",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/npm-normalize-package-bin": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/npm-normalize-package-bin/-/npm-normalize-package-bin-4.0.0.tgz",
      "integrity": "sha512-TZKxPvItzai9kN9H/TkmCtx/ZN/hvr3vUycjlfmH0ootY9yFBzNOpiXAdIn1Iteqsvk4lQn6B5PTrt+n6h8k/w==",
      "license": "ISC",
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/read-package-json-fast": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/read-package-json-fast/-/read-package-json-fast-4.0.0.tgz",
      "integrity": "sha512-qpt8EwugBWDw2cgE2W+/3oxC+KTez2uSVR8JU9Q36TXPAGCaozfQUs59v4j4GFpWTaw0i6hAZSvOmu1J0uOEUg==",
      "license": "ISC",
      "dependencies": {
        "json-parse-even-better-errors": "^4.0.0",
        "npm-normalize-package-bin": "^4.0.0"
      },
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    }
  }
}

{
  "name": "sample-read-package-json-fast",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "dependencies": {
    "read-package-json-fast": "4.0.0"
  },
  "scripts": {
    "test": "node test/contract.mjs"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/read-package-json-fast@4.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/read-package-json-fast@4.0.0"
  ]
}

import assert from 'node:assert/strict'
import { mkdtemp, writeFile, mkdir, rm } from 'node:fs/promises'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import rpj from 'read-package-json-fast'

const tmp = await mkdtemp(join(tmpdir(), 'rpj-test-'))
try {
  // 1. Read and normalize package.json from disk, stripping underscore fields,
  // deduplicating optionalDependencies from dependencies, normalizing funding,
  // bundleDependencies, scripts, and walking directories.bin.
  const binDir = join(tmp, 'cli-bins')
  await mkdir(binDir, { recursive: true })
  await writeFile(join(binDir, 'run-tool'), '#!/usr/bin/env node\n', 'utf8')

  const pkgPath = join(tmp, 'package.json')
  await writeFile(
    pkgPath,
    JSON.stringify({
      name: 'demo-pkg',
      version: '2.1.0',
      _secret: 'should-be-stripped',
      dependencies: {
        'keep-dep': '^1.0.0',
        'opt-dep': '^2.0.0'
      },
      optionalDependencies: {
        'opt-dep': '^2.0.0'
      },
      bundledDependencies: true,
      funding: 'https://example.com/sponsor',
      scripts: {
        start: 'node index.js',
        invalidScript: 12345
      },
      directories: {
        bin: './cli-bins'
      }
    }),
    'utf8'
  )

  const parsed = await rpj(pkgPath)
  assert.equal(parsed._id, 'demo-pkg@2.1.0')
  assert.equal('_secret' in parsed, false)
  assert.deepEqual(parsed.dependencies, { 'keep-dep': '^1.0.0' })
  assert.deepEqual(parsed.bundleDependencies, ['keep-dep', 'opt-dep'])
  assert.equal('bundledDependencies' in parsed, false)
  assert.deepEqual(parsed.funding, { url: 'https://example.com/sponsor' })
  assert.deepEqual(parsed.scripts, { start: 'node index.js' })
  assert.deepEqual(parsed.bin, { 'run-tool': 'cli-bins/run-tool' })

  // 2. Direct in-memory normalization via rpj.normalize
  const raw = {
    name: 'norm-only',
    version: '0.5.0',
    bin: './bin/cli.js',
    bundledDependencies: { a: '1.0.0', b: '2.0.0' }
  }
  const normalized = rpj.normalize(raw)
  assert.equal(normalized._id, 'norm-only@0.5.0')
  assert.deepEqual(normalized.bin, { 'norm-only': 'bin/cli.js' })
  assert.deepEqual(normalized.bundleDependencies, ['a', 'b'])
} finally {
  await rm(tmp, { recursive: true, force: true })
}