@typescript-eslint/typescript-estree 8.69.0: TSError

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

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

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:a0cedd52c52772e91c22629fb19f0bbe1bf6288df817bc99ba1598557d92c94b","contract":["TSError is a class extending Error with name property TSError","TSError provides lineNumber, column, and index getters derived from location.start","TSError can be instantiated directly with message, fileName, and location","parse throws TSError containing syntax error details and location for invalid source","isTSError correctly identifies TSError instances versus standard Error instances"],"goal":"verify @typescript-eslint/typescript-estree.TSError in pkg:npm/%40typescript-eslint/typescript-estree@8.69.0","kind":"HOW","packages":["pkg:npm/%40typescript-eslint/typescript-estree@8.69.0"],"schemaVersion":1,"symbols":["@typescript-eslint/typescript-estree.TSError"]},"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.69.0"],"schemaVersion":1,"subject":"pkg:npm/%40typescript-eslint/typescript-estree@8.69.0","symbols":["@typescript-eslint/typescript-estree.TSError"],"verifierAdapter":"node-typescript@1"}

'use strict';

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

/**
 * Checks if a given error is an instance of TSError.
 * @param {unknown} error - The error to check.
 * @returns {boolean} True if the error is a TSError.
 */
function isTSError(error) {
  return error instanceof TSError;
}

/**
 * Creates a new TSError instance.
 * @param {string} message - Error message.
 * @param {string} fileName - File name where the error occurred.
 * @param {object} location - Location object containing start and end coordinates.
 * @returns {TSError} A new TSError instance.
 */
function createTSError(message, fileName, location) {
  return new TSError(message, fileName, location);
}

/**
 * Safely parses TypeScript source code, returning the AST or error information.
 * @param {string} code - The TypeScript source code to parse.
 * @param {object} [options] - Optional parser options.
 * @returns {{ ast?: object, error?: TSError | Error }} Result object.
 */
function safeParse(code, options) {
  try {
    const ast = parse(code, options);
    return { ast };
  } catch (error) {
    return { error };
  }
}

module.exports = {
  TSError,
  isTSError,
  createTSError,
  safeParse,
};

{
  "name": "sample-typescript-estree-tserror",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-typescript-estree-tserror",
      "version": "1.0.0",
      "dependencies": {
        "@typescript-eslint/typescript-estree": "8.69.0"
      }
    },
    "node_modules/@typescript-eslint/project-service": {
      "version": "8.69.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/project-service/-/project-service-8.69.0.tgz",
      "integrity": "sha512-yi4obFrHMmnsesWehHbkg9zMA7Jt8cXT+mKM08G999pH1yT6nqgsHx7MYm0uY1wAj8CqiBXYRJ7WAT0QdQHQXg==",
      "license": "MIT",
      "dependencies": {
        "@typescript-eslint/tsconfig-utils": "^8.69.0",
        "@typescript-eslint/types": "^8.69.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.69.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/tsconfig-utils/-/tsconfig-utils-8.69.0.tgz",
      "integrity": "sha512-xNqK7YTDZsLniQMV/4rpFR8Z5JlqeRvVjuG1YgF/mdPVH84HSD19L8CczMA0qg2RfwEV231GHH3VnToJDo4MfQ==",
      "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.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/typescript-estree": {
      "version": "8.69.0",
      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.69.0.tgz",
      "integrity": "sha512-AdFkgqck3Vudb/kWnxlyafU/4aBhHrbQ9locP2N4psXTy5mOBg0SHJumnLvx7r6g1gV4DKvUFwV2nJZBoqOD8w==",
      "license": "MIT",
      "dependencies": {
        "@typescript-eslint/project-service": "8.69.0",
        "@typescript-eslint/tsconfig-utils": "8.69.0",
        "@typescript-eslint/types": "8.69.0",
        "@typescript-eslint/visitor-keys": "8.69.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.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/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.12",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.12.tgz",
      "integrity": "sha512-YovQ3rzhaLMIrDjNDMkNS01tea93qhEhG5xy8f6+R0l+dw3Ki+5sCoIoI942iuLZTHWogWktgwVDhU09iNEimQ==",
      "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-tserror",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification of @typescript-eslint/typescript-estree TSError",
  "dependencies": {
    "@typescript-eslint/typescript-estree": "8.69.0"
  },
  "scripts": {
    "test": "node test/contract.cjs"
  }
}

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

'use strict';

const assert = require('node:assert/strict');
const { TSError, parse } = require('@typescript-eslint/typescript-estree');
const { isTSError, createTSError, safeParse } = require('../index.cjs');

// 1. TSError is a class extending Error with name property TSError
assert.equal(typeof TSError, 'function', 'TSError must be exported as a class / constructor');
assert.ok(TSError.prototype instanceof Error, 'TSError prototype must inherit from Error');

// 2. TSError provides lineNumber, column, and index getters derived from location.start
const mockLocation = {
  start: { line: 5, column: 12, offset: 42 },
  end: { line: 5, column: 18, offset: 48 },
};
const customErr = new TSError('Custom syntax error', 'test.ts', mockLocation);

assert.equal(customErr.name, 'TSError', 'TSError name must be TSError');
assert.equal(customErr.message, 'Custom syntax error');
assert.equal(customErr.fileName, 'test.ts');
assert.equal(customErr.lineNumber, 5, 'lineNumber must match location.start.line');
assert.equal(customErr.column, 12, 'column must match location.start.column');
assert.equal(customErr.index, 42, 'index must match location.start.offset');
assert.deepEqual(customErr.location, mockLocation);

// 3. TSError can be instantiated directly with message, fileName, and location
const helperErr = createTSError('Helper created error', 'example.ts', mockLocation);
assert.ok(helperErr instanceof TSError, 'createTSError must return a TSError instance');
assert.equal(helperErr.message, 'Helper created error');
assert.equal(helperErr.fileName, 'example.ts');

// 4. parse throws TSError containing syntax error details and location for invalid source
const invalidCode = 'const a: number = ;';
let caughtError = null;
try {
  parse(invalidCode, { filePath: 'invalid.ts' });
} catch (err) {
  caughtError = err;
}

assert.ok(caughtError !== null, 'parse must throw on invalid syntax');
assert.ok(caughtError instanceof TSError, 'caught error must be an instance of TSError');
assert.equal(caughtError.name, 'TSError');
assert.equal(typeof caughtError.message, 'string');
assert.ok(caughtError.message.length > 0);
assert.equal(caughtError.lineNumber, 1);
assert.equal(caughtError.column, 18);
assert.equal(caughtError.index, 18);
assert.ok(caughtError.location && caughtError.location.start);

// safeParse helper returns error on invalid code
const parseResult = safeParse(invalidCode);
assert.ok(parseResult.error instanceof TSError);
assert.equal(parseResult.ast, undefined);

// safeParse helper returns AST on valid code
const validResult = safeParse('const a: number = 42;');
assert.equal(validResult.error, undefined);
assert.ok(validResult.ast && validResult.ast.type === 'Program');

// 5. isTSError correctly identifies TSError instances versus standard Error instances
assert.equal(isTSError(customErr), true, 'isTSError must return true for TSError instance');
assert.equal(isTSError(caughtError), true, 'isTSError must return true for thrown TSError');
assert.equal(isTSError(new Error('regular error')), false, 'isTSError must return false for standard Error');
assert.equal(isTSError(null), false, 'isTSError must return false for null');
assert.equal(isTSError('string error'), false, 'isTSError must return false for string');

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