From 21ccaabbf732386b3bed6ffd839270ab09ee3f12 Mon Sep 17 00:00:00 2001 From: Nevada Le Master Date: Wed, 12 Jul 2023 07:22:15 -0700 Subject: [PATCH] docs: add warnOnUnsupportedTypeScript warning message (#7172) * docs: add warnOnUnsupportedTypeScript warning message * docs: swap console with plaintext for md code block language --- docs/packages/Parser.mdx | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/packages/Parser.mdx b/docs/packages/Parser.mdx index b710ec5faca..a4faf2a8446 100644 --- a/docs/packages/Parser.mdx +++ b/docs/packages/Parser.mdx @@ -231,7 +231,23 @@ Doing so ensures running ESLint from a directory other than the root will still > 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 +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. The warning message would look like this: + +```plaintext +============= + +WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree. + +You may find that it works just fine, or you may not. + +SUPPORTED TYPESCRIPT VERSIONS: >=3.3.1 <5.1.0 + +YOUR TYPESCRIPT VERSION: 5.1.3 + +Please only submit bug reports when using the officially supported version. + +============= +``` ## Utilities