isexe 3.1.5

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/isexe@3.1.5
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/isexe@3.1.5

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:318459f88748e9cea037c6c086ee8504037f957812f34efceaeddd014449cd6e","contract":["sync returns true for executable files and false for non-executable files","isexe asynchronously returns true for executable files and false for non-executable files","sync and isexe return false for non-existent files when ignoreErrors is true","posix.sync and posix.isexe correctly detect executable status on posix platform"],"goal":"verify pkg:npm/isexe@3.1.5","kind":"HOW","packages":["pkg:npm/isexe@3.1.5"],"schemaVersion":1},"contractCommand":["node","test/contract.js"],"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/isexe@3.1.5"],"schemaVersion":1,"subject":"pkg:npm/isexe@3.1.5","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-isexe",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-isexe",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "isexe": "3.1.5"
      }
    },
    "node_modules/isexe": {
      "version": "3.1.5",
      "resolved": "https://registry.npmjs.org/isexe/-/isexe-3.1.5.tgz",
      "integrity": "sha512-6B3tLtFqtQS4ekarvLVMZ+X+VlvQekbe4taUkf/rhVO3d/h0M2rfARm/pXLcPEsjjMsFgrFgSrhQIxcSVrBz8w==",
      "license": "BlueOak-1.0.0",
      "engines": {
        "node": ">=18"
      }
    }
  }
}

{
  "name": "sample-isexe",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification sample for isexe",
  "main": "test/contract.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "isexe": "3.1.5"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/isexe@3.1.5",
  "kind": "HOW",
  "packages": [
    "pkg:npm/isexe@3.1.5"
  ]
}

const { isexe, sync, posix, win32 } = require('isexe');

async function checkExecutable(filePath, options) {
  return await isexe(filePath, options);
}

function checkExecutableSync(filePath, options) {
  return sync(filePath, options);
}

module.exports = {
  checkExecutable,
  checkExecutableSync,
  isexe,
  sync,
  posix,
  win32
};

const assert = require('node:assert');
const fs = require('node:fs');
const path = require('node:path');
const os = require('node:os');
const { isexe, sync, posix, win32 } = require('isexe');
const { checkExecutable, checkExecutableSync } = require('../src/index.js');

async function runContractTests() {
  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'isexe-sample-contract-'));
  const execFile = path.join(tmpDir, 'script.sh');
  const nonExecFile = path.join(tmpDir, 'document.txt');
  const missingFile = path.join(tmpDir, 'does-not-exist.bin');

  try {
    fs.writeFileSync(execFile, '#!/bin/sh\necho "test"\n', { mode: 0o755 });
    fs.chmodSync(execFile, 0o755);

    fs.writeFileSync(nonExecFile, 'plain document text\n', { mode: 0o644 });
    fs.chmodSync(nonExecFile, 0o644);

    // 1. Synchronous detection: sync returns true for executable files and false for non-executable files
    assert.strictEqual(sync(execFile), true, 'sync should return true for executable files');
    assert.strictEqual(checkExecutableSync(execFile), true, 'checkExecutableSync helper should return true for executable files');
    assert.strictEqual(sync(nonExecFile), false, 'sync should return false for non-executable files');
    assert.strictEqual(checkExecutableSync(nonExecFile), false, 'checkExecutableSync helper should return false for non-executable files');

    // 2. Asynchronous detection: isexe asynchronously returns true for executable files and false for non-executable files
    assert.strictEqual(await isexe(execFile), true, 'isexe should asynchronously return true for executable files');
    assert.strictEqual(await checkExecutable(execFile), true, 'checkExecutable helper should asynchronously return true for executable files');
    assert.strictEqual(await isexe(nonExecFile), false, 'isexe should asynchronously return false for non-executable files');
    assert.strictEqual(await checkExecutable(nonExecFile), false, 'checkExecutable helper should asynchronously return false for non-executable files');

    // 3. Error handling: sync and isexe return false for non-existent files when ignoreErrors is true
    assert.strictEqual(sync(missingFile, { ignoreErrors: true }), false, 'sync with ignoreErrors should return false for missing file');
    assert.strictEqual(await isexe(missingFile, { ignoreErrors: true }), false, 'isexe with ignoreErrors should return false for missing file');
    assert.strictEqual(checkExecutableSync(missingFile, { ignoreErrors: true }), false, 'helper sync with ignoreErrors should return false for missing file');
    assert.strictEqual(await checkExecutable(missingFile, { ignoreErrors: true }), false, 'helper async with ignoreErrors should return false for missing file');

    // 4. POSIX specifics: posix.sync and posix.isexe correctly detect executable status on posix platform
    if (process.platform !== 'win32') {
      assert.strictEqual(posix.sync(execFile), true, 'posix.sync should return true for executable file');
      assert.strictEqual(posix.sync(nonExecFile), false, 'posix.sync should return false for non-executable file');
      assert.strictEqual(await posix.isexe(execFile), true, 'posix.isexe should return true for executable file');
      assert.strictEqual(await posix.isexe(nonExecFile), false, 'posix.isexe should return false for non-executable file');
      assert.strictEqual(posix.sync(missingFile, { ignoreErrors: true }), false, 'posix.sync with ignoreErrors should return false');
      assert.strictEqual(await posix.isexe(missingFile, { ignoreErrors: true }), false, 'posix.isexe with ignoreErrors should return false');
    }

    // 5. Native binary verification
    assert.strictEqual(sync(process.execPath), true, 'process.execPath must be executable synchronously');
    assert.strictEqual(await isexe(process.execPath), true, 'process.execPath must be executable asynchronously');

    console.log('isexe contract tests passed successfully.');
  } finally {
    fs.rmSync(tmpDir, { recursive: true, force: true });
  }
}

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