ignore-walk 7.0.0: Walker

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 Walker in pkg:npm/ignore-walk@7.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/ignore-walk@7.0.0
Demonstrate these symbols/APIs:
  - Walker

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:caa9df7b23a789780d63f7bc345c9c2235d0b437fca2f70b33ef424be746e417","contract":["new Walker({ path, ignoreFiles: [\".gitignore\"], includeEmpty: false }).start() returns the Walker instance and emits \"done\" with sorted relative paths filtered by .gitignore rules (including negation rules) and prefixes @-scoped root entries with ./","new Walker({ path, ignoreFiles: [\".gitignore\"], includeEmpty: true }).start() includes empty directories in the emitted \"done\" result array","new Walker({ path: nonExistentPath }).start() emits an \"error\" event with ENOENT and sets walker.sawError to true"],"goal":"verify Walker in pkg:npm/ignore-walk@7.0.0","kind":"HOW","packages":["pkg:npm/ignore-walk@7.0.0"],"schemaVersion":1,"symbols":["Walker"]},"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/ignore-walk@7.0.0"],"schemaVersion":1,"subject":"pkg:npm/ignore-walk@7.0.0","symbols":["Walker"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-ignore-walk",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-ignore-walk",
      "version": "1.0.0",
      "dependencies": {
        "ignore-walk": "7.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"
      }
    }
  }
}

{
  "name": "sample-ignore-walk",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "ignore-walk": "7.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify Walker in pkg:npm/ignore-walk@7.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/ignore-walk@7.0.0"
  ],
  "symbols": [
    "Walker"
  ]
}

import assert from 'node:assert/strict';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import walk from 'ignore-walk';

const { Walker } = walk;

function runWalker(opts) {
  return new Promise((resolve, reject) => {
    const walker = new Walker(opts);
    walker.on('done', (result) => resolve({ walker, result }));
    walker.on('error', (err) => reject({ walker, err }));
    const started = walker.start();
    assert.equal(started, walker);
  });
}

const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'iw-test-'));

try {
  // Setup fixture directory structure
  fs.writeFileSync(
    path.join(tmpRoot, '.gitignore'),
    ['*.log', '!keep.log', 'ignored-dir/'].join('\n'),
    'utf8'
  );
  fs.writeFileSync(path.join(tmpRoot, 'a.txt'), 'a', 'utf8');
  fs.writeFileSync(path.join(tmpRoot, 'debug.log'), 'ignored', 'utf8');
  fs.writeFileSync(path.join(tmpRoot, 'keep.log'), 'kept', 'utf8');

  fs.mkdirSync(path.join(tmpRoot, 'ignored-dir'));
  fs.writeFileSync(path.join(tmpRoot, 'ignored-dir', 'skip.txt'), 'skip', 'utf8');

  fs.mkdirSync(path.join(tmpRoot, 'sub'));
  fs.writeFileSync(path.join(tmpRoot, 'sub', 'b.txt'), 'b', 'utf8');

  fs.mkdirSync(path.join(tmpRoot, '@scoped'));
  fs.writeFileSync(path.join(tmpRoot, '@scoped', 'pkg.json'), '{}', 'utf8');

  fs.mkdirSync(path.join(tmpRoot, 'empty-dir'));

  // 1. Default walk with custom ignoreFiles excludes ignored files and empty dirs
  const { walker: w1, result: res1 } = await runWalker({
    path: tmpRoot,
    ignoreFiles: ['.gitignore'],
    includeEmpty: false,
  });

  assert.deepEqual(res1, [
    './@scoped/pkg.json',
    '.gitignore',
    'a.txt',
    'keep.log',
    'sub/b.txt',
  ]);
  assert.deepEqual(w1.result, res1);
  assert.equal(w1.sawError, false);

  // 2. Walk with includeEmpty: true includes empty directories
  const { result: res2 } = await runWalker({
    path: tmpRoot,
    ignoreFiles: ['.gitignore'],
    includeEmpty: true,
  });

  assert.equal(res2.includes('empty-dir'), true);

  // 3. Emits error and sets sawError when path does not exist
  let caught = null;
  try {
    await runWalker({
      path: path.join(tmpRoot, 'non-existent-dir'),
    });
  } catch (e) {
    caught = e;
  }
  assert.notEqual(caught, null);
  assert.equal(caught.walker.sawError, true);
  assert.equal(caught.err.code, 'ENOENT');
} finally {
  fs.rmSync(tmpRoot, { recursive: true, force: true });
}