@typescript-eslint/typescript-estree 8.65.0: parseAndGenerateServices

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 @typescript-eslint/typescript-estree.parseAndGenerateServices in pkg:npm/%40typescript-eslint/typescript-estree@8.65.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40typescript-eslint/typescript-estree@8.65.0
Demonstrate these symbols/APIs:
  - @typescript-eslint/typescript-estree.parseAndGenerateServices

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:f6257c7b7c2e1568b5c096046baf3f313e782ee5b24f6152763efbdff7d86bbb","constraints":{"executionContext":"node"},"contract":["parseAndGenerateServices parses TypeScript code and returns an AST with a Program root node","parseAndGenerateServices provides services object with esTreeNodeToTSNodeMap and tsNodeToESTreeNodeMap","parseAndGenerateServices supports bidirectional mapping between ESTree and TypeScript compiler nodes","parseAndGenerateServices parses TypeScript interface and type declarations with token and location details","parseAndGenerateServices throws TSError on invalid TypeScript syntax when filePath is provided"],"goal":"verify @typescript-eslint/typescript-estree.parseAndGenerateServices in pkg:npm/%40typescript-eslint/typescript-estree@8.65.0","kind":"HOW","packages":["pkg:npm/%40typescript-eslint/typescript-estree@8.65.0"],"schemaVersion":1,"symbols":["@typescript-eslint/typescript-estree.parseAndGenerateServices"]},"contractCommand":["node","test/contract.cjs"],"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/typescript-estree@8.65.0"],"schemaVersion":1,"subject":"pkg:npm/%40typescript-eslint/typescript-estree@8.65.0","symbols":["@typescript-eslint/typescript-estree.parseAndGenerateServices"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-typescript-estree-parse-and-generate-services",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-typescript-estree-parse-and-generate-services",
      "version": "1.0.0",
      "dependencies": {
        "@typescript-eslint/typescript-estree": "8.65.0"
      }
    },
    "node_modules/@typescript-eslint/project-service": {
      "version": "8.65.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.65.0.tgz",
      "integrity": "sha512-SxnPhbTsGahizDgbu7oqFH/xVtzIqMd/s+WtnSxNxJZJpLbdT5IPdzg8EZxO3+PoKahXmwJLeNQOpKJb3/bi7Q==",
      "license": "MIT",
      "dependencies": {
        "@typescript-eslint/tsconfig-utils": "^8.65.0",
        "@typescript-eslint/types": "^8.65.0",
        "debug": "^4.4.3"
      },
      "engines": {
        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
      },
      "funding": {
        "type": "opencollective",
        "url": "https://opencollective.com/typescript-eslint"
      },
      "peerDependencies": {
        "typescript": ">=4.8.4 <6.1.0"
      }
    },
    "node_modules/@typescript-eslint/tsconfig-utils": {
      "version": "8.65.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.65.0.tgz",
      "integrity": "sha512-j6GzGqCiRdA7Qhur2VVmKZAkBLfnHFQfx4TaJGL9RMveZqCo48jSHHO0DTgizEnGhtWnqmbtCUSrqSkdiY/0Hg==",
      "license": "MIT",
      "engines": {
        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
      },
      "funding": {
        "type": "opencollective",
        "url": "https://opencollective.com/typescript-eslint"
      },
      "peerDependencies": {
        "typescript": ">=4.8.4 <6.1.0"
      }
    },
    "node_modules/@typescript-eslint/types": {
      "version": "8.65.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.65.0.tgz",
      "integrity": "sha512-JSSwWNy+H0E/01jJEM+hrX6N0OFDzFzeIhHFSAS01tlVaevpG8cFyYRPhS5yjGOvBUx3sqQHVMjCL1CAZZMxBg==",
      "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/typescript-estree": {
      "version": "8.65.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.65.0.tgz",
      "integrity": "sha512-JboAE2swaYt4tb1fHhHTABE2K+OLy09XfcTbhnk4Pw96f9dd2e9iYsJ28gBggHlo5z5x1rkyWvcPoTuNTd4oGg==",
      "license": "MIT",
      "dependencies": {
        "@typescript-eslint/project-service": "8.65.0",
        "@typescript-eslint/tsconfig-utils": "8.65.0",
        "@typescript-eslint/types": "8.65.0",
        "@typescript-eslint/visitor-keys": "8.65.0",
        "debug": "^4.4.3",
        "minimatch": "^10.2.2",
        "semver": "^7.7.3",
        "tinyglobby": "^0.2.15",
        "ts-api-utils": "^2.5.0"
      },
      "engines": {
        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
      },
      "funding": {
        "type": "opencollective",
        "url": "https://opencollective.com/typescript-eslint"
      },
      "peerDependencies": {
        "typescript": ">=4.8.4 <6.1.0"
      }
    },
    "node_modules/@typescript-eslint/visitor-keys": {
      "version": "8.65.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.65.0.tgz",
      "integrity": "sha512-8C71BQkGjiMmXtop7pHVJu1l2NNShFdkCyD6a2ezzs5vU/L3LRtb69EtcteFwz0mYMPzIgOw0n6OV4VBUWZd7A==",
      "license": "MIT",
      "dependencies": {
        "@typescript-eslint/types": "8.65.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/balanced-match": {
      "version": "4.0.4",
      "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz",
      "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==",
      "license": "MIT",
      "engines": {
        "node": "18 || 20 || >=22"
      }
    },
    "node_modules/brace-expansion": {
      "version": "5.0.9",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.9.tgz",
      "integrity": "sha512-ScQ4IuvIEF1TMlP7Zt+vjJ//9zlPb2SDcxWxM3bk8s6t6GGdJ7KO1dCcTidOPJKePW30LE/2cT7wCyPho9/Wxg==",
      "license": "MIT",
      "dependencies": {
        "balanced-match": "^4.0.2"
      },
      "engines": {
        "node": "20 || >=22"
      }
    },
    "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/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"
      }
    },
    "node_modules/fdir": {
      "version": "6.5.0",
      "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz",
      "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==",
      "license": "MIT",
      "engines": {
        "node": ">=12.0.0"
      },
      "peerDependencies": {
        "picomatch": "^3 || ^4"
      },
      "peerDependenciesMeta": {
        "picomatch": {
          "optional": true
        }
      }
    },
    "node_modules/minimatch": {
      "version": "10.2.6",
      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.6.tgz",
      "integrity": "sha512-vpLQEs+VLCr1nU0BXS07maYoFwlDAH0gngQuuttxIwutDFEMHq2blX+8vpgxDdK3J1PwjCJiep77OitTZ4Ll1A==",
      "license": "BlueOak-1.0.0",
      "dependencies": {
        "brace-expansion": "^5.0.8"
      },
      "engines": {
        "node": "18 || 20 || >=22"
      },
      "funding": {
        "url": "https://github.com/sponsors/isaacs"
      }
    },
    "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"
    },
    "node_modules/picomatch": {
      "version": "4.0.7",
      "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.7.tgz",
      "integrity": "sha512-qcJu88Q2IWqJsDD529JKMdwGm/dvInW4HvQnRwiH9JtihJvzGOscDtHE3x1pBKeUOTysQ8kVmLnJ2kJu7yhcGA==",
      "license": "MIT",
      "engines": {
        "node": ">=12"
      },
      "funding": {
        "url": "https://github.com/sponsors/jonschlinkert"
      }
    },
    "node_modules/semver": {
      "version": "7.8.5",
      "resolved": "https://registry.npmjs.org/semver/-/semver-7.8.5.tgz",
      "integrity": "sha512-Y7/KDsb8LjooZpwaqGyulO6DQlksgCncchHGk+sZIY4SBvUocMBEFH5Ur1fI4dV+Jvl0w6cjvucaIi40puRioA==",
      "license": "ISC",
      "bin": {
        "semver": "bin/semver.js"
      },
      "engines": {
        "node": ">=10"
      }
    },
    "node_modules/tinyglobby": {
      "version": "0.2.17",
      "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.17.tgz",
      "integrity": "sha512-wXR/dYpcqKmfWpEdZjiKJOwCNFndD0DMnrW/cYjVGttEkBfVgcLFHoNrlj47mjOVic9yyNu65alsgF4NQyTa2g==",
      "license": "MIT",
      "dependencies": {
        "fdir": "^6.5.0",
        "picomatch": "^4.0.4"
      },
      "engines": {
        "node": ">=12.0.0"
      },
      "funding": {
        "url": "https://github.com/sponsors/SuperchupuDev"
      }
    },
    "node_modules/ts-api-utils": {
      "version": "2.5.0",
      "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.5.0.tgz",
      "integrity": "sha512-OJ/ibxhPlqrMM0UiNHJ/0CKQkoKF243/AEmplt3qpRgkW8VG7IfOS41h7V8TjITqdByHzrjcS/2si+y4lIh8NA==",
      "license": "MIT",
      "engines": {
        "node": ">=18.12"
      },
      "peerDependencies": {
        "typescript": ">=4.8.4"
      }
    },
    "node_modules/typescript": {
      "version": "6.0.3",
      "resolved": "https://registry.npmjs.org/typescript/-/typescript-6.0.3.tgz",
      "integrity": "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw==",
      "license": "Apache-2.0",
      "peer": true,
      "bin": {
        "tsc": "bin/tsc",
        "tsserver": "bin/tsserver"
      },
      "engines": {
        "node": ">=14.17"
      }
    }
  }
}

