bare-os 3.9.3: devNull

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 devNull in pkg:npm/bare-os@3.9.3
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/bare-os@3.9.3
Demonstrate these symbols/APIs:
  - devNull

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:a9259d3161d855469758927eedebf54e272561597790afe01a73efa9987fd4f3","contract":["bare-os package manifest specifies bare-os 3.9.3 with Bare addon configuration and exports for root and package subpaths","declares devNull as null device union ('\\\\.\\nul' | '/dev/null') in TypeScript definitions (index.d.ts)","exports devNull conditionally formatted as '\\\\.\\nul' on win32 platforms and '/dev/null' on POSIX systems","evaluates devNull string path properties and verifies platform-specific null device redirection targets","ships native Bare C addon binding and multi-platform prebuild artifacts for platform detection"],"goal":"verify devNull in pkg:npm/bare-os@3.9.3","kind":"HOW","packages":["pkg:npm/bare-os@3.9.3"],"schemaVersion":1,"symbols":["devNull"]},"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/bare-os@3.9.3"],"schemaVersion":1,"subject":"pkg:npm/bare-os@3.9.3","symbols":["devNull"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-bare-os-devnull",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-bare-os-devnull",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "bare-os": "3.9.3"
      }
    },
    "node_modules/bare-os": {
      "version": "3.9.3",
      "resolved": "https://registry.npmjs.org/bare-os/-/bare-os-3.9.3.tgz",
      "integrity": "sha512-fF4Q7QsyKVF5Rj0qvI8BgUNjqzC2JvQlpTaPLjVJVxYVUX5Zr9un+y3w1HmA4nNKdFmRBT8z/WmrjvXzXVerKQ==",
      "license": "Apache-2.0",
      "engines": {
        "bare": ">=1.14.0"
      }
    }
  }
}

{
  "name": "sample-bare-os-devnull",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "bare-os": "3.9.3"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify devNull in pkg:npm/bare-os@3.9.3",
  "kind": "HOW",
  "packages": [
    "pkg:npm/bare-os@3.9.3"
  ],
  "symbols": [
    "devNull"
  ]
}

import assert from 'node:assert/strict';
import { createRequire } from 'node:module';
import fs from 'node:fs';
import path from 'node:path';
import Module from 'node:module';

const require = createRequire(import.meta.url);

// 1. Resolve bare-os package manifest and verify exports and metadata
const pkgPath = require.resolve('bare-os/package');
const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));

assert.equal(pkg.name, 'bare-os', 'Package name must be bare-os');
assert.equal(pkg.version, '3.9.3', 'Package version must be 3.9.3');
assert.equal(pkg.license, 'Apache-2.0', 'Package license must be Apache-2.0');
assert.equal(pkg.addon, true, 'Package must be marked as addon');
assert.equal(pkg.engines?.bare, '>=1.14.0', 'Package must specify Bare engine >=1.14.0');

assert.ok(pkg.exports, 'Package must define exports');
assert.equal(pkg.exports['.']?.types, './index.d.ts', 'Root export must have index.d.ts types');
assert.equal(pkg.exports['.']?.default, './index.js', 'Root export must have index.js default');
assert.equal(pkg.exports['./package'], './package.json', 'Package export must point to package.json');

const pkgDir = path.dirname(pkgPath);

// 2. Verify index.d.ts type declarations for devNull
const indexDts = fs.readFileSync(path.join(pkgDir, 'index.d.ts'), 'utf8');
assert.ok(
  indexDts.includes('export const devNull') && indexDts.includes('/dev/null') && indexDts.includes('nul'),
  'index.d.ts must declare devNull as null device union'
);
assert.ok(
  indexDts.includes('export const EOL'),
  'index.d.ts must declare EOL as newline union'
);
assert.ok(
  indexDts.includes('export function platform()'),
  'index.d.ts must declare platform()'
);

// 3. Verify JavaScript implementation and platform devNull evaluation logic
const indexJs = fs.readFileSync(path.join(pkgDir, 'index.js'), 'utf8');
assert.ok(
  indexJs.includes('exports.devNull = binding.platform ===') && indexJs.includes('/dev/null'),
  'index.js must export devNull conditionally based on binding.platform'
);

