@eslint/core 0.17.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/%40eslint/core@0.17.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40eslint/core@0.17.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:674f76ff05affee4007c3c4bccbfddcbcbd7bf4d85992f2e8e13922a157b5731","contract":["package manifest specifies ESM and CJS type declaration exports and dependency on @types/json-schema","declares Language interface for custom file parsing, AST generation, and SourceCode creation","declares RuleDefinition and RuleContext interfaces with rule metadata, visitor methods, and violation reporting","declares SourceCodeBase, TextSourceCode, and BinarySourceCode interfaces supporting AST traversal and location mapping","declares ConfigObject, Plugin, and Processor interfaces for ESLint flat configuration ecosystem","declares diagnostics and fix interfaces including LintMessage, ViolationReport, and RuleTextEditor"],"goal":"verify pkg:npm/%40eslint/core@0.17.0","kind":"HOW","packages":["pkg:npm/%40eslint/core@0.17.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/%40eslint/core@0.17.0"],"schemaVersion":1,"subject":"pkg:npm/%40eslint/core@0.17.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-eslint-core",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-eslint-core",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@eslint/core": "0.17.0"
      }
    },
    "node_modules/@eslint/core": {
      "version": "0.17.0",
      "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.17.0.tgz",
      "integrity": "sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ==",
      "license": "Apache-2.0",
      "dependencies": {
        "@types/json-schema": "^7.0.15"
      },
      "engines": {
        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
      }
    },
    "node_modules/@types/json-schema": {
      "version": "7.0.15",
      "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
      "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-eslint-core",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "@eslint/core": "0.17.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/%40eslint/core@0.17.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40eslint/core@0.17.0"
  ]
}

import assert from 'node:assert/strict';
import fs from 'node:fs';
import path from 'node:path';

// Locate package directory from node_modules relative to process.cwd() or import.meta.url
const cwdPkgDir = path.resolve(process.cwd(), 'node_modules/@eslint/core');
const scriptRelativePkgDir = path.resolve(path.dirname(new URL(import.meta.url).pathname), '../node_modules/@eslint/core');
const pkgDir = fs.existsSync(cwdPkgDir) ? cwdPkgDir : scriptRelativePkgDir;
const pkgPath = path.join(pkgDir, 'package.json');

assert.ok(fs.existsSync(pkgPath), 'package.json must exist in node_modules/@eslint/core');

const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));

// 1. Resolve @eslint/core package manifest and verify type declaration export paths
assert.equal(pkg.name, '@eslint/core', 'Package name must be @eslint/core');
assert.equal(pkg.version, '0.17.0', 'Package version must be 0.17.0');
assert.equal(pkg.type, 'module', 'Package type must be module');
assert.equal(pkg.types, './dist/esm/types.d.ts', 'types entry must point to ./dist/esm/types.d.ts');
assert.equal(
  pkg.exports?.types?.import,
  './dist/esm/types.d.ts',
  'ESM types export must point to ./dist/esm/types.d.ts'
);
assert.equal(
  pkg.exports?.types?.require,
  './dist/cjs/types.d.cts',
  'CJS types export must point to ./dist/cjs/types.d.cts'
);
assert.ok(
  pkg.dependencies?.['@types/json-schema'],
  'Package must declare dependency on @types/json-schema'
);

const esmDtsContent = fs.readFileSync(path.join(pkgDir, 'dist/esm/types.d.ts'), 'utf8');
const cjsDtsContent = fs.readFileSync(path.join(pkgDir, 'dist/cjs/types.d.cts'), 'utf8');