{
  "name": "sample-typescript-estree-parse-and-generate-services",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification of @typescript-eslint/typescript-estree parseAndGenerateServices",
  "main": "src/index.cjs",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "@typescript-eslint/typescript-estree": "8.65.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify @typescript-eslint/typescript-estree.parseAndGenerateServices in pkg:npm/%40typescript-eslint/typescript-estree@8.65.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40typescript-eslint/typescript-estree@8.65.0"
  ],
  "symbols": [
    "@typescript-eslint/typescript-estree.parseAndGenerateServices"
  ]
}

'use strict';

const { parseAndGenerateServices, AST_NODE_TYPES } = require('@typescript-eslint/typescript-estree');

/**
 * Parses TypeScript code and generates associated compiler services.
 *
 * @param {string} code - TypeScript source code string.
 * @param {object} [options={}] - Parser options.
 * @returns {{ ast: import('@typescript-eslint/typescript-estree').TSESTree.Program, services: object }}
 */
function parseWithServices(code, options = {}) {
  return parseAndGenerateServices(code, {
    loc: true,
    range: true,
    tokens: true,
    comment: true,
    ...options,
  });
}

/**
 * Gets the corresponding TypeScript compiler AST node from an ESTree AST node.
 *
 * @param {object} services - Services object returned by parseAndGenerateServices.
 * @param {object} esTreeNode - ESTree node.
 * @returns {object|undefined} TypeScript compiler AST node.
 */
