isexe 4.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/isexe@4.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/isexe@4.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:062b6152c647899ae6b76f24d68e14311cfdd5d783a5dec573733bb4033c7a08","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@4.0.0","kind":"HOW","packages":["pkg:npm/isexe@4.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/isexe@4.0.0"],"schemaVersion":1,"subject":"pkg:npm/isexe@4.0.0","verifierAdapter":"node-typescript@1"}

import { isexe, sync, posix, win32 } from 'isexe';

/**
 * Asynchronously check if a file path is executable.
 *
 * @param {string} filePath - Path to the file
 * @param {import('isexe').IsexeOptions} [options] - Options for executable check
 * @returns {Promise<boolean>}
 */
export async function checkExecutable(filePath, options) {
  return await isexe(filePath, options);
}

/**
 * Synchronously check if a file path is executable.
 *
 * @param {string} filePath - Path to the file
 * @param {import('isexe').IsexeOptions} [options] - Options for executable check
 * @returns {boolean}
 */
export function checkExecutableSync(filePath, options) {
  return sync(filePath, options);
}

export { isexe, sync, posix, win32 };

{
  "name": "sample-isexe",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-isexe",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "isexe": "4.0.0"
      }
    },
    "node_modules/isexe": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/isexe/-/isexe-4.0.0.tgz",
      "integrity": "sha512-FFUtZMpoZ8RqHS3XeXEmHWLA4thH+ZxCv2lOiPIn1Xc7CxrqhWzNSDzD+/chS/zbYezmiwWLdQC09JdQKmthOw==",
      "license": "BlueOak-1.0.0",
      "engines": {
        "node": ">=20"
      }
    }
  }
}

{
  "name": "sample-isexe",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "license": "MIT-0",
  "dependencies": {
    "isexe": "4.0.0"
  }
}

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

import assert from 'node:assert/strict';
import fs from 'node:fs';
import path from 'node:path';
import os from 'node:os';
import { isexe, sync, posix, win32 } from 'isexe';
import { checkExecutable, checkExecutableSync } from '../index.mjs';

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.equal(sync(execFile), true, 'sync should return true for executable files');
  assert.equal(checkExecutableSync(execFile), true, 'checkExecutableSync should return true for executable files');
  assert.equal(sync(nonExecFile), false, 'sync should return false for non-executable files');
  assert.equal(checkExecutableSync(nonExecFile), false, 'checkExecutableSync should return false for non-executable files');

  // 2. Asynchronous detection: isexe asynchronously returns true for executable files and false for non-executable files
  assert.equal(await isexe(execFile), true, 'isexe should asynchronously return true for executable files');
  assert.equal(await checkExecutable(execFile), true, 'checkExecutable should asynchronously return true for executable files');
  assert.equal(await isexe(nonExecFile), false, 'isexe should asynchronously return false for non-executable files');
  assert.equal(await checkExecutable(nonExecFile), false, 'checkExecutable 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.equal(sync(missingFile, { ignoreErrors: true }), false, 'sync with ignoreErrors should return false for missing file');
  assert.equal(await isexe(missingFile, { ignoreErrors: true }), false, 'isexe with ignoreErrors should return false for missing file');
  assert.equal(checkExecutableSync(missingFile, { ignoreErrors: true }), false, 'checkExecutableSync with ignoreErrors should return false');
  assert.equal(await checkExecutable(missingFile, { ignoreErrors: true }), false, 'checkExecutable with ignoreErrors should return false');

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

  // Native binary verification
  assert.equal(sync(process.execPath), true, 'process.execPath must be executable synchronously');
  assert.equal(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 });
}