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

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:199d226f3e0f766d676327f54debf0cf9bcac13c9c384f11313a734e26d77274","contract":["walk.sync({ path }) synchronously walks the directory tree, applying default .ignore rules (including negation and nested .ignore files) and returning a sorted array of relative paths with ./ prefix on root @-scoped entries","walk.sync({ path, includeEmpty: true }) includes relative paths of empty directories in the returned array","walk.sync({ path, ignoreFiles, follow }) respects custom ignore file names and only traverses symlinked directories when follow is true"],"goal":"verify ignore-walk.sync in pkg:npm/ignore-walk@7.0.0","kind":"HOW","packages":["pkg:npm/ignore-walk@7.0.0"],"schemaVersion":1,"symbols":["ignore-walk.sync"]},"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":["ignore-walk.sync"],"verifierAdapter":"node-typescript@1"}

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

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

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 tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'ignore-walk-sync-'));

try {
  // 1. Default ignoreFiles (['.ignore']) and negation + nested ignore rules
  const dir1 = path.join(tmpRoot, 'case1');
  fs.mkdirSync(path.join(dir1, 'sub', 'empty-dir'), { recursive: true });
  fs.mkdirSync(path.join(dir1, '@scoped'), { recursive: true });

  fs.writeFileSync(
    path.join(dir1, '.ignore'),
    ['*.log', 'ignored-dir/', '!keep.log', ''].join('\n'),
    'utf8'
  );
  fs.writeFileSync(path.join(dir1, 'a.txt'), 'a', 'utf8');
  fs.writeFileSync(path.join(dir1, 'debug.log'), 'debug', 'utf8');
  fs.writeFileSync(path.join(dir1, 'keep.log'), 'keep', 'utf8');

  fs.mkdirSync(path.join(dir1, 'ignored-dir'), { recursive: true });
  fs.writeFileSync(path.join(dir1, 'ignored-dir', 'inside.txt'), 'no', 'utf8');

  // Nested .ignore overrides/adds rules within sub/
  fs.writeFileSync(path.join(dir1, 'sub', '.ignore'), 'sub-skip.txt\n', 'utf8');
  fs.writeFileSync(path.join(dir1, 'sub', 'sub-keep.txt'), 'yes', 'utf8');
  fs.writeFileSync(path.join(dir1, 'sub', 'sub-skip.txt'), 'no', 'utf8');
  fs.writeFileSync(path.join(dir1, 'sub', 'nested.log'), 'no', 'utf8');

  // Top-level @-prefixed entry gets normalized with leading './'
  fs.writeFileSync(path.join(dir1, '@scoped', 'pkg.json'), '{}', 'utf8');

  const resDefault = walk.sync({ path: dir1 });
  assert.deepEqual(resDefault, [
    './@scoped/pkg.json',
    '.ignore',
    'a.txt',
    'keep.log',
    'sub/.ignore',
    'sub/sub-keep.txt',
  ]);

  // 2. includeEmpty: true includes empty directories
  const resWithEmpty = walk.sync({ path: dir1, includeEmpty: true });
  assert.deepEqual(resWithEmpty, [
    './@scoped/pkg.json',
    '.ignore',
    'a.txt',
    'keep.log',
    'sub/.ignore',
    'sub/empty-dir',
    'sub/sub-keep.txt',
  ]);

  // 3. Custom ignoreFiles option and follow: true for directory symlinks
  const dir2 = path.join(tmpRoot, 'case2');
  const extTarget = path.join(tmpRoot, 'ext-target');
  fs.mkdirSync(dir2, { recursive: true });
  fs.mkdirSync(extTarget, { recursive: true });
  fs.writeFileSync(path.join(extTarget, 'linked.txt'), 'linked', 'utf8');
  fs.writeFileSync(path.join(extTarget, 'skip.tmp'), 'skip', 'utf8');

  fs.writeFileSync(path.join(dir2, '.customignore'), '*.tmp\n.customignore\n', 'utf8');
  fs.writeFileSync(path.join(dir2, 'main.js'), 'export {};\n', 'utf8');
  fs.writeFileSync(path.join(dir2, 'scratch.tmp'), 'tmp', 'utf8');
  fs.symlinkSync(extTarget, path.join(dir2, 'linked-dir'), 'dir');

  // follow: false (default) treats symlink to dir as a non-directory entry
  const resNoFollow = walk.sync({
    path: dir2,
    ignoreFiles: ['.customignore'],
    follow: false,
  });
  assert.deepEqual(resNoFollow, ['linked-dir', 'main.js']);

  // follow: true traverses symlinked directory and applies parent ignore rules
  const resFollow = walk.sync({
    path: dir2,
    ignoreFiles: ['.customignore'],
    follow: true,
  });
  assert.deepEqual(resFollow, ['linked-dir/linked.txt', 'main.js']);
} finally {
  fs.rmSync(tmpRoot, { recursive: true, force: true });
}