find-up-simple 1.0.1: findUp

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-simple@1.0.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/find-up-simple@1.0.1
Demonstrate these symbols/APIs:
  - findUp

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:fe907e8a72ea8fb05db5c3f05076f9174ea3337a5af17c6bf195b02d769e0efa","contract":["findUp finds target file by walking up parent directories and returns its absolute path","findUp respects stopAt boundary and returns undefined if match is beyond stopAt","findUp matches directory when type option is set to directory","findUp returns undefined when target file is not found in parent directories","findUpSync synchronously finds target file by walking up parent directories","findUpSync synchronously returns undefined when target file is not found"],"goal":"verify pkg:npm/find-up-simple@1.0.1","kind":"HOW","packages":["pkg:npm/find-up-simple@1.0.1"],"schemaVersion":1,"symbols":["findUp"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","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-simple@1.0.1"],"schemaVersion":1,"subject":"pkg:npm/find-up-simple@1.0.1","symbols":["findUp"],"verifierAdapter":"node-typescript@1"}

import { findUp, findUpSync } from 'find-up-simple';

/**
 * Discovers a file or directory by walking up parent directories.
 *
 * @param {string} name - The name of the file or directory to find.
 * @param {import('find-up-simple').Options} [options] - Traversal options.
 * @returns {Promise<string | undefined>} The found absolute path or undefined.
 */
export async function locatePath(name, options = {}) {
  return findUp(name, options);
}

/**
 * Synchronously discovers a file or directory by walking up parent directories.
 *
 * @param {string} name - The name of the file or directory to find.
 * @param {import('find-up-simple').Options} [options] - Traversal options.
 * @returns {string | undefined} The found absolute path or undefined.
 */
export function locatePathSync(name, options = {}) {
  return findUpSync(name, options);
}

export { findUp, findUpSync };

{
  "name": "sample-find-up-simple",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-find-up-simple",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "find-up-simple": "1.0.1"
      }
    },
    "node_modules/find-up-simple": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/find-up-simple/-/find-up-simple-1.0.1.tgz",
      "integrity": "sha512-afd4O7zpqHeRyg4PfDQsXmlDe2PfdHtJt6Akt8jOWaApLOZk5JXs6VMR29lz03pRe9mpykrRCYIYxaJYcfpncQ==",
      "license": "MIT",
      "engines": {
        "node": ">=18"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    }
  }
}

{
  "name": "sample-find-up-simple",
  "version": "1.0.0",
  "description": "Clean-room sample verifying pkg:npm/find-up-simple@1.0.1 functionality",
  "type": "module",
  "main": "index.js",
  "license": "MIT-0",
  "dependencies": {
    "find-up-simple": "1.0.1"
  }
}

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

import assert from 'node:assert/strict';
import fs from 'node:fs';
import path from 'node:path';
import os from 'node:os';
import { findUp, findUpSync, locatePath, locatePathSync } from '../index.js';

const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'csx-findup-contract-'));

try {
  const rootDir = path.join(tmpDir, 'project');
  const subDir = path.join(rootDir, 'packages', 'app');
  fs.mkdirSync(subDir, { recursive: true });

  const rootConfig = path.join(rootDir, 'config.json');
  fs.writeFileSync(rootConfig, JSON.stringify({ name: 'test-project' }));

  const subConfig = path.join(subDir, 'local.json');
  fs.writeFileSync(subConfig, JSON.stringify({ local: true }));

  // 1. findUp finds target file by walking up parent directories and returns its absolute path
  const foundRoot = await locatePath('config.json', { cwd: subDir });
  assert.strictEqual(
    foundRoot,
    rootConfig,
    'findUp finds target file by walking up parent directories and returns its absolute path'
  );
  const foundDirect = await findUp('config.json', { cwd: subDir });
  assert.strictEqual(foundDirect, rootConfig);

  // 2. findUp respects stopAt boundary and returns undefined if match is beyond stopAt
  const foundWithStop = await locatePath('config.json', {
    cwd: subDir,
    stopAt: path.join(rootDir, 'packages'),
  });
  assert.strictEqual(
    foundWithStop,
    undefined,
    'findUp respects stopAt boundary and returns undefined if match is beyond stopAt'
  );

  // 3. findUp matches directory when type option is set to directory
  const foundDir = await locatePath('packages', {
    cwd: subDir,
    type: 'directory',
  });
  assert.strictEqual(
    foundDir,
    path.join(rootDir, 'packages'),
    'findUp matches directory when type option is set to directory'
  );

  // 4. findUp returns undefined when target file is not found in parent directories
  const foundMissing = await locatePath('non-existent.file', { cwd: subDir });
  assert.strictEqual(
    foundMissing,
    undefined,
    'findUp returns undefined when target file is not found in parent directories'
  );

  // 5. findUpSync synchronously finds target file by walking up parent directories
  const syncFound = locatePathSync('config.json', { cwd: subDir });
  assert.strictEqual(
    syncFound,
    rootConfig,
    'findUpSync synchronously finds target file by walking up parent directories'
  );
  const syncDirect = findUpSync('config.json', { cwd: subDir });
  assert.strictEqual(syncDirect, rootConfig);

  // 6. findUpSync synchronously returns undefined when target file is not found
  const syncMissing = locatePathSync('non-existent.file', { cwd: subDir });
  assert.strictEqual(
    syncMissing,
    undefined,
    'findUpSync synchronously returns undefined when target file is not found'
  );

  console.log('All contract assertions passed.');
} finally {
  fs.rmSync(tmpDir, { recursive: true, force: true });
}