Breaking: remove attachComment (#405)

* Turn off comment attachment for lib tests * Remove attachComment * Update readme
eslint · Dec 5, 2018 · 1bcd563 · 1bcd563
1 parent 35623ee
commit 1bcd563
Show file tree

Hide file tree

Showing 54 changed files with 23 additions and 8,660 deletions.
diff --git a/README.md b/README.md
@@ -12,24 +12,24 @@ Espree started out as a fork of [Esprima](http://esprima.org) v1.2.2, the last s
 Install:
 
 ```
-npm i espree --save
+npm i espree
 ```
 
 And in your Node.js code:
 
 ```javascript
-var espree = require("espree");
+const espree = require("espree");
 
-var ast = espree.parse(code);
+const ast = espree.parse(code);
 ```
 
 There is a second argument to `parse()` that allows you to specify various options:
 
 ```javascript
-var espree = require("espree");
+const espree = require("espree");
 
 // Optional second options argument with the following default settings
-var ast = espree.parse(code, {
+const ast = espree.parse(code, {
 
     // attach range information to each node
     range: false,
@@ -40,9 +40,6 @@ var ast = espree.parse(code, {
     // create a top-level comments array containing all comments
     comment: false,
 
-    // attach comments to the closest relevant node as leadingComments and trailingComments
-    attachComment: false,
-
     // create a top-level tokens array containing all tokens
     tokens: false,
 

diff --git a/lib/comment-attachment.js b/lib/comment-attachment.js
diff --git a/lib/espree.js b/lib/espree.js
@@ -3,7 +3,6 @@
 /* eslint-disable no-param-reassign*/
 const acorn = require("acorn");
 const jsx = require("acorn-jsx");
-const commentAttachment = require("./comment-attachment");
 const TokenTranslator = require("./token-translator");
 
 const DEFAULT_ECMA_VERSION = 5;
@@ -98,7 +97,7 @@ module.exports = () => Parser => class Espree extends Parser {
         super({
             ecmaVersion: isModule ? Math.max(6, ecmaVersion) : ecmaVersion,
             sourceType: isModule ? "module" : "script",
-            ranges: options.range === true || options.attachComment === true,
+            ranges: options.range === true,
             locations: options.loc === true,
 
             // Truthy value is true for backward compatibility.
@@ -122,22 +121,14 @@ module.exports = () => Parser => class Espree extends Parser {
                     const comment = convertAcornCommentToEsprimaComment(block, text, start, end, startLoc, endLoc);
 
                     this[STATE].comments.push(comment);
-
-                    if (options.attachComment === true) {
-                        commentAttachment.addComment(comment);
-                    }
                 }
             }
         }, code);
 
-        // TODO: remove global state.
-        commentAttachment.reset();
-
         // Initialize internal state.
         this[STATE] = {
             tokens: tokenTranslator ? [] : null,
-            comments: options.comment === true || options.attachComment === true ? [] : null,
-            attachComment: options.attachComment === true,
+            comments: options.comment === true ? [] : null,
             impliedStrict: ecmaFeatures.impliedStrict === true && this.options.ecmaVersion >= 5,
             ecmaVersion: this.options.ecmaVersion,
             jsxAttrValueToken: false,
@@ -309,10 +300,6 @@ module.exports = () => Parser => class Espree extends Parser {
             }
         }
 
-        if (this[STATE].attachComment) {
-            commentAttachment.processComment(result);
-        }
-
         if (result.type.indexOf("Function") > -1 && !result.generator) {
             result.generator = false;
         }