graceful-fs 4.2.11: rmdirSync

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.rmdirSync 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.rmdirSync

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:462a82df15239ceec4bedd60e60ce0f403f920f7e84774e68d458c74932cc091","contract":["gracefulFs.rmdirSync synchronously removes an existing empty directory and returns undefined","gracefulFs.rmdirSync accepts a directory path as a file URL or Buffer and removes it","gracefulFs.rmdirSync throws ENOENT when the target directory does not exist","gracefulFs.rmdirSync throws ENOTDIR when the target path points to an existing file","gracefulFs.rmdirSync throws ENOTEMPTY or EEXIST when attempting to remove a non-empty directory","gracefulFs.rmdirSync throws TypeError when the path argument is not a valid path string, Buffer, or URL"],"goal":"verify graceful-fs.rmdirSync in pkg:npm/graceful-fs@4.2.11","kind":"HOW","packages":["pkg:npm/graceful-fs@4.2.11"],"schemaVersion":1,"symbols":["graceful-fs.rmdirSync"]},"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.rmdirSync"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-graceful-fs-rmdir-sync",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-graceful-fs-rmdir-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-rmdir-sync",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room code sample for graceful-fs.rmdirSync 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.rmdirSync in pkg:npm/graceful-fs@4.2.11",
  "kind": "HOW",
  "packages": [
    "pkg:npm/graceful-fs@4.2.11"
  ],
  "symbols": [
    "graceful-fs.rmdirSync"
  ]
}

'use strict';

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

/**
 * Removes an empty directory synchronously using graceful-fs.rmdirSync.
 *
 * @param {string|Buffer|URL} dirPath - Path to the directory to remove.
 * @param {object} [options] - Optional options object passed to rmdirSync.
 * @returns {void}
 */
function removeDirSync(dirPath, options) {
  return fs.rmdirSync(dirPath, options);
}

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

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

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

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

  // 2. Synchronous removal of an empty directory
  const basePrefix = path.join(os.tmpdir(), 'gfs-rmdir-');
  const tempDir1 = gracefulFs.mkdtempSync(basePrefix);
  assert.ok(gracefulFs.existsSync(tempDir1), 'temp directory must exist before rmdirSync');
  try {
    const result = gracefulFs.rmdirSync(tempDir1);
    assert.equal(result, undefined, 'rmdirSync must return undefined on success');
    assert.equal(gracefulFs.existsSync(tempDir1), false, 'directory must not exist after rmdirSync');
  } finally {
    if (gracefulFs.existsSync(tempDir1)) {
      gracefulFs.rmdirSync(tempDir1);
    }
  }

  // 3. Helper function removal
  const tempDirHelper = gracefulFs.mkdtempSync(basePrefix);
  assert.ok(gracefulFs.existsSync(tempDirHelper), 'helper target directory must exist');
  try {
    const helperResult = removeDirSync(tempDirHelper);
    assert.equal(helperResult, undefined, 'removeDirSync helper must return undefined on success');
    assert.equal(gracefulFs.existsSync(tempDirHelper), false, 'directory must not exist after removeDirSync');
  } finally {
    if (gracefulFs.existsSync(tempDirHelper)) {
      gracefulFs.rmdirSync(tempDirHelper);
    }
  }

  // 4. Accepts URL and Buffer paths
  const tempDirUrl = gracefulFs.mkdtempSync(basePrefix);
  try {
    const url = pathToFileURL(tempDirUrl);
    gracefulFs.rmdirSync(url);
    assert.equal(gracefulFs.existsSync(tempDirUrl), false, 'directory must be removed via URL path');
  } finally {
    if (gracefulFs.existsSync(tempDirUrl)) {
      gracefulFs.rmdirSync(tempDirUrl);
    }
  }

  const tempDirBuf = gracefulFs.mkdtempSync(basePrefix);
  try {
    const buf = Buffer.from(tempDirBuf);
    gracefulFs.rmdirSync(buf);
    assert.equal(gracefulFs.existsSync(tempDirBuf), false, 'directory must be removed via Buffer path');
  } finally {
    if (gracefulFs.existsSync(tempDirBuf)) {
      gracefulFs.rmdirSync(tempDirBuf);
    }
  }

  // 5. Throws ENOENT when directory does not exist
  const nonExistent = path.join(os.tmpdir(), 'gfs-nonexistent-dir-' + Date.now());
  assert.throws(
    () => gracefulFs.rmdirSync(nonExistent),
    (err) => err && (err.code === 'ENOENT' || (err.message && err.message.includes('ENOENT'))),
    'rmdirSync must throw ENOENT when directory does not exist'
  );

  // 6. Throws ENOTDIR when target is an existing file
  const tempFile = path.join(os.tmpdir(), 'gfs-file-' + Date.now());
  gracefulFs.writeFileSync(tempFile, 'contract test file');
  try {
    assert.throws(
      () => gracefulFs.rmdirSync(tempFile),
      (err) => err && (err.code === 'ENOTDIR' || (err.message && err.message.includes('ENOTDIR'))),
      'rmdirSync must throw ENOTDIR when target path is a file'
    );
  } finally {
    if (gracefulFs.existsSync(tempFile)) {
      gracefulFs.unlinkSync(tempFile);
    }
  }

  // 7. Throws ENOTEMPTY or EEXIST when directory is not empty
  const notEmptyDir = gracefulFs.mkdtempSync(basePrefix);
  const childFile = path.join(notEmptyDir, 'child.txt');
  gracefulFs.writeFileSync(childFile, 'child file content');
  try {
    assert.throws(
      () => gracefulFs.rmdirSync(notEmptyDir),
      (err) => err && (err.code === 'ENOTEMPTY' || err.code === 'EEXIST' || (err.message && (err.message.includes('ENOTEMPTY') || err.message.includes('EEXIST')))),
      'rmdirSync must throw ENOTEMPTY or EEXIST when directory is not empty'
    );
  } finally {
    if (gracefulFs.existsSync(childFile)) {
      gracefulFs.unlinkSync(childFile);
    }
    if (gracefulFs.existsSync(notEmptyDir)) {
      gracefulFs.rmdirSync(notEmptyDir);
    }
  }

  // 8. Throws TypeError on invalid argument types
  assert.throws(
    () => gracefulFs.rmdirSync(12345),
    {
      name: 'TypeError'
    },
    'rmdirSync must throw TypeError when path is a number'
  );
  assert.throws(
    () => gracefulFs.rmdirSync(null),
    {
      name: 'TypeError'
    },
    'rmdirSync must throw TypeError when path is null'
  );

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

testAll();