feat(typescript-estree): remove legacy useJSXTextNode option (#3109)

typescript-eslint · Sep 21, 2021 · 2ee41b9 · 2ee41b9
1 parent 8b96290
commit 2ee41b9
Show file tree

Hide file tree

Showing 31 changed files with 51 additions and 112 deletions.
diff --git a/packages/typescript-estree/README.md b/packages/typescript-estree/README.md
@@ -101,14 +101,6 @@ interface ParseOptions {
    * Set to true to create a top-level array containing all tokens from the file.
    */
   tokens?: boolean;
-
-  /*
-   * The JSX AST changed the node type for string literals
-   * inside a JSX Element from `Literal` to `JSXText`.
-   * When value is `true`, these nodes will be parsed as type `JSXText`.
-   * When value is `false`, these nodes will be parsed as type `Literal`.
-   */
-  useJSXTextNode?: boolean;
 }
 
 const PARSE_DEFAULT_OPTIONS: ParseOptions = {
@@ -120,7 +112,6 @@ const PARSE_DEFAULT_OPTIONS: ParseOptions = {
   loggerFn: undefined,
   range: false,
   tokens: false,
-  useJSXTextNode: false,
 };
 
 declare function parse(

diff --git a/packages/typescript-estree/src/ast-converter.ts b/packages/typescript-estree/src/ast-converter.ts
@@ -25,7 +25,6 @@ export function astConverter(
    */
   const instance = new Converter(ast, {
     errorOnUnknownASTType: extra.errorOnUnknownASTType || false,
-    useJSXTextNode: extra.useJSXTextNode || false,
     shouldPreserveNodeMaps,
   });
 

diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -36,7 +36,6 @@ const SyntaxKind = ts.SyntaxKind;
 
 interface ConverterOptions {
   errorOnUnknownASTType: boolean;
-  useJSXTextNode: boolean;
   shouldPreserveNodeMaps: boolean;
 }
 
@@ -2250,32 +2249,17 @@ export class Converter {
         });
       }
 
-      /**
-       * The JSX AST changed the node type for string literals
-       * inside a JSX Element from `Literal` to `JSXText`. We
-       * provide a flag to support both types until `Literal`
-       * node type is deprecated in ESLint v5.
-       */
       case SyntaxKind.JsxText: {
         const start = node.getFullStart();
         const end = node.getEnd();
         const text = this.ast.text.slice(start, end);
 
-        if (this.options.useJSXTextNode) {
-          return this.createNode<TSESTree.JSXText>(node, {
-            type: AST_NODE_TYPES.JSXText,
-            value: unescapeStringLiteralText(text),
-            raw: text,
-            range: [start, end],
-          });
-        } else {
-          return this.createNode<TSESTree.StringLiteral>(node, {
-            type: AST_NODE_TYPES.Literal,
-            value: unescapeStringLiteralText(text),
-            raw: text,
-            range: [start, end],
-          });
-        }
+        return this.createNode<TSESTree.JSXText>(node, {
+          type: AST_NODE_TYPES.JSXText,
+          value: unescapeStringLiteralText(text),
+          raw: text,
+          range: [start, end],
+        });
       }
 
       case SyntaxKind.JsxSpreadAttribute:

diff --git a/packages/typescript-estree/src/parser-options.ts b/packages/typescript-estree/src/parser-options.ts
@@ -27,7 +27,6 @@ export interface Extra {
   strict: boolean;
   tokens: null | TSESTree.Token[];
   tsconfigRootDir: string;
-  useJSXTextNode: boolean;
   moduleResolver: string;
 }
 
@@ -100,14 +99,6 @@ interface ParseOptions {
    * Set to true to create a top-level array containing all tokens from the file.
    */
   tokens?: boolean;
-
-  /*
-   * The JSX AST changed the node type for string literals
-   * inside a JSX Element from `Literal` to `JSXText`.
-   * When value is `true`, these nodes will be parsed as type `JSXText`.
-   * When value is `false`, these nodes will be parsed as type `Literal`.
-   */
-  useJSXTextNode?: boolean;
 }
 
 interface ParseAndGenerateServicesOptions extends ParseOptions {

diff --git a/packages/typescript-estree/src/parser.ts b/packages/typescript-estree/src/parser.ts
@@ -129,7 +129,6 @@ function resetExtra(): void {
     strict: false,
     tokens: null,
     tsconfigRootDir: process.cwd(),
-    useJSXTextNode: false,
     /**
      * Unless we can reliably infer otherwise, we default to assuming that this run could be part
      * of a long-running session (e.g. in an IDE) and watch programs will therefore be required
@@ -251,17 +250,6 @@ function applyParserOptionsToExtra(options: TSESTreeOptions): void {
     extra.filePath = getFileName(extra);
   }
 
-  /**
-   * The JSX AST changed the node type for string literals
-   * inside a JSX Element from `Literal` to `JSXText`.
-   *
-   * When value is `true`, these nodes will be parsed as type `JSXText`.
-   * When value is `false`, these nodes will be parsed as type `Literal`.
-   */
-  if (typeof options.useJSXTextNode === 'boolean' && options.useJSXTextNode) {
-    extra.useJSXTextNode = true;
-  }
-
   /**
    * Allow the user to cause the parser to error if it encounters an unknown AST Node Type
    * (used in testing)

diff --git a/packages/typescript-estree/src/ts-estree/estree-to-ts-node-types.ts b/packages/typescript-estree/src/ts-estree/estree-to-ts-node-types.ts
@@ -100,7 +100,6 @@ export interface EstreeToTsNodeTypes {
     | ts.StringLiteral
     | ts.NumericLiteral
     | ts.RegularExpressionLiteral
-    | ts.JsxText
     | ts.NullLiteral
     | ts.BooleanLiteral
     | ts.BigIntLiteral;

diff --git a/packages/typescript-estree/tests/ast-alignment/parse.ts b/packages/typescript-estree/tests/ast-alignment/parse.ts
@@ -50,7 +50,6 @@ function parseWithTypeScriptESTree(text: string, jsx = true): parser.AST<any> {
       range: true,
       tokens: false,
       comment: false,
-      useJSXTextNode: true,
       errorOnUnknownASTType: true,
       /**
        * Babel will always throw on these types of issues, so we enable

diff --git a/packages/typescript-estree/tests/lib/convert.test.ts b/packages/typescript-estree/tests/lib/convert.test.ts
@@ -27,7 +27,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: false,
     });
     expect(instance.convertProgram()).toMatchSnapshot();
@@ -38,7 +37,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: false,
     }) as any;
 
@@ -50,7 +48,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: false,
     }) as any;
 
@@ -62,7 +59,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: false,
     }) as any;
 
@@ -76,7 +72,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: false,
     }) as any;
     expect(instance.deeplyCopy(ast)).toMatchSnapshot();
@@ -87,7 +82,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: true,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: false,
     }) as any;
 
@@ -106,7 +100,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: true,
     });
     instance.convertProgram();
@@ -140,7 +133,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: true,
     });
     instance.convertProgram();
@@ -173,7 +165,6 @@ describe('convert', () => {
 
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: true,
     });
     const program = instance.convertProgram();
@@ -205,7 +196,6 @@ describe('convert', () => {
     const ast = convertCode('');
     const instance = new Converter(ast, {
       errorOnUnknownASTType: false,
-      useJSXTextNode: false,
       shouldPreserveNodeMaps: true,
     });
 
@@ -250,7 +240,6 @@ describe('convert', () => {
 
       const instance = new Converter(ast, {
         errorOnUnknownASTType: false,
-        useJSXTextNode: false,
         shouldPreserveNodeMaps: false,
       });
       expect(() => instance.convertProgram()).toThrow(

diff --git a/packages/typescript-estree/tests/lib/semanticInfo.test.ts b/packages/typescript-estree/tests/lib/semanticInfo.test.ts
@@ -28,7 +28,6 @@ function createOptions(fileName: string): TSESTreeOptions & { cwd?: string } {
     tokens: true,
     comment: true,
     jsx: false,
-    useJSXTextNode: false,
     errorOnUnknownASTType: true,
     filePath: fileName,
     tsconfigRootDir: path.join(process.cwd(), FIXTURES_DIR),

diff --git a/packages/typescript-estree/tests/snapshots/comments/jsx-attr-and-text-with-url.src.js.shot b/packages/typescript-estree/tests/snapshots/comments/jsx-attr-and-text-with-url.src.js.shot
@@ -42,7 +42,7 @@ Object {
                   61,
                 ],
                 "raw": "http://example.com",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "http://example.com",
               },
             ],

diff --git a/packages/typescript-estree/tests/snapshots/comments/jsx-block-comment.src.js.shot b/packages/typescript-estree/tests/snapshots/comments/jsx-block-comment.src.js.shot
@@ -48,7 +48,7 @@ Object {
                         ],
                         "raw": "
             ",
-                        "type": "Literal",
+                        "type": "JSXText",
                         "value": "
             ",
                       },
@@ -103,7 +103,7 @@ Object {
                         ],
                         "raw": "
         ",
-                        "type": "Literal",
+                        "type": "JSXText",
                         "value": "
         ",
                       },

diff --git a/...es/typescript-estree/tests/snapshots/comments/jsx-generic-with-comment-in-tag.src.js.shot b/...es/typescript-estree/tests/snapshots/comments/jsx-generic-with-comment-in-tag.src.js.shot
@@ -43,7 +43,7 @@ Object {
                 ],
                 "raw": "
     ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
     ",
               },
@@ -190,7 +190,7 @@ Object {
                 ],
                 "raw": "
     ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
     ",
               },
@@ -374,7 +374,7 @@ Object {
                 ],
                 "raw": "
     ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
     ",
               },
@@ -558,7 +558,7 @@ Object {
                 ],
                 "raw": "
     ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
     ",
               },
@@ -779,7 +779,7 @@ Object {
                 "raw": "
 
     ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
 
     ",
@@ -927,7 +927,7 @@ Object {
                 ],
                 "raw": "
     ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
     ",
               },
@@ -1111,7 +1111,7 @@ Object {
                 ],
                 "raw": "
     ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
     ",
               },
@@ -1295,7 +1295,7 @@ Object {
                 ],
                 "raw": "
     ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
     ",
               },
@@ -1515,7 +1515,7 @@ Object {
                 ],
                 "raw": "
   ",
-                "type": "Literal",
+                "type": "JSXText",
                 "value": "
   ",
               },

diff --git a/packages/typescript-estree/tests/snapshots/comments/jsx-tag-comments.src.js.shot b/packages/typescript-estree/tests/snapshots/comments/jsx-tag-comments.src.js.shot
@@ -48,7 +48,7 @@ Object {
                         ],
                         "raw": "
         ",
-                        "type": "Literal",
+                        "type": "JSXText",
                         "value": "
         ",
                       },

diff --git a/...ypescript-estree/tests/snapshots/comments/jsx-text-with-multiline-non-comment.src.js.shot b/...ypescript-estree/tests/snapshots/comments/jsx-text-with-multiline-non-comment.src.js.shot
@@ -51,7 +51,7 @@ Object {
        * test
        */
     ",
-                        "type": "Literal",
+                        "type": "JSXText",
                         "value": "
       /**
        * test