function getTSNode(services, esTreeNode) {
  if (!services || !services.esTreeNodeToTSNodeMap) {
    return undefined;
  }
  return services.esTreeNodeToTSNodeMap.get(esTreeNode);
}

/**
 * Gets the corresponding ESTree AST node from a TypeScript compiler AST node.
 *
 * @param {object} services - Services object returned by parseAndGenerateServices.
 * @param {object} tsNode - TypeScript compiler AST node.
 * @returns {object|undefined} ESTree AST node.
 */
function getESTreeNode(services, tsNode) {
  if (!services || !services.tsNodeToESTreeNodeMap) {
    return undefined;
  }
  return services.tsNodeToESTreeNodeMap.get(tsNode);
}

module.exports = {
  parseAndGenerateServices,
  parseWithServices,
  getTSNode,
  getESTreeNode,
  AST_NODE_TYPES,
};

'use strict';

const assert = require('node:assert/strict');
const { parseAndGenerateServices, TSError, AST_NODE_TYPES } = require('@typescript-eslint/typescript-estree');
const { parseWithServices, getTSNode, getESTreeNode } = require('../src/index.cjs');

// 1. parseAndGenerateServices parses TypeScript code and returns an AST with a Program root node
{
  const code = 'const count: number = 42;';
  const result = parseAndGenerateServices(code, { loc: true, range: true });

  assert.ok(result !== null && typeof result === 'object', 'Result must be an object');
  assert.ok(result.ast !== null && typeof result.ast === 'object', 'AST must be present');
  assert.strictEqual(result.ast.type, 'Program', 'AST root type must be Program');
  assert.strictEqual(result.ast.body.length, 1, 'AST body must contain 1 statement');

  const decl = result.ast.body[0];
  assert.strictEqual(decl.type, AST_NODE_TYPES.VariableDeclaration);
  assert.strictEqual(decl.kind, 'const');
  assert.strictEqual(decl.declarations[0].id.name, 'count');
  assert.strictEqual(decl.declarations[0].id.typeAnnotation.typeAnnotation.type, AST_NODE_TYPES.TSNumberKeyword);
  assert.strictEqual(decl.declarations[0].init.value, 42);
}

