find-up 5.0.0

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/find-up@5.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/find-up@5.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:ce71ea280f653fd66682d0fa866b4872e668e138e877e981b845b70fb8c5eb55","contract":["assert findUp traverses parent directories asynchronously to resolve the first matching file path","assert findUp returns undefined when the target file is not found in parent hierarchy","assert findUp.sync traverses parent directories synchronously to resolve the matching file path","assert findUp.sync returns undefined when the target file is not found","assert findUp accepts an array of filenames and matches by order of priority in each directory","assert findUp with type directory resolves matching directory path instead of regular file","assert findUp matcher function returning findUp.stop halts directory traversal","assert findUp.exists and findUp.sync.exists verify whether a path exists asynchronously and synchronously"],"goal":"verify pkg:npm/find-up@5.0.0","kind":"HOW","packages":["pkg:npm/find-up@5.0.0"],"schemaVersion":1},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/find-up@5.0.0"],"schemaVersion":1,"subject":"pkg:npm/find-up@5.0.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-find-up",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-find-up",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "find-up": "5.0.0"
      }
    },
    "node_modules/find-up": {
      "version": "5.0.0",
      "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz",
      "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==",
      "license": "MIT",
      "dependencies": {
        "locate-path": "^6.0.0",
        "path-exists": "^4.0.0"
      },
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
    "node_modules/locate-path": {
      "version": "6.0.0",
      "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz",
      "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==",
      "license": "MIT",
      "dependencies": {
        "p-locate": "^5.0.0"
      },
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
    "node_modules/p-limit": {
      "version": "3.1.0",
      "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz",
      "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==",
      "license": "MIT",
      "dependencies": {
        "yocto-queue": "^0.1.0"
      },
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
    "node_modules/p-locate": {
      "version": "5.0.0",
      "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz",
      "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==",
      "license": "MIT",
      "dependencies": {
        "p-limit": "^3.0.2"
      },
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
    "node_modules/path-exists": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz",
      "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==",
      "license": "MIT",
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/yocto-queue": {
      "version": "0.1.0",
      "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",
      "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==",
      "license": "MIT",
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    }
  }
}

{
  "name": "sample-find-up",
  "version": "1.0.0",
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "find-up": "5.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/find-up@5.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/find-up@5.0.0"
  ]
}

import assert from 'node:assert/strict';
import fs from 'node:fs';
import path from 'node:path';
import os from 'node:os';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const findUp = require('find-up');

async function runTests() {
  const tmpRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'csx-contract-find-up-'));

  try {
    const dirA = path.join(tmpRoot, 'dir-a');
    const dirB = path.join(dirA, 'dir-b');
    const subfolder = path.join(dirB, 'subfolder');

    fs.mkdirSync(dirA, { recursive: true });
    fs.mkdirSync(dirB, { recursive: true });
    fs.mkdirSync(subfolder, { recursive: true });

    fs.writeFileSync(path.join(tmpRoot, 'root-marker.txt'), 'root');
    fs.writeFileSync(path.join(dirA, 'sub-marker.txt'), 'dir-a');
    fs.writeFileSync(path.join(dirA, 'target-file.txt'), 'target');
    fs.writeFileSync(path.join(dirB, 'leaf-marker.txt'), 'dir-b');

    // 1. Export verification
    assert.equal(typeof findUp, 'function', 'findUp should be a function');
    assert.equal(typeof findUp.sync, 'function', 'findUp.sync should be a function');
    assert.equal(typeof findUp.stop, 'symbol', 'findUp.stop should be a symbol');
    assert.equal(typeof findUp.exists, 'function', 'findUp.exists should be a function');
    assert.equal(typeof findUp.sync.exists, 'function', 'findUp.sync.exists should be a function');

    // 2. findUp async traversal to find target file in parent
    const foundAsync = await findUp('target-file.txt', { cwd: dirB });
    assert.equal(foundAsync, path.join(dirA, 'target-file.txt'));

    // 3. findUp async returns undefined when file is not found
    const notFoundAsync = await findUp('non-existent-file.xyz', { cwd: dirB });
    assert.equal(notFoundAsync, undefined);

    // 4. findUp.sync synchronous traversal to find file in parent
    const foundSync = findUp.sync('sub-marker.txt', { cwd: dirB });
    assert.equal(foundSync, path.join(dirA, 'sub-marker.txt'));

    // 5. findUp.sync returns undefined when file is not found
    const notFoundSync = findUp.sync('non-existent-file.xyz', { cwd: dirB });
    assert.equal(notFoundSync, undefined);

    // 6. Matcher array in priority order
    const foundFromArray = await findUp(['non-existent.txt', 'target-file.txt'], { cwd: dirB });
    assert.equal(foundFromArray, path.join(dirA, 'target-file.txt'));

    // 7. Directory matching with type: 'directory'
    const foundDir = await findUp('subfolder', { cwd: dirB, type: 'directory' });
    assert.equal(foundDir, subfolder);

    // 8. Custom matcher function with findUp.stop
    let inspectedDirs = [];
    const stoppedResult = await findUp(directory => {
      inspectedDirs.push(directory);
      if (directory === dirA) {
        return findUp.stop;
      }
      return undefined;
    }, { cwd: dirB });

    assert.equal(stoppedResult, undefined);
    assert.equal(inspectedDirs.includes(dirB), true);
    assert.equal(inspectedDirs.includes(dirA), true);
    assert.equal(inspectedDirs.includes(tmpRoot), false, 'Should not inspect past stop condition');

    // 9. findUp.exists and findUp.sync.exists
    const existsAsync = await findUp.exists(path.join(dirA, 'target-file.txt'));
    assert.equal(existsAsync, true);
    const notExistsAsync = await findUp.exists(path.join(dirA, 'does-not-exist.txt'));
    assert.equal(notExistsAsync, false);

    const existsSync = findUp.sync.exists(path.join(dirA, 'target-file.txt'));
    assert.equal(existsSync, true);
    const notExistsSync = findUp.sync.exists(path.join(dirA, 'does-not-exist.txt'));
    assert.equal(notExistsSync, false);

    console.log('Contract tests passed successfully.');
  } finally {
    fs.rmSync(tmpRoot, { recursive: true, force: true });
  }
}

runTests().catch(err => {
  console.error(err);
  process.exit(1);
});