rimraf 2.6.3: sync

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 pkg:npm/rimraf@2.6.3
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/rimraf@2.6.3
Demonstrate these symbols/APIs:
  - rimraf
  - rimraf.sync

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:c016fb27ded714d999975fbefc0e677c500eb8513ee84e94e60594839bbd8e62","contract":["rimraf asynchronously removes a single file without error","rimraf asynchronously removes nested directory structures and all contained files","rimraf asynchronously completes without error when target path does not exist","rimraf.sync synchronously removes a single file without error","rimraf.sync synchronously removes nested directory structures and all contained files","rimraf.sync synchronously completes without throwing when target path does not exist"],"goal":"verify pkg:npm/rimraf@2.6.3","kind":"HOW","packages":["pkg:npm/rimraf@2.6.3"],"schemaVersion":1,"symbols":["rimraf","rimraf.sync"]},"contractCommand":["node","test/contract.js"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","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/rimraf@2.6.3"],"schemaVersion":1,"subject":"pkg:npm/rimraf@2.6.3","symbols":["rimraf","rimraf.sync"],"verifierAdapter":"node-typescript@1"}

'use strict';

const rimraf = require('rimraf');

/**
 * Asynchronously removes a file or directory path using rimraf.
 * Returns a Promise that resolves when removal completes.
 */
function removePath(targetPath, options = {}) {
  return new Promise((resolve, reject) => {
    rimraf(targetPath, options, (err) => {
      if (err) {
        reject(err);
      } else {
        resolve();
      }
    });
  });
}

/**
 * Synchronously removes a file or directory path using rimraf.sync.
 */
function removePathSync(targetPath, options = {}) {
  rimraf.sync(targetPath, options);
}

module.exports = {
  rimraf,
  removePath,
  removePathSync
};

{
  "name": "sample-rimraf",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-rimraf",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "rimraf": "2.6.3"
      }
    },
    "node_modules/balanced-match": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
      "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
      "license": "MIT"
    },
    "node_modules/brace-expansion": {
      "version": "1.1.18",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.18.tgz",
      "integrity": "sha512-Edep/X9fGqVNmzKBVsDYIOtD+z1tuezV70LBjdCst9Tqu76lsnvRiZ6oTic1n+/BIwX6QDGAO94PN4N2SADvtw==",
      "license": "MIT",
      "dependencies": {
        "balanced-match": "^1.0.0",
        "concat-map": "0.0.1"
      }
    },
    "node_modules/concat-map": {
      "version": "0.0.1",
      "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
      "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==",
      "license": "MIT"
    },
    "node_modules/fs.realpath": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
      "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==",
      "license": "ISC"
    },
    "node_modules/glob": {
      "version": "7.2.3",
      "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz",
      "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==",
      "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me",
      "license": "ISC",
      "dependencies": {
        "fs.realpath": "^1.0.0",
        "inflight": "^1.0.4",
        "inherits": "2",
        "minimatch": "^3.1.1",
        "once": "^1.3.0",
        "path-is-absolute": "^1.0.0"
      },
      "engines": {
        "node": "*"
      },
      "funding": {
        "url": "https://github.com/sponsors/isaacs"
      }
    },
    "node_modules/inflight": {
      "version": "1.0.6",
      "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
      "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==",
      "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.",
      "license": "ISC",
      "dependencies": {
        "once": "^1.3.0",
        "wrappy": "1"
      }
    },
    "node_modules/inherits": {
      "version": "2.0.4",
      "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
      "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
      "license": "ISC"
    },
    "node_modules/minimatch": {
      "version": "3.1.5",
      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz",
      "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==",
      "license": "ISC",
      "dependencies": {
        "brace-expansion": "^1.1.7"
      },
      "engines": {
        "node": "*"
      }
    },
    "node_modules/once": {
      "version": "1.4.0",
      "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
      "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
      "license": "ISC",
      "dependencies": {
        "wrappy": "1"
      }
    },
    "node_modules/path-is-absolute": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
      "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==",
      "license": "MIT",
      "engines": {
        "node": ">=0.10.0"
      }
    },
    "node_modules/rimraf": {
      "version": "2.6.3",
      "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz",
      "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==",
      "deprecated": "Rimraf versions prior to v4 are no longer supported",
      "license": "ISC",
      "dependencies": {
        "glob": "^7.1.3"
      },
      "bin": {
        "rimraf": "bin.js"
      }
    },
    "node_modules/wrappy": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
      "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
      "license": "ISC"
    }
  }
}

