ignore-walk 7.0.0: walk, walk.WalkerSync, walk.sync

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

Use EXACTLY these public packages and versions:
  - pkg:npm/ignore-walk@7.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:c13c20f433caf7297047f95f110117e14df9fb87614415b8d539cc89c40ffc86","contract":["walk.sync({ path, ignoreFiles }) walks the directory tree synchronously, applying root and nested ignore rules (including negation rules with '!') and returning sorted relative paths","walk({ path, ignoreFiles, includeEmpty: true }) returns a Promise resolving to the sorted list of relative paths including empty directories","new walk.WalkerSync({ path, ignoreFiles }).start().result produces the same filtered relative path list"],"goal":"verify pkg:npm/ignore-walk@7.0.0","kind":"HOW","packages":["pkg:npm/ignore-walk@7.0.0"],"schemaVersion":1,"symbols":["walk","walk.WalkerSync","walk.sync"]},"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":["walk","walk.WalkerSync","walk.sync"],"verifierAdapter":"node-typescript@1"}

{
  "name": "verify-ignore-walk",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "verify-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": "verify-ignore-walk",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "dependencies": {
    "ignore-walk": "7.0.0"
  },
  "scripts": {
    "test": "node test/contract.mjs"
  }
}

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

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 tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'iw-test-'));
try {
  fs.writeFileSync(path.join(tmpDir, '.ignore'), '*.log\nignored-dir/\n');
  fs.writeFileSync(path.join(tmpDir, 'keep.txt'), 'keep');
  fs.writeFileSync(path.join(tmpDir, 'skip.log'), 'skip');

  fs.mkdirSync(path.join(tmpDir, 'ignored-dir'));
  fs.writeFileSync(path.join(tmpDir, 'ignored-dir', 'file.txt'), 'ignored');

  fs.mkdirSync(path.join(tmpDir, 'sub'));
  fs.writeFileSync(path.join(tmpDir, 'sub', '.ignore'), 'secret.txt\n!important.log\n');
  fs.writeFileSync(path.join(tmpDir, 'sub', 'visible.txt'), 'visible');
  fs.writeFileSync(path.join(tmpDir, 'sub', 'secret.txt'), 'secret');
  fs.writeFileSync(path.join(tmpDir, 'sub', 'important.log'), 'important');

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

  const syncResult = walk.sync({
    path: tmpDir,
    ignoreFiles: ['.ignore'],
  });
  assert.deepEqual(syncResult, [
    '.ignore',
    'keep.txt',
    'sub/.ignore',
    'sub/important.log',
    'sub/visible.txt',
  ]);

  const asyncResult = await walk({
    path: tmpDir,
    ignoreFiles: ['.ignore'],
    includeEmpty: true,
  });
  assert.deepEqual(asyncResult, [
    '.ignore',
    'empty-dir',
    'keep.txt',
    'sub/.ignore',
    'sub/important.log',
    'sub/visible.txt',
  ]);

  const walkerSync = new walk.WalkerSync({
    path: tmpDir,
    ignoreFiles: ['.ignore'],
  });
  walkerSync.start();
  assert.deepEqual(walkerSync.result, syncResult);
} finally {
  fs.rmSync(tmpDir, { recursive: true, force: true });
}