@typescript-eslint/visitor-keys 8.69.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/%40typescript-eslint/visitor-keys@8.69.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40typescript-eslint/visitor-keys@8.69.0
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:1b55e9ee4b75b13dccb604ec5bef81eb812a9574b1f634c9203bd41f7d2d9066","constraints":{"executionContext":"node"},"contract":["visitorKeys defines AST visitor key mappings for TypeScript syntax nodes including TSInterfaceDeclaration and TSTypeAnnotation","visitorKeys extends ESTree ClassDeclaration keys with TypeScript-specific decorators and typeParameters","getKeys extracts enumerable property keys from AST nodes excluding blacklisted and underscore properties"],"goal":"verify pkg:npm/%40typescript-eslint/visitor-keys@8.69.0","kind":"HOW","packages":["pkg:npm/%40typescript-eslint/visitor-keys@8.69.0"],"schemaVersion":1},"contractCommand":["node","test/contract.js"],"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/%40typescript-eslint/visitor-keys@8.69.0"],"schemaVersion":1,"subject":"pkg:npm/%40typescript-eslint/visitor-keys@8.69.0","verifierAdapter":"node-typescript@1"}

const { visitorKeys, getKeys } = require('@typescript-eslint/visitor-keys');

function getVisitorKeysForType(type) {
  return visitorKeys[type];
}

function getNodeKeys(node) {
  return getKeys(node);
}

module.exports = {
  visitorKeys,
  getKeys,
  getVisitorKeysForType,
  getNodeKeys,
};

{
  "name": "sample",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample",
      "version": "1.0.0",
      "dependencies": {
        "@typescript-eslint/visitor-keys": "8.69.0"
      }
    },
    "node_modules/@typescript-eslint/types": {
      "version": "8.69.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.69.0.tgz",
      "integrity": "sha512-K3VrubUPhlo9VDBS6QdI8YB5j7ClpqLRdefcz6PFrhnwicehBweqQ9Evhl4l+FYz0HdDmMqIiSX0aldGRYtDCA==",
      "license": "MIT",
      "engines": {
        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
      },
      "funding": {
        "type": "opencollective",
        "url": "https://opencollective.com/typescript-eslint"
      }
    },
    "node_modules/@typescript-eslint/visitor-keys": {
      "version": "8.69.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.69.0.tgz",
      "integrity": "sha512-+rmdgPA+EXkNgKYvHvFfhrs35utXbwaC5PGpDquSXcoXQDKUA5UjV0LmTucG/4JXkM31BTu4TilHtrN8IVBe8w==",
      "license": "MIT",
      "dependencies": {
        "@typescript-eslint/types": "8.69.0",
        "eslint-visitor-keys": "^5.0.0"
      },
      "engines": {
        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
      },
      "funding": {
        "type": "opencollective",
        "url": "https://opencollective.com/typescript-eslint"
      }
    },
    "node_modules/eslint-visitor-keys": {
      "version": "5.0.1",
      "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-5.0.1.tgz",
      "integrity": "sha512-tD40eHxA35h0PEIZNeIjkHoDR4YjjJp34biM0mDvplBe//mB+IHCqHDGV7pxF+7MklTvighcCPPZC7ynWyjdTA==",
      "license": "Apache-2.0",
      "engines": {
        "node": "^20.19.0 || ^22.13.0 || >=24"
      },
      "funding": {
        "url": "https://opencollective.com/eslint"
      }
    }
  }
}

{
  "name": "sample",
  "version": "1.0.0",
  "description": "Minimal sample verifying @typescript-eslint/visitor-keys",
  "main": "index.js",
  "type": "commonjs",
  "dependencies": {
    "@typescript-eslint/visitor-keys": "8.69.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/%40typescript-eslint/visitor-keys@8.69.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40typescript-eslint/visitor-keys@8.69.0"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const assert = require('node:assert');
const {
  visitorKeys,
  getKeys,
  getVisitorKeysForType,
  getNodeKeys,
} = require('../index.js');

// Contract 1: visitorKeys defines AST visitor key mappings for TypeScript syntax nodes including TSInterfaceDeclaration and TSTypeAnnotation
assert(typeof visitorKeys === 'object' && visitorKeys !== null, 'visitorKeys must be an object');
assert.deepStrictEqual(
  getVisitorKeysForType('TSInterfaceDeclaration'),
  ['id', 'typeParameters', 'extends', 'body'],
  'TSInterfaceDeclaration must have visitor keys [id, typeParameters, extends, body]'
);
assert.deepStrictEqual(
  getVisitorKeysForType('TSTypeAnnotation'),
  ['typeAnnotation'],
  'TSTypeAnnotation must have visitor keys [typeAnnotation]'
);
assert.deepStrictEqual(
  getVisitorKeysForType('TSPropertySignature'),
  ['key', 'typeAnnotation'],
  'TSPropertySignature must have visitor keys [key, typeAnnotation]'
);

// Contract 2: visitorKeys extends ESTree ClassDeclaration keys with TypeScript-specific decorators and typeParameters
const classDeclKeys = getVisitorKeysForType('ClassDeclaration');
assert(Array.isArray(classDeclKeys), 'ClassDeclaration keys must be an array');
assert(classDeclKeys.includes('decorators'), 'ClassDeclaration keys must include decorators');
assert(classDeclKeys.includes('typeParameters'), 'ClassDeclaration keys must include typeParameters');
assert(classDeclKeys.includes('superTypeArguments'), 'ClassDeclaration keys must include superTypeArguments');
assert(classDeclKeys.includes('implements'), 'ClassDeclaration keys must include implements');
assert.deepStrictEqual(
  classDeclKeys,
  ['decorators', 'id', 'typeParameters', 'superClass', 'superTypeArguments', 'implements', 'body'],
  'ClassDeclaration keys must match expected TypeScript-ESTree visitor order'
);

// Contract 3: getKeys extracts enumerable property keys from AST nodes excluding blacklisted and underscore properties
const mockTsNode = {
  type: 'TSInterfaceDeclaration',
  id: { type: 'Identifier', name: 'User' },
  body: { type: 'TSInterfaceBody', body: [] },
  leadingComments: [{ type: 'Line', value: 'comment' }],
  trailingComments: [],
  comments: [],
  tokens: [],
  parent: null,
  _internalState: 'secret',
  customProp: 'value',
};

const extractedKeys = getNodeKeys(mockTsNode);
assert(Array.isArray(extractedKeys), 'getKeys must return an array of keys');
assert.strictEqual(extractedKeys.includes('type'), true, 'getKeys must include type');
assert.strictEqual(extractedKeys.includes('id'), true, 'getKeys must include id');
assert.strictEqual(extractedKeys.includes('body'), true, 'getKeys must include body');
assert.strictEqual(extractedKeys.includes('customProp'), true, 'getKeys must include customProp');
assert.strictEqual(extractedKeys.includes('_internalState'), false, 'getKeys must filter out underscore-prefixed properties');
assert.strictEqual(extractedKeys.includes('parent'), false, 'getKeys must filter out parent property');
assert.strictEqual(extractedKeys.includes('leadingComments'), false, 'getKeys must filter out leadingComments');
assert.strictEqual(extractedKeys.includes('trailingComments'), false, 'getKeys must filter out trailingComments');

console.log('All visitor-keys contracts passed successfully.');