stat-mode 1.0.0

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/stat-mode@1.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/stat-mode@1.0.0

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:77a18e757d7ed197769c93109457149e9ed6650017230f29b69c286eb417f9d0","contract":["Mode parses numeric mode and verifies isFile, isDirectory, and permissions","Mode wraps an fs.Stat-like object and mutates its mode property in-place","Mode converts permissions to octal string representation via toOctal","Mode converts file mode and permissions to ls-style symbolic string via toString","Mode toggles setuid, setgid, sticky flags and updates mode bitmask","isStatsMode validates objects containing numeric mode property"],"goal":"verify pkg:npm/stat-mode@1.0.0","kind":"HOW","packages":["pkg:npm/stat-mode@1.0.0"],"schemaVersion":1},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/stat-mode@1.0.0"],"schemaVersion":1,"subject":"pkg:npm/stat-mode@1.0.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-stat-mode",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-stat-mode",
      "version": "1.0.0",
      "dependencies": {
        "stat-mode": "1.0.0"
      }
    },
    "node_modules/stat-mode": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/stat-mode/-/stat-mode-1.0.0.tgz",
      "integrity": "sha512-jH9EhtKIjuXZ2cWxmXS8ZP80XyC3iasQxMDV8jzhNJpfDb7VbQLVW4Wvsxz9QZvzV+G4YoSfBUVKDOyxLzi/sg==",
      "license": "MIT",
      "engines": {
        "node": ">= 6"
      }
    }
  }
}

{
  "name": "sample-stat-mode",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "stat-mode": "1.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/stat-mode@1.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/stat-mode@1.0.0"
  ]
}

import assert from 'node:assert/strict';
import Mode from 'stat-mode';

const { isStatsMode } = Mode;

// 1. Mode parses numeric mode and verifies isFile, isDirectory, and permissions
{
  const mode = new Mode(0o100644);
  assert.equal(mode.isFile(), true);
  assert.equal(mode.isDirectory(), false);
  assert.equal(mode.owner.read, true);
  assert.equal(mode.owner.write, true);
  assert.equal(mode.owner.execute, false);
  assert.equal(mode.group.read, true);
  assert.equal(mode.group.write, false);
  assert.equal(mode.group.execute, false);
  assert.equal(mode.others.read, true);
  assert.equal(mode.others.write, false);
  assert.equal(mode.others.execute, false);
}

// 2. Mode wraps an fs.Stat-like object and mutates its mode property in-place
{
  const statObj = { mode: 0o040755 };
  const mode = Mode(statObj);
  assert.equal(mode.isDirectory(), true);
  assert.equal(mode.group.write, false);

  mode.group.write = true;
  assert.equal(mode.group.write, true);
  assert.equal(statObj.mode, 0o040775);

  mode.owner.execute = false;
  assert.equal(mode.owner.execute, false);
  assert.equal(statObj.mode, 0o040675);
}

// 3. Mode converts permissions to octal string representation via toOctal
{
  const fileMode = new Mode(0o100754);
  assert.equal(fileMode.toOctal(), '0754');

  const dirMode = new Mode(0o040755);
  assert.equal(dirMode.toOctal(), '0755');
}

// 4. Mode converts file mode and permissions to ls-style symbolic string via toString
{
  const regularFile = new Mode(0o100644);
  assert.equal(regularFile.toString(), '-rw-r--r--');

  const directory = new Mode(0o040755);
  assert.equal(directory.toString(), 'drwxr-xr-x');

  const symlink = new Mode(0o120777);
  assert.equal(symlink.toString(), 'lrwxrwxrwx');
}

// 5. Mode toggles setuid, setgid, sticky flags and updates mode bitmask
{
  const mode = new Mode(0o100755);
  assert.equal(mode.setuid, false);
  assert.equal(mode.setgid, false);
  assert.equal(mode.sticky, false);

  mode.setuid = true;
  mode.setgid = true;
  mode.sticky = true;
  assert.equal(mode.setuid, true);
  assert.equal(mode.setgid, true);
  assert.equal(mode.sticky, true);
  assert.equal(mode.toOctal(), '7755');
  assert.equal(mode.toString(), '-rwsr-sr-t');
}

// 6. isStatsMode validates objects containing numeric mode property
{
  assert.equal(Boolean(isStatsMode({ mode: 0o644 })), true);
  assert.equal(Boolean(isStatsMode({ mode: 0 })), true);
  assert.equal(Boolean(isStatsMode({ mode: '644' })), false);
  assert.equal(Boolean(isStatsMode(null)), false);
  assert.equal(Boolean(isStatsMode(undefined)), false);
  assert.equal(Boolean(isStatsMode(123)), false);
}