// 2. Verify Language plugin interface declarations
assert.ok(
  esmDtsContent.includes('export interface Language<Options extends LanguageTypeOptions'),
  'Language interface with LanguageTypeOptions generic must be exported'
);
assert.ok(
  esmDtsContent.includes('fileType: "text";') &&
  esmDtsContent.includes('lineStart: 0 | 1;') &&
  esmDtsContent.includes('columnStart: 0 | 1;') &&
  esmDtsContent.includes('nodeTypeKey: string;') &&
  esmDtsContent.includes('validateLanguageOptions(languageOptions: Options["LangOptions"]): void;') &&
  esmDtsContent.includes('parse(file: File, context: LanguageContext<Options["LangOptions"]>): ParseResult<Options["RootNode"]>;') &&
  esmDtsContent.includes('createSourceCode(file: File, input: OkParseResult<Options["RootNode"]>, context: LanguageContext<Options["LangOptions"]>): Options["Code"];'),
  'Language interface must declare fileType, lineStart, columnStart, nodeTypeKey, validateLanguageOptions, parse, and createSourceCode'
);
assert.ok(
  esmDtsContent.includes('export interface File {') &&
  esmDtsContent.includes('path: string;') &&
  esmDtsContent.includes('physicalPath: string;') &&
  esmDtsContent.includes('bom: boolean;') &&
  esmDtsContent.includes('body: string | Uint8Array;'),
  'File interface must declare path, physicalPath, bom, and body'
);
assert.ok(
  esmDtsContent.includes('export interface OkParseResult<RootNode = unknown> {') &&
  esmDtsContent.includes('export interface NotOkParseResult {') &&
  esmDtsContent.includes('export type ParseResult<RootNode = unknown> = OkParseResult<RootNode> | NotOkParseResult;'),
  'ParseResult discriminated union with OkParseResult and NotOkParseResult must be exported'
);

// 3. Verify RuleDefinition and RuleContext interfaces
assert.ok(
  esmDtsContent.includes('export interface RuleDefinition<Options extends RuleDefinitionTypeOptions'),
  'RuleDefinition interface must be exported'
);
assert.ok(
  esmDtsContent.includes('export interface RuleContext<Options extends RuleContextTypeOptions'),
  'RuleContext interface must be exported'
);
assert.ok(
  esmDtsContent.includes('export interface RulesMeta<MessageIds extends string = string, RuleOptions = unknown[], ExtRuleDocs = unknown> {'),
  'RulesMeta interface must be exported with generic MessageIds, RuleOptions, ExtRuleDocs'
);
assert.ok(
  esmDtsContent.includes('cwd: string;') &&
  esmDtsContent.includes('filename: string;') &&
  esmDtsContent.includes('physicalFilename: string;') &&
  esmDtsContent.includes('sourceCode: Options["Code"];') &&
  esmDtsContent.includes('settings: SettingsConfig;') &&
  esmDtsContent.includes('languageOptions: Options["LangOptions"];') &&
  esmDtsContent.includes('id: string;') &&
  esmDtsContent.includes('options: Options["RuleOptions"];') &&
  esmDtsContent.includes('report(violation: ViolationReport<Options["Node"], Options["MessageIds"]>): void;'),
  'RuleContext must provide cwd, filename, physicalFilename, sourceCode, settings, languageOptions, id, options, report'
);
assert.ok(
  esmDtsContent.includes('export type RuleVisitor = Record<string, ((...args: any[]) => void) | undefined>;'),
  'RuleVisitor type alias must be exported'
);

// 4. Verify SourceCodeBase, TextSourceCode, and BinarySourceCode interfaces
assert.ok(
  esmDtsContent.includes('interface SourceCodeBase<Options extends SourceCodeBaseTypeOptions'),
  'SourceCodeBase interface must be declared'
);
assert.ok(
  esmDtsContent.includes('getLoc(syntaxElement: Options["SyntaxElementWithLoc"]): SourceLocation;') &&
  esmDtsContent.includes('getRange(syntaxElement: Options["SyntaxElementWithLoc"]): SourceRange;') &&
  esmDtsContent.includes('traverse(): Iterable<TraversalStep>;'),
  'SourceCodeBase must declare getLoc, getRange, and traverse methods'
);
assert.ok(
  esmDtsContent.includes('export interface TextSourceCode<') &&
  esmDtsContent.includes('text: string;') &&
  esmDtsContent.includes('export interface BinarySourceCode<') &&
  esmDtsContent.includes('body: Uint8Array;') &&
  esmDtsContent.includes('export type SourceCode<Options extends SourceCodeBaseTypeOptions'),
  'TextSourceCode, BinarySourceCode, and SourceCode union must be exported'
);
assert.ok(
  esmDtsContent.includes('export interface VisitTraversalStep {') &&
  esmDtsContent.includes('export interface CallTraversalStep {') &&
  esmDtsContent.includes('export type TraversalStep = VisitTraversalStep | CallTraversalStep;'),
  'TraversalStep discriminated union with VisitTraversalStep and CallTraversalStep must be exported'
);

