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 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:
  - 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:ae50fb7ded206eb4835bf5ca820d45781c0f3dd57eb0016fdd5e844f86e2be90","contract":["new WalkerSync({ path, ignoreFiles }).start() synchronously reads the directory tree, returns the WalkerSync instance, emits the 'done' event with the sorted result array, and assigns the sorted array of relative file paths to walker.result","WalkerSync applies root and nested ignore file rules including '#' comments, blank lines, '!' negation rules, and directory ignore patterns","WalkerSync prefixes root entries starting with '@' with './' (e.g. './@scoped/pkg.js') in walker.result","new WalkerSync({ path, ignoreFiles, includeEmpty: true }).start() includes empty relative directory paths in walker.result, whereas includeEmpty: false omits them","new WalkerSync({ path, ignoreFiles, follow: true }).start() traverses symlinked directories and includes their contents in walker.result, whereas follow: false lists the symlink path itself without recursing"],"goal":"verify WalkerSync in pkg:npm/ignore-walk@7.0.0","kind":"HOW","packages":["pkg:npm/ignore-walk@7.0.0"],"schemaVersion":1,"symbols":["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","runtime":"node","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/ignore-walk@7.0.0"],"schemaVersion":1,"subject":"pkg:npm/ignore-walk@7.0.0","symbols":["WalkerSync"],"verifierAdapter":"node-typescript@1"}

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

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

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

import walk from 'ignore-walk';

const { WalkerSync } = walk;

export function runWalkerSync(options) {
  const walker = new WalkerSync(options);
  let donePayload = null;
  walker.on('done', (res) => {
    donePayload = res;
  });
  const returned = walker.start();
  return {
    walker,
    returned,
    result: walker.result,
    donePayload,
  };
}

export { WalkerSync };

import assert from 'node:assert/strict';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { WalkerSync, runWalkerSync } from '../src/index.mjs';

const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'ignore-walk-contract-'));

try {
  fs.mkdirSync(path.join(tmpRoot, 'src'), { recursive: true });
  fs.mkdirSync(path.join(tmpRoot, 'empty-dir'), { recursive: true });
  fs.mkdirSync(path.join(tmpRoot, '@scoped'), { recursive: true });
  fs.mkdirSync(path.join(tmpRoot, 'external-target'), { recursive: true });

  fs.writeFileSync(
    path.join(tmpRoot, '.ignore'),
    [
      '# comment line',
      '',
      '*.log',
      '!keep.log',
      'ignored-dir/',
      'external-target/',
    ].join('\n'),
    'utf8'
  );

  fs.writeFileSync(path.join(tmpRoot, 'keep.log'), 'kept\n', 'utf8');
  fs.writeFileSync(path.join(tmpRoot, 'debug.log'), 'ignored\n', 'utf8');
  fs.writeFileSync(path.join(tmpRoot, 'readme.txt'), 'hello\n', 'utf8');
  fs.writeFileSync(path.join(tmpRoot, '@scoped', 'pkg.js'), 'export {};\n', 'utf8');

  fs.writeFileSync(path.join(tmpRoot, 'src', '.ignore'), '*.tmp\n', 'utf8');
  fs.writeFileSync(path.join(tmpRoot, 'src', 'app.js'), 'console.log(1);\n', 'utf8');
  fs.writeFileSync(path.join(tmpRoot, 'src', 'scratch.tmp'), 'temp\n', 'utf8');

  fs.mkdirSync(path.join(tmpRoot, 'ignored-dir'), { recursive: true });
  fs.writeFileSync(path.join(tmpRoot, 'ignored-dir', 'secret.txt'), 'nope\n', 'utf8');

  fs.writeFileSync(path.join(tmpRoot, 'external-target', 'linked.txt'), 'via symlink\n', 'utf8');
  fs.symlinkSync(
    path.join(tmpRoot, 'external-target'),
    path.join(tmpRoot, 'linked-dir'),
    'dir'
  );

  const run1 = runWalkerSync({
    path: tmpRoot,
    ignoreFiles: ['.ignore'],
  });

  assert.equal(run1.returned, run1.walker, 'WalkerSync.start() returns the WalkerSync instance');
  assert.deepEqual(run1.donePayload, run1.result, 'done event payload matches walker.result');
  assert.deepEqual(run1.result, [
    './@scoped/pkg.js',
    '.ignore',
    'keep.log',
    'linked-dir',
    'readme.txt',
    'src/.ignore',
    'src/app.js',
  ]);

  const walkerWithEmpty = new WalkerSync({
    path: tmpRoot,
    ignoreFiles: ['.ignore'],
    includeEmpty: true,
  }).start();

  assert.ok(
    walkerWithEmpty.result.includes('empty-dir'),
    'includeEmpty: true includes empty directories in result'
  );

  const walkerFollow = new WalkerSync({
    path: tmpRoot,
    ignoreFiles: ['.ignore'],
    follow: true,
  }).start();

  assert.ok(
    walkerFollow.result.includes('linked-dir/linked.txt'),
    'follow: true traverses symlinked directory contents'
  );
  assert.ok(
    !walkerFollow.result.includes('linked-dir'),
    'follow: true replaces directory symlink entry with its walked contents'
  );
} finally {
  fs.rmSync(tmpRoot, { recursive: true, force: true });
}