graceful-fs 4.2.11: mkdtempSync

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 graceful-fs.mkdtempSync in pkg:npm/graceful-fs@4.2.11
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/graceful-fs@4.2.11
Demonstrate these symbols/APIs:
  - graceful-fs.mkdtempSync

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:66349aab8b5903a7e82109107fd6cac79f36fea9351b729b0917e9e9051a825d","contract":["gracefulFs.mkdtempSync creates a unique temporary directory with the given prefix and returns its path","gracefulFs.mkdtempSync returns a path starting with the specified prefix and verifies directory existence","gracefulFs.mkdtempSync produces distinct directory paths on consecutive calls with the same prefix","gracefulFs.mkdtempSync supports encoding options such as utf8","gracefulFs.mkdtempSync throws TypeError when prefix argument is not a string","gracefulFs.mkdtempSync throws ENOENT when the parent directory of prefix does not exist"],"goal":"verify graceful-fs.mkdtempSync in pkg:npm/graceful-fs@4.2.11","kind":"HOW","packages":["pkg:npm/graceful-fs@4.2.11"],"schemaVersion":1,"symbols":["graceful-fs.mkdtempSync"]},"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/graceful-fs@4.2.11"],"schemaVersion":1,"subject":"pkg:npm/graceful-fs@4.2.11","symbols":["graceful-fs.mkdtempSync"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-graceful-fs-mkdtemp-sync",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-graceful-fs-mkdtemp-sync",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "graceful-fs": "4.2.11"
      }
    },
    "node_modules/graceful-fs": {
      "version": "4.2.11",
      "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
      "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==",
      "license": "ISC"
    }
  }
}

{
  "name": "sample-graceful-fs-mkdtemp-sync",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room code sample for graceful-fs.mkdtempSync in graceful-fs@4.2.11",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "graceful-fs": "4.2.11"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify graceful-fs.mkdtempSync in pkg:npm/graceful-fs@4.2.11",
  "kind": "HOW",
  "packages": [
    "pkg:npm/graceful-fs@4.2.11"
  ],
  "symbols": [
    "graceful-fs.mkdtempSync"
  ]
}

'use strict';

const fs = require('graceful-fs');

/**
 * Creates a unique temporary directory with the given prefix using graceful-fs.mkdtempSync.
 *
 * @param {string} prefix - Prefix path for the temporary directory.
 * @param {string|object} [options] - Encoding option.
 * @returns {string} The path to the created directory.
 */
function createTempDirSync(prefix, options) {
  return fs.mkdtempSync(prefix, options);
}

module.exports = {
  gracefulFs: fs,
  createTempDirSync
};

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

const require = createRequire(import.meta.url);
const { gracefulFs, createTempDirSync } = require('../src/index.js');

function testAll() {
  // 1. Export verification
  assert.equal(typeof gracefulFs.mkdtempSync, 'function', 'gracefulFs.mkdtempSync must be a function');
  assert.equal(typeof createTempDirSync, 'function', 'createTempDirSync helper must be a function');

  // 2. Directory creation and prefix verification
  const basePrefix = path.join(os.tmpdir(), 'gfs-contract-');
  const tempDir = createTempDirSync(basePrefix);

  try {
    assert.equal(typeof tempDir, 'string', 'mkdtempSync must return a string path');
    assert.ok(tempDir.startsWith(basePrefix), 'created directory path must start with the prefix');
    assert.ok(gracefulFs.existsSync(tempDir), 'created directory must exist on filesystem');
    assert.ok(gracefulFs.statSync(tempDir).isDirectory(), 'created path must be a directory');

    // 3. Unique directory check
    const secondDir = createTempDirSync(basePrefix);
    try {
      assert.notEqual(tempDir, secondDir, 'consecutive mkdtempSync calls must return unique directories');
      assert.ok(gracefulFs.existsSync(secondDir), 'second directory must exist');
    } finally {
      if (gracefulFs.existsSync(secondDir)) {
        gracefulFs.rmdirSync(secondDir);
      }
    }

    // 4. Options support (e.g. utf8 encoding)
    const utf8Dir = createTempDirSync(basePrefix, { encoding: 'utf8' });
    try {
      assert.equal(typeof utf8Dir, 'string', 'utf8 encoding must return string path');
      assert.ok(gracefulFs.existsSync(utf8Dir), 'utf8 encoded directory must exist');
    } finally {
      if (gracefulFs.existsSync(utf8Dir)) {
        gracefulFs.rmdirSync(utf8Dir);
      }
    }

    // 5. Validation and error handling
    assert.throws(
      () => createTempDirSync(12345),
      {
        name: 'TypeError'
      },
      'mkdtempSync must throw TypeError when prefix is not a string'
    );

    const nonExistentParent = path.join(os.tmpdir(), 'non-existent-sub-dir-xyz', 'test-');
    assert.throws(
      () => createTempDirSync(nonExistentParent),
      (err) => err && (err.code === 'ENOENT' || (err.message && err.message.includes('ENOENT'))),
      'mkdtempSync must throw ENOENT when parent directory does not exist'
    );
  } finally {
    if (gracefulFs.existsSync(tempDir)) {
      gracefulFs.rmdirSync(tempDir);
    }
  }

  console.log('All graceful-fs.mkdtempSync contract tests passed successfully.');
}

testAll();