// 5. Verify ConfigObject, Plugin, and Processor interfaces
assert.ok(
  esmDtsContent.includes('export interface ConfigObject<Rules extends RulesConfig = RulesConfig> {') &&
  esmDtsContent.includes('name?: string;') &&
  esmDtsContent.includes('basePath?: string;') &&
  esmDtsContent.includes('files?: (string | string[])[];') &&
  esmDtsContent.includes('ignores?: string[];') &&
  esmDtsContent.includes('language?: string;') &&
  esmDtsContent.includes('languageOptions?: LanguageOptions;') &&
  esmDtsContent.includes('linterOptions?: LinterOptionsConfig;') &&
  esmDtsContent.includes('processor?: string | Processor;') &&
  esmDtsContent.includes('plugins?: Record<string, Plugin>;') &&
  esmDtsContent.includes('rules?: Partial<Rules>;') &&
  esmDtsContent.includes('settings?: Record<string, unknown>;'),
  'ConfigObject flat config interface must declare name, basePath, files, ignores, language, languageOptions, linterOptions, processor, plugins, rules, settings'
);
assert.ok(
  esmDtsContent.includes('export interface Plugin extends ObjectMetaProperties {') &&
  esmDtsContent.includes('configs?: Record<string, LegacyConfigObject | ConfigObject | ConfigObject[]> | undefined;') &&
  esmDtsContent.includes('environments?: Record<string, EnvironmentConfig> | undefined;') &&
  esmDtsContent.includes('languages?: Record<string, Language> | undefined;') &&
  esmDtsContent.includes('processors?: Record<string, Processor> | undefined;') &&
  esmDtsContent.includes('rules?: Record<string, RuleDefinition> | undefined;'),
  'Plugin interface must declare configs, environments, languages, processors, and rules maps'
);
assert.ok(
  esmDtsContent.includes('export interface Processor<T extends string | ProcessorFile = string | ProcessorFile> extends ObjectMetaProperties {') &&
  esmDtsContent.includes('supportsAutofix?: boolean | undefined;') &&
  esmDtsContent.includes('preprocess?(text: string, filename: string): T[];') &&
  esmDtsContent.includes('postprocess?(messages: LintMessage[][], filename: string): LintMessage[];'),
  'Processor interface must declare preprocess and postprocess methods'
);

// 6. Verify diagnostics and fix interfaces
assert.ok(
  esmDtsContent.includes('export interface LintMessage {') &&
  esmDtsContent.includes('column: number;') &&
  esmDtsContent.includes('line: number;') &&
  esmDtsContent.includes('ruleId: string | null;') &&
  esmDtsContent.includes('message: string;') &&
  esmDtsContent.includes('severity: Exclude<SeverityLevel, 0>;'),
  'LintMessage interface must declare column, line, ruleId, message, severity'
);
assert.ok(
  esmDtsContent.includes('export type ViolationReport<Node = unknown, MessageIds = string> = ViolationReportBase & ViolationMessage<MessageIds> & ViolationLocation<Node>;'),
  'ViolationReport intersection type must be exported'
);
assert.ok(
  esmDtsContent.includes('export interface RuleTextEditor<EditableSyntaxElement = unknown> {') &&
  esmDtsContent.includes('insertTextAfter(') &&
  esmDtsContent.includes('insertTextBefore(') &&
  esmDtsContent.includes('remove(') &&
  esmDtsContent.includes('replaceText(') &&
  esmDtsContent.includes('replaceTextRange('),
  'RuleTextEditor interface must declare insertTextAfter, insertTextBefore, remove, replaceText, replaceTextRange'
);

// 7. Verify CJS declaration mirrors ESM declaration
assert.equal(
  cjsDtsContent,
  esmDtsContent,
  'dist/cjs/types.d.cts must match dist/esm/types.d.ts'
);

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