fix(typescript-estree): options range loc being always true (typescript-eslint#704)

Mark1626 · bradzacher · bradzacher · commit db1aa185c91a · 2019-11-11T17:50:53.000-08:00
Co-authored-by: Brad Zacher &lt;brad.zacher@gmail.com&gt;
diff --git a/packages/parser/src/analyze-scope.ts b/packages/parser/src/analyze-scope.ts
@@ -7,7 +7,7 @@ import { getKeys as fallback } from 'eslint-visitor-keys';
 
 import { ParserOptions } from './parser-options';
 import { ScopeManager } from './scope/scope-manager';
-import { visitorKeys as childVisitorKeys } from './visitor-keys';
+import { visitorKeys as childVisitorKeys } from '@typescript-eslint/typescript-estree';
 
 /**
  * Define the override function of `Scope#__define` for global augmentation.
diff --git a/packages/parser/src/parser.ts b/packages/parser/src/parser.ts
@@ -5,10 +5,10 @@ import {
   ParserServices,
   TSESTreeOptions,
   TSESTree,
+  simpleTraverse,
+  visitorKeys,
 } from '@typescript-eslint/typescript-estree';
 import { analyzeScope } from './analyze-scope';
-import { simpleTraverse } from './simple-traverse';
-import { visitorKeys } from './visitor-keys';
 
 type ParserOptions = TSESLint.ParserOptions;
 
diff --git a/packages/typescript-estree/package.json b/packages/typescript-estree/package.json
@@ -40,6 +40,7 @@
   },
   "dependencies": {
     "debug": "^4.1.1",
+    "eslint-visitor-keys": "^1.1.0",
     "glob": "^7.1.4",
     "is-glob": "^4.0.1",
     "lodash.unescape": "4.0.1",
diff --git a/packages/typescript-estree/src/ast-converter.ts b/packages/typescript-estree/src/ast-converter.ts
@@ -4,6 +4,7 @@ import { convertComments } from './convert-comments';
 import { convertTokens } from './node-utils';
 import { Extra } from './parser-options';
 import { TSESTree } from './ts-estree';
+import { simpleTraverse } from './simple-traverse';
 
 export function astConverter(
   ast: SourceFile,
@@ -32,6 +33,22 @@ export function astConverter(
 
   const estree = instance.convertProgram();
 
+  /**
+   * Optionally remove range and loc if specified
+   */
+  if (extra.range || extra.loc) {
+    simpleTraverse(estree, {
+      enter: node => {
+        if (!extra.range) {
+          delete node.range;
+        }
+        if (!extra.loc) {
+          delete node.loc;
+        }
+      },
+    });
+  }
+
   /**
    * Optionally convert and include all tokens in the AST
    */
diff --git a/packages/typescript-estree/src/parser.ts b/packages/typescript-estree/src/parser.ts
@@ -419,5 +419,7 @@ export {
   TSESTreeOptions,
   version,
 };
+export { simpleTraverse } from './simple-traverse';
+export { visitorKeys } from './visitor-keys';
 export * from './ts-estree';
 export { clearCaches } from './create-program/createWatchProgram';
diff --git a/packages/typescript-estree/src/simple-traverse.ts b/packages/typescript-estree/src/simple-traverse.ts
@@ -1,4 +1,4 @@
-import { TSESTree } from '@typescript-eslint/typescript-estree';
+import { TSESTree } from './ts-estree';
 import { visitorKeys } from './visitor-keys';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
diff --git a/packages/typescript-estree/src/visitor-keys.ts b/packages/typescript-estree/src/visitor-keys.ts
diff --git a/packages/typescript-estree/tests/lib/__snapshots__/parse.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/parse.ts.snap
@@ -1,5 +1,127 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`parse() general output should not contain loc 1`] = `
+Object {
+  "body": Array [
+    Object {
+      "declarations": Array [
+        Object {
+          "id": Object {
+            "name": "foo",
+            "range": Array [
+              4,
+              7,
+            ],
+            "type": "Identifier",
+          },
+          "init": Object {
+            "name": "bar",
+            "range": Array [
+              10,
+              13,
+            ],
+            "type": "Identifier",
+          },
+          "range": Array [
+            4,
+            13,
+          ],
+          "type": "VariableDeclarator",
+        },
+      ],
+      "kind": "let",
+      "range": Array [
+        0,
+        14,
+      ],
+      "type": "VariableDeclaration",
+    },
+  ],
+  "range": Array [
+    0,
+    14,
+  ],
+  "sourceType": "script",
+  "type": "Program",
+}
+`;
+
+exports[`parse() general output should not contain range 1`] = `
+Object {
+  "body": Array [
+    Object {
+      "declarations": Array [
+        Object {
+          "id": Object {
+            "loc": Object {
+              "end": Object {
+                "column": 7,
+                "line": 1,
+              },
+              "start": Object {
+                "column": 4,
+                "line": 1,
+              },
+            },
+            "name": "foo",
+            "type": "Identifier",
+          },
+          "init": Object {
+            "loc": Object {
+              "end": Object {
+                "column": 13,
+                "line": 1,
+              },
+              "start": Object {
+                "column": 10,
+                "line": 1,
+              },
+            },
+            "name": "bar",
+            "type": "Identifier",
+          },
+          "loc": Object {
+            "end": Object {
+              "column": 13,
+              "line": 1,
+            },
+            "start": Object {
+              "column": 4,
+              "line": 1,
+            },
+          },
+          "type": "VariableDeclarator",
+        },
+      ],
+      "kind": "let",
+      "loc": Object {
+        "end": Object {
+          "column": 14,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 0,
+          "line": 1,
+        },
+      },
+      "type": "VariableDeclaration",
+    },
+  ],
+  "loc": Object {
+    "end": Object {
+      "column": 14,
+      "line": 1,
+    },
+    "start": Object {
+      "column": 0,
+      "line": 1,
+    },
+  },
+  "sourceType": "script",
+  "type": "Program",
+}
+`;
+
 exports[`parse() general output tokens, comments, locs, and ranges when called with those options 1`] = `
 Object {
   "body": Array [
diff --git a/packages/typescript-estree/tests/lib/parse.ts b/packages/typescript-estree/tests/lib/parse.ts
@@ -37,6 +37,22 @@ describe('parse()', () => {
       'output tokens, comments, locs, and ranges when called with those options',
       createSnapshotTestBlock(code, config),
     );
+
+    it(
+      'output should not contain loc',
+      createSnapshotTestBlock(code, {
+        range: true,
+        loc: false,
+      }),
+    );
+
+    it(
+      'output should not contain range',
+      createSnapshotTestBlock(code, {
+        range: false,
+        loc: true,
+      }),
+    );
   });
 
   describe('non string code', () => {
diff --git a/packages/typescript-estree/tests/lib/visitor-keys.ts b/packages/typescript-estree/tests/lib/visitor-keys.ts
@@ -1,4 +1,4 @@
-import { AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';
+import { AST_NODE_TYPES } from '../../src/ts-estree';
 import { visitorKeys } from '../../src/visitor-keys';
 
 //------------------------------------------------------------------------------

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { TSESTree } from '@typescript-eslint/typescript-estree';`
	`1`	`+import { TSESTree } from './ts-estree';`
`2`	`2`	`import { visitorKeys } from './visitor-keys';`
`3`	`3`
`4`	`4`	`// eslint-disable-next-line @typescript-eslint/no-explicit-any`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { AST_NODE_TYPES } from '@typescript-eslint/typescript-estree';`
	`1`	`+import { AST_NODE_TYPES } from '../../src/ts-estree';`
`2`	`2`	`import { visitorKeys } from '../../src/visitor-keys';`
`3`	`3`
`4`	`4`	`//------------------------------------------------------------------------------`