ignore-walk 7.0.0: WalkerSync

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 ignore-walk.WalkerSync 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:
  - ignore-walk.WalkerSync

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:5ed18fb4a795154e6868823dbb94b3063ecdb6318c35cef6346cdc9b006ec7d0","contract":["new WalkerSync({ path, ignoreFiles, includeEmpty }).start() synchronously reads directory trees, applies root and nested ignore file rules (including negation patterns), sorts relative paths, emits 'done' with the resulting array, and stores it on walker.result","setting includeEmpty: true in WalkerSync options includes empty directory paths in walker.result"],"goal":"verify ignore-walk.WalkerSync in pkg:npm/ignore-walk@7.0.0","kind":"HOW","packages":["pkg:npm/ignore-walk@7.0.0"],"schemaVersion":1,"symbols":["ignore-walk.WalkerSync"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/ignore-walk@7.0.0"],"schemaVersion":1,"subject":"pkg:npm/ignore-walk@7.0.0","symbols":["ignore-walk.WalkerSync"],"verifierAdapter":"node-typescript@1"}

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

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

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 { WalkerSync } = walk;

const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'iw-sync-'));
try {
  // Setup nested directory structure with ignore files and empty dir
  fs.writeFileSync(path.join(tmpRoot, '.gitignore'), '*.log\nbuild/\n!important.log\n');
  fs.writeFileSync(path.join(tmpRoot, 'index.js'), 'console.log(1);\n');
  fs.writeFileSync(path.join(tmpRoot, 'debug.log'), 'ignored\n');
  fs.writeFileSync(path.join(tmpRoot, 'important.log'), 'kept\n');

  const buildDir = path.join(tmpRoot, 'build');
  fs.mkdirSync(buildDir);
  fs.writeFileSync(path.join(buildDir, 'out.js'), 'ignored dir\n');

  const subDir = path.join(tmpRoot, 'src');
  fs.mkdirSync(subDir);
  fs.writeFileSync(path.join(subDir, '.ignore'), 'secret.txt\n');
  fs.writeFileSync(path.join(subDir, 'app.js'), 'kept\n');
  fs.writeFileSync(path.join(subDir, 'secret.txt'), 'ignored by nested .ignore\n');

  const emptyDir = path.join(tmpRoot, 'empty');
  fs.mkdirSync(emptyDir);

  // 1. Default walk with specified ignoreFiles (.gitignore and .ignore), includeEmpty: false
  const walker1 = new WalkerSync({
    path: tmpRoot,
    ignoreFiles: ['.gitignore', '.ignore'],
    includeEmpty: false,
  });

  let doneEmitted = null;
  walker1.on('done', (res) => {
    doneEmitted = res;
  });

  const returned = walker1.start();
  assert.equal(returned, walker1);
  assert.deepEqual(walker1.result, [
    '.gitignore',
    'important.log',
    'index.js',
    'src/.ignore',
    'src/app.js',
  ]);
  assert.deepEqual(doneEmitted, walker1.result);

  // 2. Walk with includeEmpty: true
  const walker2 = new WalkerSync({
    path: tmpRoot,
    ignoreFiles: ['.gitignore', '.ignore'],
    includeEmpty: true,
  }).start();

  assert.equal(walker2.result.includes('empty'), true);
} finally {
  fs.rmSync(tmpRoot, { recursive: true, force: true });
}