{
  "name": "sample-rimraf",
  "version": "1.0.0",
  "private": true,
  "description": "verify pkg:npm/rimraf@2.6.3",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "rimraf": "2.6.3"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/rimraf@2.6.3",
  "kind": "HOW",
  "packages": [
    "pkg:npm/rimraf@2.6.3"
  ],
  "symbols": [
    "rimraf",
    "rimraf.sync"
  ]
}

'use strict';

const assert = require('assert');
const fs = require('fs');
const path = require('path');
const os = require('os');
const rimraf = require('rimraf');
const { removePath, removePathSync } = require('../index.js');

async function testAsyncRemoval(tmpDir) {
  // Test async rimraf on single file
  const testFile = path.join(tmpDir, 'async-file.txt');
  fs.writeFileSync(testFile, 'test content', 'utf8');
  assert.strictEqual(fs.existsSync(testFile), true, 'File should exist before async rimraf');

  await new Promise((resolve, reject) => {
    rimraf(testFile, (err) => {
      if (err) reject(err);
      else resolve();
    });
  });
  assert.strictEqual(fs.existsSync(testFile), false, 'rimraf should delete single file asynchronously');

  // Test async rimraf on directory structure with nested files and subdirectories
  const testDir = path.join(tmpDir, 'async-dir');
  const subDir = path.join(testDir, 'sub');
  fs.mkdirSync(subDir, { recursive: true });
  fs.writeFileSync(path.join(testDir, 'file1.txt'), 'data1', 'utf8');
  fs.writeFileSync(path.join(subDir, 'file2.txt'), 'data2', 'utf8');
  assert.strictEqual(fs.existsSync(testDir), true, 'Directory should exist before async rimraf');

  await removePath(testDir);
  assert.strictEqual(fs.existsSync(testDir), false, 'removePath helper should delete nested directory asynchronously');

  // Test async rimraf on non-existent path (should not throw / should resolve with no error)
  const nonExistent = path.join(tmpDir, 'non-existent-async');
  await removePath(nonExistent);
  assert.strictEqual(fs.existsSync(nonExistent), false, 'rimraf on non-existent path should succeed without error');
}

function testSyncRemoval(tmpDir) {
  // Test synchronous rimraf.sync on single file
  const testFile = path.join(tmpDir, 'sync-file.txt');
  fs.writeFileSync(testFile, 'sync content', 'utf8');
  assert.strictEqual(fs.existsSync(testFile), true, 'File should exist before rimraf.sync');

  rimraf.sync(testFile);
  assert.strictEqual(fs.existsSync(testFile), false, 'rimraf.sync should delete single file synchronously');

  // Test synchronous rimraf.sync on nested directory structure
  const testDir = path.join(tmpDir, 'sync-dir');
  const subDir = path.join(testDir, 'nested', 'deep');
  fs.mkdirSync(subDir, { recursive: true });
  fs.writeFileSync(path.join(testDir, 'root.txt'), 'root', 'utf8');
  fs.writeFileSync(path.join(subDir, 'leaf.txt'), 'leaf', 'utf8');
  assert.strictEqual(fs.existsSync(testDir), true, 'Directory should exist before rimraf.sync');

  removePathSync(testDir);
  assert.strictEqual(fs.existsSync(testDir), false, 'removePathSync helper should delete nested directory synchronously');

  // Test rimraf.sync on non-existent path
  const nonExistent = path.join(tmpDir, 'non-existent-sync');
  assert.doesNotThrow(() => {
    rimraf.sync(nonExistent);
  }, 'rimraf.sync on non-existent path should not throw');
}

async function main() {
  const tmpBase = fs.mkdtempSync(path.join(os.tmpdir(), 'csx-rimraf-contract-'));
  try {
    await testAsyncRemoval(tmpBase);
    testSyncRemoval(tmpBase);
    console.log('Contract tests passed successfully.');
  } finally {
    try {
      if (fs.existsSync(tmpBase)) {
        rimraf.sync(tmpBase);
      }
    } catch (e) {
      // ignore cleanup failure
    }
  }
}

main().catch((err) => {
  console.error('Contract test failed:', err);
  process.exit(1);
});