// 2. parseAndGenerateServices provides services object with esTreeNodeToTSNodeMap and tsNodeToESTreeNodeMap
{
  const code = 'function multiply(a: number, b: number): number { return a * b; }';
  const { ast, services } = parseWithServices(code);

  assert.ok(services !== null && typeof services === 'object', 'services must be an object');
  assert.ok(services.esTreeNodeToTSNodeMap !== undefined, 'esTreeNodeToTSNodeMap must be present');
  assert.ok(services.tsNodeToESTreeNodeMap !== undefined, 'tsNodeToESTreeNodeMap must be present');
  assert.strictEqual(typeof services.esTreeNodeToTSNodeMap.get, 'function', 'esTreeNodeToTSNodeMap must have get method');
  assert.strictEqual(typeof services.tsNodeToESTreeNodeMap.get, 'function', 'tsNodeToESTreeNodeMap must have get method');
}

// 3. parseAndGenerateServices supports bidirectional mapping between ESTree and TypeScript compiler nodes
{
  const code = 'const greeting: string = "hello world";';
  const { ast, services } = parseAndGenerateServices(code, { loc: true, range: true });
  const varNode = ast.body[0];

  const tsNode = getTSNode(services, varNode);
  assert.ok(tsNode !== undefined && tsNode !== null, 'TS node must be found from ESTree node');
  assert.strictEqual(typeof tsNode.kind, 'number', 'TS node kind must be a number');

  const esNodeBack = getESTreeNode(services, tsNode);
  assert.strictEqual(esNodeBack, varNode, 'Mapping back from TS node must return original ESTree node');
}

// 4. parseAndGenerateServices parses TypeScript interface and type declarations with token and location details
{
  const interfaceCode = `
    interface UserProfile {
      id: number;
      name: string;
      isActive: boolean;
    }
  `;
  const { ast } = parseWithServices(interfaceCode);
  assert.strictEqual(ast.body.length, 1);

  const iface = ast.body[0];
  assert.strictEqual(iface.type, AST_NODE_TYPES.TSInterfaceDeclaration);
  assert.strictEqual(iface.id.name, 'UserProfile');
  assert.strictEqual(iface.body.body.length, 3);
  assert.strictEqual(iface.body.body[0].key.name, 'id');
  assert.strictEqual(iface.body.body[1].key.name, 'name');
  assert.strictEqual(iface.body.body[2].key.name, 'isActive');

  assert.ok(Array.isArray(ast.tokens), 'Tokens array should be present');
  assert.ok(ast.tokens.length > 0, 'Tokens array should not be empty');
  assert.ok(iface.loc !== undefined, 'loc should be defined');
  assert.ok(iface.range !== undefined, 'range should be defined');
}

// 5. parseAndGenerateServices throws TSError on invalid TypeScript syntax when filePath is provided
{
  const invalidCode = 'const broken: = 123;';
  let thrownError = null;
  try {
    parseAndGenerateServices(invalidCode, { filePath: 'test-invalid.ts' });
  } catch (err) {
    thrownError = err;
  }

  assert.ok(thrownError !== null, 'parseAndGenerateServices should throw on invalid syntax');
  assert.ok(thrownError instanceof TSError, 'Thrown error must be an instance of TSError');
  assert.strictEqual(thrownError.name, 'TSError');
  assert.ok(thrownError.lineNumber !== undefined, 'lineNumber should be present on TSError');
}

console.log('All parseAndGenerateServices contract assertions passed successfully.');