xo 0.53.0 → 0.54.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-mixed-enums.md

@@ -0,0 +1,88 @@
+---
+description: 'Disallow enums from having both number and string members.'
+---
+
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-mixed-enums** for documentation.
+
+TypeScript enums are allowed to assign numeric or string values to their members.
+Most enums contain either all numbers or all strings, but in theory you can mix-and-match within the same enum.
+Mixing enum member types is generally considered confusing and a bad practice.
+
+## Examples
+
+<!--tabs-->
+
+### ❌ Incorrect
+
+```ts
+enum Status {
+  Unknown,
+  Closed = 1,
+  Open = 'open',
+}
+```
+
+### ✅ Correct (Explicit Numbers)
+
+```ts
+enum Status {
+  Unknown = 0,
+  Closed = 1,
+  Open = 2,
+}
+```
+
+### ✅ Correct (Implicit Numbers)
+
+```ts
+enum Status {
+  Unknown,
+  Closed,
+  Open,
+}
+```
+
+### ✅ Correct (Strings)
+
+```ts
+enum Status {
+  Unknown = 'unknown',
+  Closed = 'closed',
+  Open = 'open',
+}
+```
+
+## Iteration Pitfalls of Mixed Enum Member Values
+
+Enum values may be iterated over using `Object.entries`/`Object.keys`/`Object.values`.
+
+If all enum members are strings, the number of items will match the number of enum members:
+
+```ts
+enum Status {
+  Closed = 'closed',
+  Open = 'open',
+}
+
+// ['closed', 'open']
+Object.values(Status);
+```
+
+But if the enum contains members that are initialized with numbers -including implicitly initialized numbers— then iteration over that enum will include those numbers as well:
+
+```ts
+enum Status {
+  Unknown,
+  Closed = 1,
+  Open = 'open',
+}
+
+// ["Unknown", "Closed", 0, 1, "open"]
+Object.values(Status);
+```
+
+## When Not To Use It
+
+If you don't mind the confusion of mixed enum member values and don't iterate over enums, you can safely disable this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-non-null-assertion.md

@@ -22,7 +22,7 @@ interface Example {
 }
 
 declare const example: Example;
-const includesBaz = foo.property!.includes('baz');
+const includesBaz = example.property!.includes('baz');
 ```
 
 ### ✅ Correct
@@ -33,7 +33,7 @@ interface Example {
 }
 
 declare const example: Example;
-const includesBaz = foo.property?.includes('baz') ?? false;
+const includesBaz = example.property?.includes('baz') ?? false;
 ```
 
 ## When Not To Use It

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-shadow.md

@@ -78,3 +78,24 @@ Examples of **correct** code with `{ ignoreFunctionTypeParameterNameValueShadow:
 const test = 1;
 type Func = (test: string) => typeof test;
 ```
+
+## FAQ
+
+### Why does the rule report on enum members that share the same name as a variable in a parent scope?
+
+Reporting on this case isn't a bug - it is completely intentional and correct reporting! The rule reports due to a relatively unknown feature of enums - enum members create a variable within the enum scope so that they can be referenced within the enum without a qualifier.
+
+To illustrate this with an example:
+
+```ts
+const A = 2;
+enum Test {
+  A = 1,
+  B = A,
+}
+
+console.log(Test.B);
+// what should be logged?
+```
+
+Naively looking at the above code, it might look like the log should output `2`, because the outer variable `A`'s value is `2` - however, the code instead outputs `1`, which is the value of `Test.A`. This is because the unqualified code `B = A` is equivalent to the fully-qualified code `B = Test.A`. Due to this behavior, the enum member has **shadowed** the outer variable declaration.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-function-type.md

@@ -85,3 +85,8 @@ type Intersection = ((data: string) => number) & ((id: number) => string);
 ## When Not To Use It
 
 If you specifically want to use an interface or type literal with a single call signature for stylistic reasons, you can disable this rule.
