ignore 7.0.6: isPathValid

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 ignore.isPathValid in pkg:npm/ignore@7.0.6
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/ignore@7.0.6
Demonstrate these symbols/APIs:
  - ignore.isPathValid

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:b0e9e4b585f2fda01c04fdde570228c0046924c6336011d6e0e84c2966a528d3","contract":["ignore.isPathValid returns true for valid relative paths without leading dot-slashes","ignore.isPathValid returns true for dotfiles and hidden relative paths","ignore.isPathValid returns false for absolute paths starting with a leading slash","ignore.isPathValid returns false for relative paths starting with dot-slash or dot-dot-slash","ignore.isPathValid returns false for current directory dot and parent directory dot-dot","ignore.isPathValid returns false for empty strings and non-string values"],"goal":"verify ignore.isPathValid in pkg:npm/ignore@7.0.6","kind":"HOW","packages":["pkg:npm/ignore@7.0.6"],"schemaVersion":1,"symbols":["ignore.isPathValid"]},"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/ignore@7.0.6"],"schemaVersion":1,"subject":"pkg:npm/ignore@7.0.6","symbols":["ignore.isPathValid"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-ignore-ispathvalid",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-ignore-ispathvalid",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "ignore": "7.0.6"
      }
    },
    "node_modules/ignore": {
      "version": "7.0.6",
      "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.6.tgz",
      "integrity": "sha512-BAg6QkE8W+TuQLrrw0Ugr7HegXduRuuj8/ti2kSOc+jz1dmx8/WNcjr6XGnq5YpDWxFwwaavqD0+jIUOKelTsw==",
      "license": "MIT",
      "engines": {
        "node": ">= 4"
      }
    }
  }
}

{
  "name": "sample-ignore-ispathvalid",
  "version": "1.0.0",
  "private": true,
  "description": "verify ignore.isPathValid in pkg:npm/ignore@7.0.6",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "ignore": "7.0.6"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify ignore.isPathValid in pkg:npm/ignore@7.0.6",
  "kind": "HOW",
  "packages": [
    "pkg:npm/ignore@7.0.6"
  ],
  "symbols": [
    "ignore.isPathValid"
  ]
}

const ignore = require('ignore');

/**
 * Checks whether a given path is a valid relative path accepted by the ignore library.
 *
 * @param {string} pathname - The path string to validate.
 * @returns {boolean} True if the path is a valid relative path, false otherwise.
 */
function isValidPath(pathname) {
  return ignore.isPathValid(pathname);
}

/**
 * Filters an array of candidate paths, returning only those that are valid paths according to ignore.
 *
 * @param {string[]} paths - Array of path candidates.
 * @returns {string[]} Filtered array of valid paths.
 */
function filterValidPaths(paths) {
  if (!Array.isArray(paths)) {
    return [];
  }
  return paths.filter(pathname => ignore.isPathValid(pathname));
}

module.exports = {
  isPathValid: ignore.isPathValid,
  isValidPath,
  filterValidPaths
};

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

const require = createRequire(import.meta.url);
const ignore = require('ignore');
const { isPathValid, isValidPath, filterValidPaths } = require('../src/index.js');

// Ensure isPathValid export matches ignore.isPathValid
assert.strictEqual(isPathValid, ignore.isPathValid, 'isPathValid must export ignore.isPathValid');

// 1. ignore.isPathValid returns true for valid relative paths without leading dot-slashes
assert.strictEqual(isPathValid('src/index.js'), true);
assert.strictEqual(isPathValid('package.json'), true);
assert.strictEqual(isPathValid('nested/dir/file.txt'), true);
assert.strictEqual(isValidPath('src/components/App.js'), true);

// 2. ignore.isPathValid returns true for dotfiles and hidden relative paths
assert.strictEqual(isPathValid('.gitignore'), true);
assert.strictEqual(isPathValid('.config/settings.json'), true);
assert.strictEqual(isPathValid('.env.example'), true);
assert.strictEqual(isValidPath('.npmrc'), true);

// 3. ignore.isPathValid returns false for absolute paths starting with a leading slash
assert.strictEqual(isPathValid('/app/index.js'), false);
assert.strictEqual(isPathValid('/docs/readme.md'), false);
assert.strictEqual(isPathValid('/nested/file.js'), false);
assert.strictEqual(isValidPath('/absolute/file.txt'), false);

// 4. ignore.isPathValid returns false for relative paths starting with dot-slash or dot-dot-slash
assert.strictEqual(isPathValid('./src/index.js'), false);
assert.strictEqual(isPathValid('./package.json'), false);
assert.strictEqual(isPathValid('../parent/file.js'), false);
assert.strictEqual(isPathValid('../../grandparent/file.js'), false);
assert.strictEqual(isValidPath('./test.js'), false);

// 5. ignore.isPathValid returns false for current directory dot and parent directory dot-dot
assert.strictEqual(isPathValid('.'), false);
assert.strictEqual(isPathValid('..'), false);
assert.strictEqual(isValidPath('.'), false);
assert.strictEqual(isValidPath('..'), false);

// 6. ignore.isPathValid returns false for empty strings and non-string values
assert.strictEqual(isPathValid(''), false);
assert.strictEqual(isPathValid(null), false);
assert.strictEqual(isPathValid(undefined), false);
assert.strictEqual(isPathValid(123), false);
assert.strictEqual(isPathValid({}), false);
assert.strictEqual(isPathValid([]), false);

// Filter helper verification
const candidatePaths = [
  'src/index.js',
  '/app/index.js',
  '.gitignore',
  './relative.js',
  '../parent.js',
  '.',
  '',
  'docs/readme.md'
];
assert.deepStrictEqual(
  filterValidPaths(candidatePaths),
  ['src/index.js', '.gitignore', 'docs/readme.md']
);
assert.deepStrictEqual(filterValidPaths(null), []);

console.log('Contract assertions passed.');