fs-extra 9.1.0: emptyDir

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.emptyDir 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.emptyDir
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:903db1644182fec45496659fd60206cfff32a41e3116848e40f5721ea273add2","constraints":{"executionContext":"node"},"contract":["emptyDir deletes all contents within a directory while leaving the directory itself intact","emptyDir creates the target directory if it does not already exist","emptyDirSync synchronously deletes all contents within a directory while leaving the directory itself intact","emptyDirSync synchronously creates the target directory if it does not already exist"],"goal":"verify fs-extra.emptyDir in pkg:npm/fs-extra@9.1.0","kind":"HOW","packages":["pkg:npm/fs-extra@9.1.0"],"schemaVersion":1,"symbols":["fs-extra.emptyDir"]},"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.emptyDir"],"verifierAdapter":"node-typescript@1"}

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

async function emptyDirectory(dirPath) {
  await fs.emptyDir(dirPath);
}

function emptyDirectorySync(dirPath) {
  fs.emptyDirSync(dirPath);
}

module.exports = {
  emptyDirectory,
  emptyDirectorySync
};

{
  "name": "sample-fs-extra-emptydir",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-fs-extra-emptydir",
      "version": "1.0.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-emptydir",
  "version": "1.0.0",
  "private": true,
  "description": "verify fs-extra.emptyDir in pkg:npm/fs-extra@9.1.0",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "fs-extra": "9.1.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify fs-extra.emptyDir in pkg:npm/fs-extra@9.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/fs-extra@9.1.0"
  ],
  "symbols": [
    "fs-extra.emptyDir"
  ],
  "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 { emptyDirectory, emptyDirectorySync } = require('../index.js');

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

  try {
    // 1. emptyDir deletes all contents within a directory while leaving the directory itself intact
    const dir1 = path.join(tmpBase, 'dir1');
    const subDir1 = path.join(dir1, 'sub1');
    const file1 = path.join(dir1, 'file1.txt');
    const subFile1 = path.join(subDir1, 'nested.txt');

    fs.mkdirSync(subDir1, { recursive: true });
    fs.writeFileSync(file1, 'hello world');
    fs.writeFileSync(subFile1, 'nested data');

    assert.equal(fs.existsSync(file1), true, 'file1 should exist prior to emptyDir');
    assert.equal(fs.existsSync(subFile1), true, 'subFile1 should exist prior to emptyDir');

    await emptyDirectory(dir1);

    assert.equal(fs.existsSync(dir1), true, 'dir1 must still exist after emptyDir');
    assert.deepEqual(fs.readdirSync(dir1), [], 'dir1 must be empty');

    // Also test direct fse.emptyDir
    const directDir = path.join(tmpBase, 'direct-dir');
    fs.mkdirSync(directDir, { recursive: true });
    fs.writeFileSync(path.join(directDir, 'test.txt'), 'content');
    await fse.emptyDir(directDir);
    assert.equal(fs.existsSync(directDir), true);
    assert.deepEqual(fs.readdirSync(directDir), []);

    // 2. emptyDir creates the target directory if it does not already exist
    const nonExistent1 = path.join(tmpBase, 'non-existent-async', 'nested-dir');
    assert.equal(fs.existsSync(nonExistent1), false, 'target should not exist initially');
    await emptyDirectory(nonExistent1);
    assert.equal(fs.existsSync(nonExistent1), true, 'target directory should be created');
    assert.deepEqual(fs.readdirSync(nonExistent1), [], 'created directory should be empty');

    // 3. emptyDirSync synchronously deletes all contents within a directory while leaving the directory itself intact
    const dir2 = path.join(tmpBase, 'dir2');
    const subDir2 = path.join(dir2, 'sub2');
    const file2 = path.join(dir2, 'file2.txt');
    const subFile2 = path.join(subDir2, 'nested2.txt');

    fs.mkdirSync(subDir2, { recursive: true });
    fs.writeFileSync(file2, 'sync test');
    fs.writeFileSync(subFile2, 'nested sync data');

    assert.equal(fs.existsSync(file2), true, 'file2 should exist prior to emptyDirSync');
    assert.equal(fs.existsSync(subFile2), true, 'subFile2 should exist prior to emptyDirSync');

    emptyDirectorySync(dir2);

    assert.equal(fs.existsSync(dir2), true, 'dir2 must still exist after emptyDirSync');
    assert.deepEqual(fs.readdirSync(dir2), [], 'dir2 must be empty');

    // 4. emptyDirSync synchronously creates the target directory if it does not already exist
    const nonExistent2 = path.join(tmpBase, 'non-existent-sync', 'nested-dir-sync');
    assert.equal(fs.existsSync(nonExistent2), false, 'target should not exist initially');
    emptyDirectorySync(nonExistent2);
    assert.equal(fs.existsSync(nonExistent2), true, 'target directory should be created synchronously');
    assert.deepEqual(fs.readdirSync(nonExistent2), [], 'created directory should be empty');

    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);
});