@eslint/config-array 0.19.2: ConfigArray

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 @eslint/config-array.ConfigArray in pkg:npm/%40eslint/config-array@0.19.2
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40eslint/config-array@0.19.2
Demonstrate these symbols/APIs:
  - @eslint/config-array.ConfigArray
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:9988835b0d6a145adbc6f4edd6289c0025a4dd1ad8c17ec5859317f9a2aded24","constraints":{"executionContext":"node"},"contract":["assert ConfigArray initializes with configs array, basePath, and isNormalized false until normalized","assert ConfigArray normalizeSync normalizes configs and files/ignores getters return matched patterns","assert ConfigArray getConfig merges matching configurations and applies pattern overrides","assert ConfigArray getConfigWithStatus and getConfigStatus return matched, ignored, unconfigured, or external status","assert ConfigArray isFileIgnored correctly identifies files matching ignores patterns","assert ConfigArray extraConfigTypes allows array and function config items when enabled","assert ConfigArray throws ConfigError on unknown properties when not defined in schema"],"goal":"verify @eslint/config-array.ConfigArray in pkg:npm/%40eslint/config-array@0.19.2","kind":"HOW","packages":["pkg:npm/%40eslint/config-array@0.19.2"],"schemaVersion":1,"symbols":["@eslint/config-array.ConfigArray"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/%40eslint/config-array@0.19.2"],"schemaVersion":1,"subject":"pkg:npm/%40eslint/config-array@0.19.2","symbols":["@eslint/config-array.ConfigArray"],"verifierAdapter":"node-typescript@1"}

const { ConfigArray } = require('@eslint/config-array');

/**
 * Creates a ConfigArray instance with custom schema and options.
 * @param {Array<object|Function>} configs
 * @param {object} [options]
 * @returns {ConfigArray}
 */
function createConfigArray(configs, options = {}) {
  return new ConfigArray(configs, options);
}

/**
 * Normalizes a ConfigArray synchronously.
 * @param {ConfigArray} configArray
 * @param {object} [context]
 * @returns {ConfigArray}
 */
function normalizeConfigSync(configArray, context) {
  return configArray.normalizeSync(context);
}

/**
 * Normalizes a ConfigArray asynchronously.
 * @param {ConfigArray} configArray
 * @param {object} [context]
 * @returns {Promise<ConfigArray>}
 */
async function normalizeConfig(configArray, context) {
  return configArray.normalize(context);
}

/**
 * Retrieves merged configuration for a file path.
 * @param {ConfigArray} configArray
 * @param {string} filePath
 * @returns {object|undefined}
 */
function getFileConfig(configArray, filePath) {
  return configArray.getConfig(filePath);
}

/**
 * Retrieves configuration status for a file path.
 * @param {ConfigArray} configArray
 * @param {string} filePath
 * @returns {"matched"|"unconfigured"|"ignored"|"external"}
 */
function getFileStatus(configArray, filePath) {
  return configArray.getConfigStatus(filePath);
}

/**
 * Checks if a file path is ignored.
 * @param {ConfigArray} configArray
 * @param {string} filePath
 * @returns {boolean}
 */
function isPathIgnored(configArray, filePath) {
  return configArray.isFileIgnored(filePath);
}

module.exports = {
  ConfigArray,
  createConfigArray,
  normalizeConfigSync,
  normalizeConfig,
  getFileConfig,
  getFileStatus,
  isPathIgnored,
};

