pathe 2.0.3: format

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 pathe.format in pkg:npm/pathe@2.0.3
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/pathe@2.0.3
Demonstrate these symbols/APIs:
  - pathe.format

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:99142b0f0e28799ef0025f16d74a69764678b69957cb134fbaa481ef1a310825","contract":["pathe.format builds a normalized path string from dir and base properties","pathe.format constructs base from name and ext when base is omitted","pathe.format prioritizes base property over name and ext properties when both are present","pathe.format resolves path segments against root when root is specified","pathe.format normalizes Windows backslashes in dir to POSIX forward slashes","pathe.format returns the base or combined name and ext when no directory is provided","pathe.format returns an empty string when an empty object is provided"],"goal":"verify pathe.format in pkg:npm/pathe@2.0.3","kind":"HOW","packages":["pkg:npm/pathe@2.0.3"],"schemaVersion":1,"symbols":["pathe.format"]},"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/pathe@2.0.3"],"schemaVersion":1,"subject":"pkg:npm/pathe@2.0.3","symbols":["pathe.format"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-pathe-format",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-pathe-format",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "pathe": "2.0.3"
      }
    },
    "node_modules/pathe": {
      "version": "2.0.3",
      "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz",
      "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-pathe-format",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification of pathe.format in pkg:npm/pathe@2.0.3",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "pathe": "2.0.3"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pathe.format in pkg:npm/pathe@2.0.3",
  "kind": "HOW",
  "packages": [
    "pkg:npm/pathe@2.0.3"
  ],
  "symbols": [
    "pathe.format"
  ]
}

const { format } = require('pathe');

/**
 * Formats a path object into a path string.
 *
 * @param {object} pathObject - An object with path components (dir, root, base, name, ext).
 * @returns {string} Formatted path string.
 */
function formatPath(pathObject) {
  return format(pathObject);
}

/**
 * Formats a filename from name and extension.
 *
 * @param {string} name - File name without extension.
 * @param {string} ext - File extension including dot.
 * @returns {string} Formatted filename.
 */
function formatFileName(name, ext) {
  return format({ name, ext });
}

module.exports = {
  format,
  formatPath,
  formatFileName
};

import assert from 'node:assert';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const { format, formatPath, formatFileName } = require('../src/index.js');

// 1. pathe.format builds a normalized path string from dir and base properties
assert.strictEqual(format({ dir: 'path/to', base: 'file.txt' }), 'path/to/file.txt');
assert.strictEqual(format({ dir: 'relative/dir', base: 'file.txt' }), 'relative/dir/file.txt');
assert.strictEqual(formatPath({ dir: 'path/to', base: 'file.txt' }), 'path/to/file.txt');

// 2. pathe.format constructs base from name and ext when base is omitted
assert.strictEqual(format({ dir: 'some/folder', name: 'document', ext: '.md' }), 'some/folder/document.md');
assert.strictEqual(format({ dir: 'path/to', name: 'app', ext: '.log' }), 'path/to/app.log');
assert.strictEqual(formatPath({ dir: 'some/folder', name: 'document', ext: '.md' }), 'some/folder/document.md');

// 3. pathe.format prioritizes base property over name and ext properties when both are present
assert.strictEqual(format({ dir: 'path/to', base: 'custom.txt', name: 'ignored', ext: '.log' }), 'path/to/custom.txt');
assert.strictEqual(format({ base: 'override.js', name: 'index', ext: '.ts' }), 'override.js');
assert.strictEqual(formatPath({ dir: 'path/to', base: 'custom.txt', name: 'ignored', ext: '.log' }), 'path/to/custom.txt');

// 4. pathe.format resolves path segments against root when root is specified
assert.strictEqual(format({ root: '/', base: 'file.txt' }), '/file.txt');
assert.strictEqual(format({ root: '/', dir: 'path/to', base: 'file.txt' }), '/path/to/file.txt');
assert.strictEqual(formatPath({ root: '/', base: 'file.txt' }), '/file.txt');

// 5. pathe.format normalizes Windows backslashes in dir to POSIX forward slashes
assert.strictEqual(format({ dir: 'dir\\subdir', base: 'config.json' }), 'dir/subdir/config.json');
assert.strictEqual(format({ dir: 'foo\\bar\\baz', name: 'index', ext: '.js' }), 'foo/bar/baz/index.js');
assert.strictEqual(formatPath({ dir: 'dir\\subdir', base: 'config.json' }), 'dir/subdir/config.json');

// 6. pathe.format returns the base or combined name and ext when no directory is provided
assert.strictEqual(format({ base: 'index.js' }), 'index.js');
assert.strictEqual(format({ name: 'app', ext: '.ts' }), 'app.ts');
assert.strictEqual(formatFileName('document', '.pdf'), 'document.pdf');

// 7. pathe.format returns an empty string when an empty object is provided
assert.strictEqual(format({}), '');
assert.strictEqual(formatPath({}), '');

console.log('Contract tests passed successfully.');