function getExpectedDevNull(platform) {
  return platform === 'win32' ? '\\\\.\\nul' : '/dev/null';
}

assert.equal(getExpectedDevNull('win32'), '\\\\.\\nul', 'win32 platform must yield \\\\.\\nul');
assert.equal(getExpectedDevNull('linux'), '/dev/null', 'linux platform must yield /dev/null');
assert.equal(getExpectedDevNull('darwin'), '/dev/null', 'darwin platform must yield /dev/null');
assert.equal(getExpectedDevNull('android'), '/dev/null', 'android platform must yield /dev/null');
assert.equal(getExpectedDevNull('ios'), '/dev/null', 'ios platform must yield /dev/null');

// 4. Verify devNull path properties and functional module execution with runtime binding mock
const currentExpected = getExpectedDevNull(process.platform);
assert.equal(typeof currentExpected, 'string', 'devNull must be a string');
assert.ok(currentExpected.length > 0, 'devNull must not be empty');

if (process.platform === 'win32') {
  assert.equal(currentExpected, '\\\\.\\nul', 'Win32 devNull must match DOS device namespace');
  assert.ok(currentExpected.startsWith('\\\\.\\'), 'Win32 devNull must start with \\\\.\\ prefix');
} else {
  assert.equal(currentExpected, '/dev/null', 'POSIX devNull must match standard /dev/null path');
  assert.ok(currentExpected.startsWith('/dev/'), 'POSIX devNull must reside in /dev directory');
}

const mockBindingWin32 = { platform: 'win32', arch: 'x64' };
const mockBindingPosix = { platform: 'linux', arch: 'x64' };

const originalLoad = Module._load;
let activeMockBinding = mockBindingPosix;
Module._load = function (request, parent, isMain) {
  if (request.endsWith('binding') || request.endsWith('binding.js') || request.includes('./binding')) {
    return activeMockBinding;
  }
  return originalLoad.apply(this, arguments);
};

// POSIX evaluation
activeMockBinding = mockBindingPosix;
const bareOsPosix = require('bare-os');
assert.equal(typeof bareOsPosix.devNull, 'string', 'bare-os devNull must be exported as string');
assert.equal(bareOsPosix.devNull, '/dev/null', 'devNull under POSIX binding must be /dev/null');

// Windows evaluation
delete require.cache[require.resolve('bare-os')];
activeMockBinding = mockBindingWin32;
const bareOsWin32 = require('bare-os');
assert.equal(typeof bareOsWin32.devNull, 'string', 'bare-os devNull must be exported as string');
assert.equal(bareOsWin32.devNull, '\\\\.\\nul', 'devNull under Windows binding must be \\\\.\\nul');

Module._load = originalLoad;

// 5. Verify C native addon binding and multi-platform prebuilt binaries for platform resolution
const bindingC = fs.readFileSync(path.join(pkgDir, 'binding.c'), 'utf8');
const bindingJs = fs.readFileSync(path.join(pkgDir, 'binding.js'), 'utf8');

assert.ok(bindingC.includes('BARE_MODULE(bare_os, bare_os_exports)'), 'binding.c must register bare_os BARE_MODULE');
assert.ok(bindingC.includes('V("platform", BARE_PLATFORM)'), 'binding.c must export platform property');
assert.ok(bindingJs.includes('module.exports = require.addon()'), 'binding.js must load native addon via require.addon()');
assert.ok(fs.existsSync(path.join(pkgDir, 'CMakeLists.txt')), 'CMakeLists.txt must exist');

const prebuildsDir = path.join(pkgDir, 'prebuilds');
const expectedTargets = [
  'linux-x64',
  'linux-arm64',
  'darwin-x64',
  'darwin-arm64',
  'win32-x64',
  'win32-arm64',
  'android-arm64',
  'ios-arm64'
];

for (const target of expectedTargets) {
  const prebuildPath = path.join(prebuildsDir, target, 'bare-os.bare');
  assert.ok(fs.existsSync(prebuildPath), `Prebuild binary for ${target} must exist at ${prebuildPath}`);
  const stats = fs.statSync(prebuildPath);
  assert.ok(stats.size > 0, `Prebuild binary for ${target} must not be empty`);
}

console.log('Contract tests passed successfully.');