+
+This rule has a known edge case of sometimes triggering on global augmentations such as `interface Function`.
+These edge cases are rare and often symptomatic of odd code.
+We recommend you use an [inline ESLint disable comment](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1).
+See [#454](https://github.com/typescript-eslint/typescript-eslint/issues/454) for details.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/promise-function-async.md

@@ -11,10 +11,12 @@ Ensures that each function is only capable of:
 - returning a rejected promise, or
 - throwing an Error object.
 
-In contrast, non-`async` `Promise` - returning functions are technically capable of either.
+In contrast, non-`async`, `Promise`-returning functions are technically capable of either.
 Code that handles the results of those functions will often need to handle both cases, which can get complex.
 This rule's practice removes a requirement for creating code to handle both cases.
 
+> When functions return unions of `Promise` and non-`Promise` types implicitly, it is usually a mistake—this rule flags those cases. If it is intentional, make the return type explicitly to allow the rule to pass.
+
 ## Examples
 
 Examples of code for this rule
@@ -29,6 +31,10 @@ const arrowFunctionReturnsPromise = () => Promise.resolve('value');
 function functionReturnsPromise() {
   return Promise.resolve('value');
 }
+
+function functionReturnsUnionWithPromiseImplicitly(p: boolean) {
+  return p ? 'value' : Promise.resolve('value');
+}
 ```
 
 ### ✅ Correct
@@ -39,4 +45,15 @@ const arrowFunctionReturnsPromise = async () => Promise.resolve('value');
 async function functionReturnsPromise() {
   return Promise.resolve('value');
 }
+
+// An explicit return type that is not Promise means this function cannot be made async, so it is ignored by the rule
+function functionReturnsUnionWithPromiseExplicitly(
+  p: boolean,
+): string | Promise<string> {
+  return p ? 'value' : Promise.resolve('value');
+}
+
+async function functionReturnsUnionWithPromiseImplicitly(p: boolean) {
+  return p ? 'value' : Promise.resolve('value');
+}
 ```

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/restrict-template-expressions.md

@@ -90,6 +90,15 @@ const arg = /foo/;
 const msg1 = `arg = ${arg}`;
 ```
 
+### `allowNever`
+
+Examples of additional **correct** code for this rule with `{ allowNever: true }`:
+
+```ts
+const arg = 'something';
+const msg1 = typeof arg === 'string' ? arg : `arg = ${arg}`;
+```
+
 ## Related To
 
 - [`no-base-to-string`](./no-base-to-string.md)

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/strict-boolean-expressions.md

@@ -124,6 +124,12 @@ Allows `number | null | undefined` in a boolean context.
 This is unsafe because nullable numbers can be either a falsy number or nullish.
 Set this to `true` if you don't mind implicitly treating zero or NaN the same as a nullish value.
 
+### `allowNullableEnum`
+
+Allows `enum | null | undefined` in a boolean context.
+This is unsafe because nullable enums can be either a falsy number or nullish.
+Set this to `true` if you don't mind implicitly treating an enum whose value is zero the same as a nullish value.
+
 ### `allowAny`
 
 Allows `any` in a boolean context.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/unified-signatures.md

@@ -38,6 +38,13 @@ function x(x: number | string): void;
 function y(...x: number[]): void;
 ```
 
+```ts
+// This rule won't check overload signatures with different rest parameter types.
+// See https://github.com/microsoft/TypeScript/issues/5077
+function f(...a: number[]): void;
+function f(...a: string[]): void;
+```
+
 ## Options
 
 ### `ignoreDifferentlyNamedParameters`
@@ -53,11 +60,6 @@ function f(a: number): void;
 function f(a: string): void;
 ```
 
-```ts
-function f(...a: number[]): void;
-function f(...b: string[]): void;
-```
-
 ### ✅ Correct
 
 ```ts
@@ -65,9 +67,4 @@ function f(a: number): void;
 function f(b: string): void;
 ```
 
-```ts
-function f(...a: number[]): void;
-function f(...a: string[]): void;
-```
-
 ## Options

package/node_modules/@typescript-eslint/eslint-plugin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typescript-eslint/eslint-plugin",
-  "version": "5.43.0",
+  "version": "5.57.1",
   "description": "TypeScript plugin for ESLint",
   "keywords": [
     "eslint",
@@ -37,20 +37,21 @@
     "clean": "tsc -b tsconfig.build.json --clean",
     "postclean": "rimraf dist && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
-    "generate:configs": "../../node_modules/.bin/ts-node --files --transpile-only tools/generate-configs.ts",
-    "generate:rules-lists": "../../node_modules/.bin/ts-node --files --transpile-only tools/generate-rules-lists.ts",
-    "lint": "eslint . --ignore-path ../../.eslintignore",
+    "generate:breaking-changes": "yarn tsx tools/generate-breaking-changes.ts",
+    "generate:configs": "yarn tsx tools/generate-configs.ts",
+    "lint": "nx lint",
     "test": "jest --coverage",
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
-    "@typescript-eslint/scope-manager": "5.43.0",
-    "@typescript-eslint/type-utils": "5.43.0",
-    "@typescript-eslint/utils": "5.43.0",
+    "@eslint-community/regexpp": "^4.4.0",
+    "@typescript-eslint/scope-manager": "5.57.1",
+    "@typescript-eslint/type-utils": "5.57.1",
+    "@typescript-eslint/utils": "5.57.1",
     "debug": "^4.3.4",
+    "grapheme-splitter": "^1.0.4",
     "ignore": "^5.2.0",
     "natural-compare-lite": "^1.4.0",
-    "regexpp": "^3.2.0",
     "semver": "^7.3.7",
     "tsutils": "^3.21.0"
   },
@@ -61,7 +62,10 @@
     "@types/natural-compare-lite": "^1.4.0",
     "@types/prettier": "*",
     "chalk": "^5.0.1",
+    "cross-fetch": "^3.1.5",
+    "grapheme-splitter": "^1.0.4",
     "json-schema": "*",
+    "markdown-table": "^3.0.2",
     "marked": "^4.0.15",
     "prettier": "*",
     "title-case": "^3.0.3",
@@ -80,5 +84,5 @@
     "type": "opencollective",
     "url": "https://opencollective.com/typescript-eslint"
   },
-  "gitHead": "8af1b4d970438b27ea041717bddadc41af8fc72a"
+  "gitHead": "772b19cd4b3d565670c07a1a42b36ee082a20387"
 }

package/node_modules/@typescript-eslint/parser/LICENSE

@@ -4,11 +4,11 @@ Copyright JS Foundation and other contributors, https://js.foundation
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
-  * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-  * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

package/node_modules/@typescript-eslint/parser/README.md

@@ -1,304 +1,10 @@
-<h1 align="center">TypeScript ESLint Parser</h1>
+# `@typescript-eslint/parser`
 
-<p align="center">An ESLint parser which leverages <a href="https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/typescript-estree">TypeScript ESTree</a> to allow for ESLint to lint TypeScript source code.</p>
+> An ESLint parser which leverages <a href="https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/typescript-estree">TypeScript ESTree</a> to allow for ESLint to lint TypeScript source code.
 
-<p align="center">
-    <img src="https://github.com/typescript-eslint/typescript-eslint/workflows/CI/badge.svg" alt="CI" />
-    <a href="https://www.npmjs.com/package/@typescript-eslint/parser"><img src="https://img.shields.io/npm/v/@typescript-eslint/parser.svg?style=flat-square" alt="NPM Version" /></a>
-    <a href="https://www.npmjs.com/package/@typescript-eslint/parser"><img src="https://img.shields.io/npm/dm/@typescript-eslint/parser.svg?style=flat-square" alt="NPM Downloads" /></a>
-</p>
+[![NPM Version](https://img.shields.io/npm/v/@typescript-eslint/parser.svg?style=flat-square)](https://www.npmjs.com/package/@typescript-eslint/parser)
+[![NPM Downloads](https://img.shields.io/npm/dm/@typescript-eslint/parser.svg?style=flat-square)](https://www.npmjs.com/package/@typescript-eslint/parser)
 
-## Getting Started
+👉 See **https://typescript-eslint.io/architecture/parser** for documentation on this package.
 
-**[You can find our Getting Started docs here](https://typescript-eslint.io/docs)**
-
-These docs walk you through setting up ESLint, this parser, and our plugin. If you know what you're doing and just want to quick start, read on...
-
-## Quick-start
-
-### Installation
-
-```bash
-$ yarn add -D typescript @typescript-eslint/parser
-$ npm i --save-dev typescript @typescript-eslint/parser
-```
-
-### Usage
-
-In your ESLint configuration file, set the `parser` property:
-
-```json
-{
-  "parser": "@typescript-eslint/parser"
-}
-```
-
-There is sometimes an incorrect assumption that the parser itself is what does everything necessary to facilitate the use of ESLint with TypeScript. In actuality, it is the combination of the parser _and_ one or more plugins which allow you to maximize your usage of ESLint with TypeScript.
-
-For example, once this parser successfully produces an AST for the TypeScript source code, it might well contain some information which simply does not exist in a standard JavaScript context, such as the data for a TypeScript-specific construct, like an `interface`.
-
-The core rules built into ESLint, such as `indent` have no knowledge of such constructs, so it is impossible to expect them to work out of the box with them.
-
-Instead, you also need to make use of one more plugins which will add or extend rules with TypeScript-specific features.
-
-By far the most common case will be installing the [`@typescript-eslint/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin) plugin, but there are also other relevant options available such a [`@typescript-eslint/eslint-plugin-tslint`](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin-tslint).
-
-## Configuration
-
-The following additional configuration options are available by specifying them in [`parserOptions`](https://eslint.org/docs/user-guide/configuring/language-options#specifying-parser-options) in your ESLint configuration file.
-
-```ts
-interface ParserOptions {
-  ecmaFeatures?: {
-    jsx?: boolean;
-    globalReturn?: boolean;
-  };
-  ecmaVersion?: number | 'latest';
-
-  jsxPragma?: string | null;
-  jsxFragmentName?: string | null;
-  lib?: string[];
-
-  project?: string | string[];
-  projectFolderIgnoreList?: string[];
-  tsconfigRootDir?: string;
-  extraFileExtensions?: string[];
-  warnOnUnsupportedTypeScriptVersion?: boolean;
-
-  program?: import('typescript').Program;
-  moduleResolver?: string;
-
-  emitDecoratorMetadata?: boolean;
-}
-```
-
-### `parserOptions.ecmaFeatures.jsx`
-
-Default `false`.
-
-Enable parsing JSX when `true`. More details can be found [here](https://www.typescriptlang.org/docs/handbook/jsx.html).
-
-**NOTE:** this setting does not affect known file types (`.js`, `.mjs`, `.cjs`, `.jsx`, `.ts`, `.mts`, `.cts`, `.tsx`, `.json`) because the TypeScript compiler has its own internal handling for known file extensions.
-
-<!-- https://github.com/microsoft/TypeScript/blob/d6e483b8dabd8fd37c00954c3f2184bb7f1eb90c/src/compiler/utilities.ts#L6281-L6285 -->
-
-The exact behavior is as follows:
-
-- `.js`, `.mjs`, `.cjs`, `.jsx`, `.tsx` files are always parsed as if this is `true`.
-- `.ts`, `.mts`, `.cts` files are always parsed as if this is `false`.
-- For "unknown" extensions (`.md`, `.vue`):
-  - If `parserOptions.project` is _not_ provided:
-    - The setting will be respected.
-  - If `parserOptions.project` is provided (i.e. you are using rules with type information):
-    - **always parsed as if this is `false`**
-
-### `parserOptions.ecmaFeatures.globalReturn`
-
-Default `false`.
-
-This options allows you to tell the parser if you want to allow global `return` statements in your codebase.
-
-### `parserOptions.ecmaVersion`
-
-Default `2018`.
-
-Accepts any valid ECMAScript version number or `'latest'`:
-
-- A version: es3, es5, es6, es7, es8, es9, es10, es11, es12, es13, ..., or
-- A year: es2015, es2016, es2017, es2018, es2019, es2020, es2021, es2022, ..., or
-- `'latest'`
-
-When it's a version or a year, the value **must** be a number - so do not include the `es` prefix.
-
-Specifies the version of ECMAScript syntax you want to use. This is used by the parser to determine how to perform scope analysis, and it affects the default
-
-### `parserOptions.jsxPragma`
-
-Default `'React'`
-
-The identifier that's used for JSX Elements creation (after transpilation).
-If you're using a library other than React (like `preact`), then you should change this value. If you are using the [new JSX transform](https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html) you can set this to `null`.
-
-This should not be a member expression - just the root identifier (i.e. use `"React"` instead of `"React.createElement"`).
-
-If you provide `parserOptions.project`, you do not need to set this, as it will automatically detected from the compiler.
-
-### `parserOptions.jsxFragmentName`
-
-Default `null`
-
-The identifier that's used for JSX fragment elements (after transpilation).
-If `null`, assumes transpilation will always use a member of the configured `jsxPragma`.
-This should not be a member expression - just the root identifier (i.e. use `"h"` instead of `"h.Fragment"`).
-
-If you provide `parserOptions.project`, you do not need to set this, as it will automatically detected from the compiler.
-
-### `parserOptions.lib`
-
-Default `['es2018']`
-
-For valid options, see the [TypeScript compiler options](https://www.typescriptlang.org/tsconfig#lib).
-
-Specifies the TypeScript `lib`s that are available. This is used by the scope analyser to ensure there are global variables declared for the types exposed by TypeScript.
-
-If you provide `parserOptions.project`, you do not need to set this, as it will automatically detected from the compiler.
-
-### `parserOptions.project`
-
-Default `undefined`.
-
-This option allows you to provide a path to your project's `tsconfig.json`. **This setting is required if you want to use rules which require type information**. Relative paths are interpreted relative to the current working directory if `tsconfigRootDir` is not set. If you intend on running ESLint from directories other than the project root, you should consider using `tsconfigRootDir`.
-
-- Accepted values:
-
-  ```js
-  // path
-  project: './tsconfig.json';
-
-  // glob pattern
-  project: './packages/**/tsconfig.json';
-
-  // array of paths and/or glob patterns
-  project: ['./packages/**/tsconfig.json', './separate-package/tsconfig.json'];
-  ```
-
-- If you use project references, TypeScript will not automatically use project references to resolve files. This means that you will have to add each referenced tsconfig to the `project` field either separately, or via a glob.
-
-- Note that using wide globs `**` in your `parserOptions.project` may cause performance implications. Instead of globs that use `**` to recursively check all folders, prefer paths that use a single `*` at a time. For more info see [#2611](https://github.com/typescript-eslint/typescript-eslint/issues/2611).
-
-- TypeScript will ignore files with duplicate filenames in the same folder (for example, `src/file.ts` and `src/file.js`). TypeScript purposely ignore all but one of the files, only keeping the one file with the highest priority extension (the extension priority order (from highest to lowest) is `.ts`, `.tsx`, `.d.ts`, `.js`, `.jsx`). For more info see #955.
-
-- Note that if this setting is specified and `createDefaultProgram` is not, you must only lint files that are included in the projects as defined by the provided `tsconfig.json` files. If your existing configuration does not include all of the files you would like to lint, you can create a separate `tsconfig.eslint.json` as follows:
-
-  ```jsonc
-  {
-    // extend your base config so you don't have to redefine your compilerOptions
-    "extends": "./tsconfig.json",
-    "include": [
-      "src/**/*.ts",
-      "test/**/*.ts",
-      "typings/**/*.ts",
-      // etc
-
-      // if you have a mixed JS/TS codebase, don't forget to include your JS files
-      "src/**/*.js"
-    ]
-  }
-  ```
-
-### `parserOptions.tsconfigRootDir`
-
-Default `undefined`.
-
-This option allows you to provide the root directory for relative tsconfig paths specified in the `project` option above.
-
-### `parserOptions.projectFolderIgnoreList`
-
-Default `["**/node_modules/**"]`.
-
-This option allows you to ignore folders from being included in your provided list of `project`s.
-This is useful if you have configured glob patterns, but want to make sure you ignore certain folders.
-
-It accepts an array of globs to exclude from the `project` globs.
-
-For example, by default it will ensure that a glob like `./**/tsconfig.json` will not match any `tsconfig`s within your `node_modules` folder (some npm packages do not exclude their source files from their published packages).
-
-### `parserOptions.extraFileExtensions`
-
-Default `undefined`.
-
-This option allows you to provide one or more additional file extensions which should be considered in the TypeScript Program compilation.
-The default extensions are `['.js', '.mjs', '.cjs', '.jsx', '.ts', '.mts', '.cts', '.tsx']`.
-Add extensions starting with `.`, followed by the file extension. E.g. for a `.vue` file use `"extraFileExtensions": [".vue"]`.
-
-### `parserOptions.warnOnUnsupportedTypeScriptVersion`
-
-Default `true`.
-
-This option allows you to toggle the warning that the parser will give you if you use a version of TypeScript which is not explicitly supported
-
-### `parserOptions.createDefaultProgram`
-
-Default `false`.
-
-This option allows you to request that when the `project` setting is specified, files will be allowed when not included in the projects defined by the provided `tsconfig.json` files. **Using this option will incur significant performance costs. This option is primarily included for backwards-compatibility.** See the **`project`** section above for more information.
-
-### `parserOptions.programs`
-
-Default `undefined`.
-
-This option allows you to programmatically provide an array of one or more instances of a TypeScript Program object that will provide type information to rules.
-This will override any programs that would have been computed from `parserOptions.project` or `parserOptions.createDefaultProgram`.
-All linted files must be part of the provided program(s).
-
-### `parserOptions.moduleResolver`
-
-Default `undefined`.
-
-This option allows you to provide a custom module resolution. The value should point to a JS file that default exports (`export default`, or `module.exports =`, or `export =`) a file with the following interface:
-
-```ts
-interface ModuleResolver {
-  version: 1;
-  resolveModuleNames(
-    moduleNames: string[],
-    containingFile: string,
-    reusedNames: string[] | undefined,
-    redirectedReference: ts.ResolvedProjectReference | undefined,
-    options: ts.CompilerOptions,
-  ): (ts.ResolvedModule | undefined)[];
-}
-```
-
-[Refer to the TypeScript Wiki for an example on how to write the `resolveModuleNames` function](https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API#customizing-module-resolution).
-
-Note that if you pass custom programs via `options.programs` this option will not have any effect over them (you can simply add the custom resolution on them directly).
-
-### `parserOptions.emitDecoratorMetadata`
-
-Default `undefined`.
-
-This option allow you to tell parser to act as if `emitDecoratorMetadata: true` is set in `tsconfig.json`, but without [type-aware linting](https://typescript-eslint.io/docs/linting/typed-linting). In other words, you don't have to specify `parserOptions.project` in this case, making the linting process faster.
-
-## Utilities
-
-### `createProgram(configFile, projectDirectory)`
-
-This serves as a utility method for users of the `parserOptions.programs` feature to create a TypeScript program instance from a config file.
-
-```ts
-declare function createProgram(
-  configFile: string,
-  projectDirectory?: string,
-): import('typescript').Program;
-```
-
-Example usage in .eslintrc.js:
-
-```js
-const parser = require('@typescript-eslint/parser');
-const programs = [parser.createProgram('tsconfig.json')];
-module.exports = {
-  parserOptions: {
-    programs,
-  },
-};
-```
-
-## Supported TypeScript Version
-
-Please see [`typescript-eslint`](https://github.com/typescript-eslint/typescript-eslint) for the supported TypeScript version.
-
-**Please ensure that you are using a supported version before submitting any issues/bug reports.**
-
-## Reporting Issues
-
-Please use the `@typescript-eslint/parser` issue template when creating your issue and fill out the information requested as best you can. This will really help us when looking into your issue.
-
-## License
-
-TypeScript ESLint Parser is licensed under a permissive BSD 2-clause license.
-
-## Contributing
-
-[See the contributing guide here](../../CONTRIBUTING.md)
+> See https://typescript-eslint.io for general documentation on typescript-eslint, the tooling that allows you to run ESLint and Prettier on TypeScript code.

package/node_modules/@typescript-eslint/parser/_ts3.4/dist/index.d.ts

@@ -1,4 +1,8 @@
 export { parse, parseForESLint, ParserOptions } from './parser';
 export { ParserServices, clearCaches, createProgram, } from '@typescript-eslint/typescript-estree';
 export declare const version: string;
+export declare const meta: {
+    name: string;
+    version: string;
+};
 //# sourceMappingURL=index.d.ts.map

package/node_modules/@typescript-eslint/parser/dist/index.d.ts

@@ -1,4 +1,8 @@
 export { parse, parseForESLint, ParserOptions } from './parser';
 export { ParserServices, clearCaches, createProgram, } from '@typescript-eslint/typescript-estree';
 export declare const version: string;
+export declare const meta: {
+    name: string;
+    version: string;
+};
 //# sourceMappingURL=index.d.ts.map

package/node_modules/@typescript-eslint/parser/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EACL,cAAc,EACd,WAAW,EACX,aAAa,GACd,MAAM,sCAAsC,CAAC;AAI9C,eAAO,MAAM,OAAO,EAAE,MAA2C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EACL,cAAc,EACd,WAAW,EACX,aAAa,GACd,MAAM,sCAAsC,CAAC;AAI9C,eAAO,MAAM,OAAO,EAAE,MAA2C,CAAC;AAElE,eAAO,MAAM,IAAI;;;CAGhB,CAAC"}