npm-packlist 9.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/npm-packlist@9.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/npm-packlist@9.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:4023485577337401e29d180e9ed9caca911a8acecd5cf56d5cad118a528fb9e6","contract":["packlist(tree) returns the sorted list of included files respecting package.json files and main","packlist.Walker exposes the PackWalker class"],"goal":"verify pkg:npm/npm-packlist@9.0.0","kind":"HOW","packages":["pkg:npm/npm-packlist@9.0.0"],"schemaVersion":1},"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-packlist@9.0.0"],"schemaVersion":1,"subject":"pkg:npm/npm-packlist@9.0.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-npm-packlist",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-npm-packlist",
      "version": "1.0.0",
      "dependencies": {
        "npm-packlist": "9.0.0"
      }
    },
    "node_modules/balanced-match": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
      "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
      "license": "MIT"
    },
    "node_modules/brace-expansion": {
      "version": "2.1.7",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.1.7.tgz",
      "integrity": "sha512-uZbew1NqdmPDTMJ8ah1y+b+9QEJrfkXFk3RcTQw3X0jW/xRUvFKsg1CfQdSYGdTbXZWExtU3J3ccxtnfw1Fi0g==",
      "license": "MIT",
      "dependencies": {
        "balanced-match": "^1.0.0"
      }
    },
    "node_modules/ignore-walk": {
      "version": "7.0.0",
      "resolved": "https://registry.npmjs.org/ignore-walk/-/ignore-walk-7.0.0.tgz",
      "integrity": "sha512-T4gbf83A4NH95zvhVYZc+qWocBBGlpzUXLPGurJggw/WIOwicfXJChLDP/iBZnN5WqROSu5Bm3hhle4z8a8YGQ==",
      "license": "ISC",
      "dependencies": {
        "minimatch": "^9.0.0"
      },
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    },
    "node_modules/minimatch": {
      "version": "9.0.9",
      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.9.tgz",
      "integrity": "sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg==",
      "license": "ISC",
      "dependencies": {
        "brace-expansion": "^2.0.2"
      },
      "engines": {
        "node": ">=16 || 14 >=14.17"
      },
      "funding": {
        "url": "https://github.com/sponsors/isaacs"
      }
    },
    "node_modules/npm-packlist": {
      "version": "9.0.0",
      "resolved": "https://registry.npmjs.org/npm-packlist/-/npm-packlist-9.0.0.tgz",
      "integrity": "sha512-8qSayfmHJQTx3nJWYbbUmflpyarbLMBc6LCAjYsiGtXxDB68HaZpb8re6zeaLGxZzDuMdhsg70jryJe+RrItVQ==",
      "license": "ISC",
      "dependencies": {
        "ignore-walk": "^7.0.0"
      },
      "engines": {
        "node": "^18.17.0 || >=20.5.0"
      }
    }
  }
}

{
  "name": "sample-npm-packlist",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "npm-packlist": "9.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/npm-packlist@9.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/npm-packlist@9.0.0"
  ]
}

import packlist from "npm-packlist";
import { mkdtempSync, writeFileSync, mkdirSync, rmSync } from "node:fs";
import { join } from "node:path";
import { tmpdir } from "node:os";

export async function verifyPacklist() {
  const dir = mkdtempSync(join(tmpdir(), "packlist-"));
  try {
    mkdirSync(join(dir, "lib"));
    mkdirSync(join(dir, "ignored"));
    const pkgJson = {
      name: "example-pkg",
      version: "1.0.0",
      main: "lib/entry.js",
      files: ["lib"]
    };
    writeFileSync(join(dir, "package.json"), JSON.stringify(pkgJson, null, 2));
    writeFileSync(join(dir, "README.md"), "# Example");
    writeFileSync(join(dir, "lib", "entry.js"), "export default 1;\n");
    writeFileSync(join(dir, "ignored", "skip.js"), "export default 2;\n");

    const tree = {
      path: dir,
      isProjectRoot: true,
      package: pkgJson,
      edgesOut: new Map()
    };

    const files = await packlist(tree);
    return {
      files,
      hasWalkerClass: typeof packlist.Walker === "function"
    };
  } finally {
    rmSync(dir, { recursive: true, force: true });
  }
}

import assert from "node:assert/strict";
import { verifyPacklist } from "../src/index.mjs";

const result = await verifyPacklist();

assert.equal(result.hasWalkerClass, true);
assert.equal(Array.isArray(result.files), true);
assert.deepEqual(
  [...result.files].sort(),
  ["README.md", "lib/entry.js", "package.json"]
);
assert.equal(result.files.includes("ignored/skip.js"), false);