walk-up-path 3.0.1: walkUp

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 walk-up-path.walkUp in pkg:npm/walk-up-path@3.0.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/walk-up-path@3.0.1
Demonstrate these symbols/APIs:
  - walk-up-path.walkUp

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:0d6b4b1ead0c8e8f1a61807b60be8b16a05233d8a0e7ff8740db91e35eaae33c","contract":["walkUp(targetPath) returns a synchronous Generator yielding the resolved path followed by each successive parent directory via path.dirname until the filesystem root is reached","Calling gen.next() after the filesystem root has been yielded returns { value: undefined, done: true }","Passing a relative path to walkUp resolves it via path.resolve before yielding each ancestor directory up to the root"],"goal":"verify walk-up-path.walkUp in pkg:npm/walk-up-path@3.0.1","kind":"HOW","packages":["pkg:npm/walk-up-path@3.0.1"],"schemaVersion":1,"symbols":["walk-up-path.walkUp"]},"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/walk-up-path@3.0.1"],"schemaVersion":1,"subject":"pkg:npm/walk-up-path@3.0.1","symbols":["walk-up-path.walkUp"],"verifierAdapter":"node-typescript@1"}

{
  "name": "walk-up-path-sample",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "walk-up-path-sample",
      "version": "1.0.0",
      "dependencies": {
        "walk-up-path": "3.0.1"
      }
    },
    "node_modules/walk-up-path": {
      "version": "3.0.1",
      "resolved": "https://registry.npmjs.org/walk-up-path/-/walk-up-path-3.0.1.tgz",
      "integrity": "sha512-9YlCL/ynK3CTlrSRrDxZvUauLzAswPCrsaCgilqFevUYpeEW0/3ScEjaa3kbW/T0ghhkEr7mv+fpjqn1Y1YuTA==",
      "license": "ISC"
    }
  }
}

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

{
  "schemaVersion": 1,
  "goal": "verify walk-up-path.walkUp in pkg:npm/walk-up-path@3.0.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/walk-up-path@3.0.1"
  ],
  "symbols": [
    "walk-up-path.walkUp"
  ]
}

import { walkUp } from "walk-up-path";

export function collectWalkUp(targetPath) {
  const generator = walkUp(targetPath);
  return Array.from(generator);
}

export function stepWalkUp(targetPath) {
  return walkUp(targetPath);
}

import assert from "node:assert/strict";
import path from "node:path";
import { walkUp } from "walk-up-path";
import { collectWalkUp, stepWalkUp } from "../src/index.mjs";

const rootDir = path.parse(process.cwd()).root;
const deepPath = path.join(rootDir, "alpha", "beta", "gamma");

// 1. Walking up a path yields each ancestor directory from the resolved path up to the root
const steps = collectWalkUp(deepPath);
assert.deepEqual(steps, [
  path.join(rootDir, "alpha", "beta", "gamma"),
  path.join(rootDir, "alpha", "beta"),
  path.join(rootDir, "alpha"),
  rootDir,
]);

// 2. walkUp returns a synchronous Generator that yields each dirname and terminates after root
const gen = stepWalkUp(path.join(rootDir, "one", "two"));
assert.equal(typeof gen.next, "function");
assert.equal(typeof gen[Symbol.iterator], "function");
assert.deepEqual(gen.next(), { value: path.join(rootDir, "one", "two"), done: false });
assert.deepEqual(gen.next(), { value: path.join(rootDir, "one"), done: false });
assert.deepEqual(gen.next(), { value: rootDir, done: false });
assert.deepEqual(gen.next(), { value: undefined, done: true });

// 3. Relative paths are resolved via path.resolve before walking up to root
const relativeInput = path.join("sub", "leaf");
const resolvedSteps = Array.from(walkUp(relativeInput));
assert.equal(resolvedSteps[0], path.resolve(relativeInput));
assert.equal(resolvedSteps[1], path.dirname(path.resolve(relativeInput)));
assert.equal(resolvedSteps.at(-1), rootDir);