{
  "name": "sample-eslint-config-array",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-eslint-config-array",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@eslint/config-array": "0.19.2"
      }
    },
    "node_modules/@eslint/config-array": {
      "version": "0.19.2",
      "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.19.2.tgz",
      "integrity": "sha512-GNKqxfHG2ySmJOBSHg7LxeUx4xpuCoFjacmlCoYWEbaPXLwvfIjixRI12xCQZeULksQb23uiA8F40w5TojpV7w==",
      "license": "Apache-2.0",
      "dependencies": {
        "@eslint/object-schema": "^2.1.6",
        "debug": "^4.3.1",
        "minimatch": "^3.1.2"
      },
      "engines": {
        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
      }
    },
    "node_modules/@eslint/object-schema": {
      "version": "2.1.7",
      "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.7.tgz",
      "integrity": "sha512-VtAOaymWVfZcmZbp6E2mympDIHvyjXs/12LqWYjVw6qjrfF+VK+fyG33kChz3nnK+SU5/NeHOqrTEHS8sXO3OA==",
      "license": "Apache-2.0",
      "engines": {
        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
      }
    },
    "node_modules/balanced-match": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
      "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
      "license": "MIT"
    },
    "node_modules/brace-expansion": {
      "version": "1.1.18",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.18.tgz",
      "integrity": "sha512-Edep/X9fGqVNmzKBVsDYIOtD+z1tuezV70LBjdCst9Tqu76lsnvRiZ6oTic1n+/BIwX6QDGAO94PN4N2SADvtw==",
      "license": "MIT",
      "dependencies": {
        "balanced-match": "^1.0.0",
        "concat-map": "0.0.1"
      }
    },
    "node_modules/concat-map": {
      "version": "0.0.1",
      "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
      "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==",
      "license": "MIT"
    },
    "node_modules/debug": {
      "version": "4.4.3",
      "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
      "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
      "license": "MIT",
      "dependencies": {
        "ms": "^2.1.3"
      },
      "engines": {
        "node": ">=6.0"
      },
      "peerDependenciesMeta": {
        "supports-color": {
          "optional": true
        }
      }
    },
    "node_modules/minimatch": {
      "version": "3.1.5",
      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz",
      "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==",
      "license": "ISC",
      "dependencies": {
        "brace-expansion": "^1.1.7"
      },
      "engines": {
        "node": "*"
      }
    },
    "node_modules/ms": {
      "version": "2.1.3",
      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-eslint-config-array",
  "version": "1.0.0",
  "description": "Clean-room sample verifying @eslint/config-array.ConfigArray in pkg:npm/%40eslint/config-array@0.19.2",
  "main": "index.js",
  "license": "MIT-0",
  "dependencies": {
    "@eslint/config-array": "0.19.2"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @eslint/config-array.ConfigArray in pkg:npm/%40eslint/config-array@0.19.2",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40eslint/config-array@0.19.2"
  ],
  "symbols": [
    "@eslint/config-array.ConfigArray"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

import assert from 'node:assert/strict';
import {
  ConfigArray,
  createConfigArray,
  normalizeConfigSync,
  normalizeConfig,
  getFileConfig,
  getFileStatus,
  isPathIgnored,
} from '../index.js';

const rulesSchema = {
  rules: {
    required: false,
    merge(first, second) {
      return Object.assign({}, first, second);
    },
    validate(value) {
      if (typeof value !== 'object' || value === null) {
        throw new TypeError('rules must be an object');
      }
    },
  },
};

// 1. assert ConfigArray initializes with configs array, basePath, and isNormalized false until normalized
{
  const configs = [
    { name: 'base', files: ['**/*.js'], rules: { semi: 'error' } },
  ];
  const array = createConfigArray(configs, { basePath: '/workspace', schema: rulesSchema });
  assert.ok(array instanceof Array);
  assert.ok(array instanceof ConfigArray);
  assert.strictEqual(array.basePath, '/workspace');
  assert.strictEqual(array.isNormalized(), false);
}

// 2. assert ConfigArray normalizeSync normalizes configs and files/ignores getters return matched patterns
{
  const configs = [
    { name: 'base', files: ['**/*.js'], rules: { semi: 'error' } },
    { name: 'tests', files: ['**/*.test.js'], rules: { semi: 'off' } },
    { ignores: ['**/node_modules/**', 'dist/**'] },
  ];
  const array = createConfigArray(configs, { basePath: '/workspace', schema: rulesSchema });
  normalizeConfigSync(array);
  assert.strictEqual(array.isNormalized(), true);
  assert.deepStrictEqual(array.files, ['**/*.js', '**/*.test.js']);
  assert.deepStrictEqual(array.ignores, ['**/node_modules/**', 'dist/**']);
}

// 3. assert ConfigArray getConfig merges matching configurations and applies pattern overrides
{
  const configs = [
    { name: 'base', files: ['**/*.js'], rules: { semi: 'error', quotes: 'single' } },
    { name: 'tests', files: ['**/*.test.js'], rules: { semi: 'off' } },
  ];
  const array = createConfigArray(configs, { basePath: '/workspace', schema: rulesSchema });
  normalizeConfigSync(array);

  const srcConfig = getFileConfig(array, '/workspace/src/index.js');
  assert.ok(srcConfig);
  assert.deepStrictEqual(srcConfig.rules, { semi: 'error', quotes: 'single' });

  const testConfig = getFileConfig(array, '/workspace/test/index.test.js');
  assert.ok(testConfig);
  assert.deepStrictEqual(testConfig.rules, { semi: 'off', quotes: 'single' });
}

// 4. assert ConfigArray getConfigWithStatus and getConfigStatus return matched, ignored, unconfigured, or external status
{
  const configs = [
    { name: 'base', files: ['**/*.js'], rules: { semi: 'error' } },
    { ignores: ['build/**'] },
  ];
  const array = createConfigArray(configs, { basePath: '/workspace', schema: rulesSchema });
  normalizeConfigSync(array);

  assert.strictEqual(getFileStatus(array, '/workspace/src/app.js'), 'matched');
  assert.strictEqual(getFileStatus(array, '/workspace/build/bundle.js'), 'ignored');
  assert.strictEqual(getFileStatus(array, '/workspace/package.json'), 'unconfigured');
  assert.strictEqual(getFileStatus(array, '/other/app.js'), 'external');

  const matched = array.getConfigWithStatus('/workspace/src/app.js');
  assert.strictEqual(matched.status, 'matched');
  assert.deepStrictEqual(matched.config.rules, { semi: 'error' });

  const ignored = array.getConfigWithStatus('/workspace/build/bundle.js');
  assert.strictEqual(ignored.status, 'ignored');
  assert.strictEqual(ignored.config, undefined);
}

// 5. assert ConfigArray isFileIgnored correctly identifies files matching ignores patterns
{
  const configs = [
    { name: 'base', files: ['**/*.js'], rules: { semi: 'error' } },
    { ignores: ['**/node_modules/**', 'dist/**'] },
  ];
  const array = createConfigArray(configs, { basePath: '/workspace', schema: rulesSchema });
  normalizeConfigSync(array);

  assert.strictEqual(isPathIgnored(array, '/workspace/node_modules/pkg/index.js'), true);
  assert.strictEqual(isPathIgnored(array, '/workspace/dist/output.js'), true);
  assert.strictEqual(isPathIgnored(array, '/workspace/src/index.js'), false);
}

// 6. assert ConfigArray extraConfigTypes allows array and function config items when enabled
{
  const configs = [
    { name: 'base', files: ['**/*.js'], rules: { semi: 'error' } },
    [
      (context) => ({
        name: 'dynamic',
        files: ['**/*.ts'],
        rules: { typed: context.isTyped },
      }),
    ],
  ];
  const array = createConfigArray(configs, {
    basePath: '/workspace',
    schema: rulesSchema,
    extraConfigTypes: ['array', 'function'],
  });

  await normalizeConfig(array, { isTyped: true });
  assert.strictEqual(array.isNormalized(), true);

  const tsConfig = getFileConfig(array, '/workspace/src/app.ts');
  assert.ok(tsConfig);
  assert.deepStrictEqual(tsConfig.rules, { typed: true });
}

// 7. assert ConfigArray throws ConfigError on unknown properties when not defined in schema
{
  const array = createConfigArray(
    [{ files: ['**/*.js'], unknownProperty: 123 }],
    { basePath: '/workspace' }
  );
  normalizeConfigSync(array);
  assert.throws(
    () => getFileConfig(array, '/workspace/src/app.js'),
    (err) => /Unexpected key "unknownProperty" found/.test(err.message)
  );
}

console.log('All @eslint/config-array.ConfigArray contract assertions passed.');