fs-extra 11.4.0: Read, write and copy JSON files without hand-rolling mkdir and parse

{"case":{"caseId":"case:sha256:3a2108811710b1a9c9d38f1b602f821a7f35acec42be0780fdfb0f5a0dfab087","constraints":{"moduleSystem":"esm","runtime":"node"},"contract":["write JSON into a directory that does not exist yet","assert the parent directories were created","assert readJson round-trips the value","assert copy and remove behave as expected"],"goal":"Read, write and copy JSON files without hand-rolling mkdir and parse","kind":"HOW","packages":["pkg:npm/fs-extra@11.4.0"],"schemaVersion":1,"symbols":["fs.outputJson","fs.readJson","fs.copy","fs.pathExists"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","ecosystem":"npm","executionContext":"node","language":"javascript","moduleSystem":"esm","os":"linux","packageManager":"npm","runtime":"node","runtimeVersion":"22","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/fs-extra@11.4.0"],"schemaVersion":1,"symbols":["fs.outputJson","fs.readJson","fs.copy","fs.pathExists"],"verifierAdapter":"node-typescript@1"}

{
  "name": "csx-sample-fs-extra-atomic-json",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "csx-sample-fs-extra-atomic-json",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "fs-extra": "11.4.0"
      }
    },
    "node_modules/fs-extra": {
      "version": "11.4.0",
      "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.4.0.tgz",
      "integrity": "sha512-EQsFzMUJkCKGr1ePqlYADkIUmHW1s3ZXr5Yqy6wbGrfUCphpl2maM/kyOIRA2HpP3AaFQTZXD4ldjek+nccddA==",
      "license": "MIT",
      "dependencies": {
        "graceful-fs": "^4.2.0",
        "jsonfile": "^6.0.1",
        "universalify": "^2.0.0"
      },
      "engines": {
        "node": ">=14.14"
      }
    },
    "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": "csx-sample-fs-extra-atomic-json",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "fs-extra": "11.4.0"
  }
}

import fs from 'fs-extra';

// outputJson is writeJson plus mkdir -p: the plain node equivalent throws
// ENOENT when the directory is missing, which is the single most common
// reason a "write the config file" step fails on a fresh machine.
export async function writeConfig(path, value) {
  await fs.outputJson(path, value, { spaces: 2 });
}

export async function readConfig(path) {
  return fs.readJson(path);
}

import os from 'node:os';
import path from 'node:path';
import fs from 'fs-extra';
import { strict as assert } from 'node:assert';
import { writeConfig, readConfig } from '../src/index.mjs';

const root = await fs.mkdtemp(path.join(os.tmpdir(), 'csx-fsx-'));
const target = path.join(root, 'deep', 'nested', 'config.json');

// The directory does not exist; outputJson creates it.
assert.equal(await fs.pathExists(path.dirname(target)), false);
await writeConfig(target, { name: 'codesamplex', retries: 3 });
assert.equal(await fs.pathExists(target), true);

const back = await readConfig(target);
assert.deepEqual(back, { name: 'codesamplex', retries: 3 });

const copy = path.join(root, 'copy', 'config.json');
await fs.copy(target, copy);
assert.deepEqual(await readConfig(copy), back);

await fs.remove(root);
assert.equal(await fs.pathExists(root), false);

console.log('CONTRACT PASS: fs-extra created parents, round-tripped JSON and cleaned up');