fs-extra 9.1.0: ensureDir

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 fs-extra.ensureDir in pkg:npm/fs-extra@9.1.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/fs-extra@9.1.0
Demonstrate these symbols/APIs:
  - fs-extra.ensureDir
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:490cfe0afcfdd98d1c9c0c78d29c552e1aa28782a508d0e08b92d2a848fb5fa6","constraints":{"executionContext":"node"},"contract":["ensureDir creates nested directory structures asynchronously if they do not exist","ensureDir resolves successfully when the target directory already exists","ensureDirSync synchronously creates nested directory structures if they do not exist","ensureDirSync executes synchronously without error when the target directory already exists","ensureDir supports custom directory permissions mode option"],"goal":"verify fs-extra.ensureDir in pkg:npm/fs-extra@9.1.0","kind":"HOW","packages":["pkg:npm/fs-extra@9.1.0"],"schemaVersion":1,"symbols":["fs-extra.ensureDir"]},"contractCommand":["node","test/contract.cjs"],"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/fs-extra@9.1.0"],"schemaVersion":1,"subject":"pkg:npm/fs-extra@9.1.0","symbols":["fs-extra.ensureDir"],"verifierAdapter":"node-typescript@1"}

'use strict';

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

async function createDirectory(dirPath, options) {
  return await fs.ensureDir(dirPath, options);
}

function createDirectorySync(dirPath, options) {
  return fs.ensureDirSync(dirPath, options);
}

module.exports = {
  createDirectory,
  createDirectorySync,
  ensureDir: fs.ensureDir,
  ensureDirSync: fs.ensureDirSync
};

{
  "name": "sample-fs-extra-ensuredir",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-fs-extra-ensuredir",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "fs-extra": "9.1.0"
      }
    },
    "node_modules/at-least-node": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
      "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==",
      "license": "ISC",
      "engines": {
        "node": ">= 4.0.0"
      }
    },
    "node_modules/fs-extra": {
      "version": "9.1.0",
      "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
      "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
      "license": "MIT",
      "dependencies": {
        "at-least-node": "^1.0.0",
        "graceful-fs": "^4.2.0",
        "jsonfile": "^6.0.1",
        "universalify": "^2.0.0"
      },
      "engines": {
        "node": ">=10"
      }
    },
    "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"
    },
    "node_modules/jsonfile": {
      "version": "6.2.1",
      "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.1.tgz",
      "integrity": "sha512-zwOTdL3rFQ/lRdBnntKVOX6k5cKJwEc1HdilT71BWEu7J41gXIB2MRp+vxduPSwZJPWBxEzv4yH1wYLJGUHX4Q==",
      "license": "MIT",
      "dependencies": {
        "universalify": "^2.0.0"
      },
      "optionalDependencies": {
        "graceful-fs": "^4.1.6"
      }
    },
    "node_modules/universalify": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz",
      "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==",
      "license": "MIT",
      "engines": {
        "node": ">= 10.0.0"
      }
    }
  }
}

{
  "name": "sample-fs-extra-ensuredir",
  "version": "1.0.0",
  "private": true,
  "description": "verify fs-extra.ensureDir in pkg:npm/fs-extra@9.1.0",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "fs-extra": "9.1.0"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify fs-extra.ensureDir in pkg:npm/fs-extra@9.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/fs-extra@9.1.0"
  ],
  "symbols": [
    "fs-extra.ensureDir"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
const os = require('os');
const fse = require('fs-extra');
const {
  createDirectory,
  createDirectorySync,
  ensureDir,
  ensureDirSync
} = require('../index.js');

async function runTests() {
  const tmpBase = fs.mkdtempSync(path.join(os.tmpdir(), 'fse-ensuredir-contract-'));

  try {
    // 1. ensureDir creates nested directory structures asynchronously if they do not exist
    const nestedAsyncDir = path.join(tmpBase, 'async-parent', 'nested', 'target');
    assert.equal(fs.existsSync(nestedAsyncDir), false, 'target directory must not exist prior to ensureDir');

    await createDirectory(nestedAsyncDir);
    assert.equal(fs.existsSync(nestedAsyncDir), true, 'nestedAsyncDir must exist after createDirectory');
    assert.equal(fs.statSync(nestedAsyncDir).isDirectory(), true, 'created target must be a directory');

    // Direct fs-extra.ensureDir call
    const directAsyncDir = path.join(tmpBase, 'direct-async', 'sub', 'folder');
    await ensureDir(directAsyncDir);
    assert.equal(fs.existsSync(directAsyncDir), true, 'directAsyncDir must exist after ensureDir');
    assert.equal(fs.statSync(directAsyncDir).isDirectory(), true, 'created target must be a directory');

    // 2. ensureDir resolves successfully when the target directory already exists
    await createDirectory(nestedAsyncDir);
    assert.equal(fs.existsSync(nestedAsyncDir), true, 'nestedAsyncDir must still exist');

    await ensureDir(directAsyncDir);
    assert.equal(fs.existsSync(directAsyncDir), true, 'directAsyncDir must still exist');

    // 3. ensureDirSync synchronously creates nested directory structures if they do not exist
    const nestedSyncDir = path.join(tmpBase, 'sync-parent', 'nested', 'target');
    assert.equal(fs.existsSync(nestedSyncDir), false, 'target directory must not exist prior to ensureDirSync');

    createDirectorySync(nestedSyncDir);
    assert.equal(fs.existsSync(nestedSyncDir), true, 'nestedSyncDir must exist after createDirectorySync');
    assert.equal(fs.statSync(nestedSyncDir).isDirectory(), true, 'created target must be a directory');

    // Direct fs-extra.ensureDirSync call
    const directSyncDir = path.join(tmpBase, 'direct-sync', 'sub', 'folder');
    ensureDirSync(directSyncDir);
    assert.equal(fs.existsSync(directSyncDir), true, 'directSyncDir must exist after ensureDirSync');
    assert.equal(fs.statSync(directSyncDir).isDirectory(), true, 'created target must be a directory');

    // 4. ensureDirSync executes synchronously without error when the target directory already exists
    assert.doesNotThrow(() => {
      createDirectorySync(nestedSyncDir);
    }, 'createDirectorySync on existing directory should not throw');
    assert.equal(fs.existsSync(nestedSyncDir), true);

    assert.doesNotThrow(() => {
      ensureDirSync(directSyncDir);
    }, 'ensureDirSync on existing directory should not throw');
    assert.equal(fs.existsSync(directSyncDir), true);

    // 5. ensureDir supports custom directory permissions mode option
    const customModeDir = path.join(tmpBase, 'mode-async', 'sub');
    await ensureDir(customModeDir, 0o755);
    assert.equal(fs.existsSync(customModeDir), true, 'customModeDir must exist');

    console.log('Contract tests passed successfully.');
  } finally {
    try {
      fs.rmSync(tmpBase, { recursive: true, force: true });
    } catch {
      // ignore cleanup errors
    }
  }
}

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