Fix: remove extra leading comments at node level (fixes #264)

lib/comment-attachment.js

@@ -20,43 +20,10 @@ var astNodeTypes = require("./ast-node-types");
 var extra = {
     trailingComments: [],
     leadingComments: [],
-    bottomRightStack: []
+    bottomRightStack: [],
+    previousNode: null
 };
 
-/** Recursively remove leading comments that are incorrectly added when no
- * expression exists between comment and the current node
- * @param {node} node to recursively check
- * @returns {void}
- */
-function removeExtraLeadingComments(node) {
-    var i, j;
-
-    if (!node.body) {
-        return;
-    }
-
-    if (Array.isArray(node.body)) {
-        // i must start at 0 so that we can check all indices recursively
-        for (i = 0; i < node.body.length; i++) {
-            // i must be greater than 0 to perform the check on the previous node
-            if (i > 0 && node.body[i].leadingComments) {
-                for (j = 0; j < node.body[i].leadingComments.length; j++) {
-                    if (node.body[i].leadingComments[j].range[1] < node.body[i - 1].range[1]) {
-                        node.body[i].leadingComments.splice(j, 1);
-                    }
-                }
-
-                if (node.body[i].leadingComments.length === 0) {
-                    delete node.body[i].leadingComments;
-                }
-            }
-            removeExtraLeadingComments(node.body[i]);
-        }
-    } else {
-        removeExtraLeadingComments(node.body);
-    }
-}
-
 //------------------------------------------------------------------------------
 // Public
 //------------------------------------------------------------------------------
@@ -67,6 +34,7 @@ module.exports = {
         extra.trailingComments = [];
         extra.leadingComments = [];
         extra.bottomRightStack = [];
+        extra.previousNode = null;
     },
 
     addComment: function(comment) {
@@ -77,11 +45,10 @@ module.exports = {
     processComment: function(node) {
         var lastChild,
             trailingComments,
-            i;
+            i,
+            j;
 
         if (node.type === astNodeTypes.Program) {
-            removeExtraLeadingComments(node);
-
             if (node.body.length > 0) {
                 return;
             }
@@ -142,10 +109,19 @@ module.exports = {
                 }
             }
         } else if (extra.leadingComments.length > 0) {
-
             if (extra.leadingComments[extra.leadingComments.length - 1].range[1] <= node.range[0]) {
-                node.leadingComments = extra.leadingComments;
-                extra.leadingComments = [];
+                if (extra.previousNode) {
+                    for (j = 0; j < extra.leadingComments.length; j++) {
+                        if (extra.leadingComments[j].end < extra.previousNode.end) {
+                            extra.leadingComments.splice(j, 1);
+                            j--;
+                        }
+                    }
+                }
+                if (extra.leadingComments.length > 0) {
+                    node.leadingComments = extra.leadingComments;
+                    extra.leadingComments = [];
+                }
             } else {
 
                 // https://github.com/eslint/espree/issues/2
@@ -189,6 +165,8 @@ module.exports = {
             }
         }
 
+        extra.previousNode = node;
+
         if (trailingComments) {
             node.trailingComments = trailingComments;
         }

tests/fixtures/attach-comments/mix-line-and-block-comments.result.js

@@ -105,24 +105,6 @@ module.exports = {
                         "value": 777,
                         "raw": "777",
                         "leadingComments": [
-                            {
-                                "type": "Line",
-                                "value": "foo",
-                                "range": [
-                                    0,
-                                    5
-                                ],
-                                "loc": {
-                                    "start": {
-                                        "line": 1,
-                                        "column": 0
-                                    },
-                                    "end": {
-                                        "line": 1,
-                                        "column": 5
-                                    }
-                                }
-                            },
                             {
                                 "type": "Block",
                                 "value": "aaa",
@@ -337,4 +319,4 @@ module.exports = {
             ]
         }
     ]
-};
+};

tests/fixtures/attach-comments/switch-no-default-comment-in-nested-functions.result.js

@@ -649,27 +649,7 @@ module.exports = {
                                                 ],
                                                 "value": false,
                                                 "raw": "false"
-                                            },
-                                            "leadingComments": [
-                                                {
-                                                    "type": "Line",
-                                                    "value": " no default",
-                                                    "range": [
-                                                        232,
-                                                        245
-                                                    ],
-                                                    "loc": {
-                                                        "start": {
-                                                            "line": 7,
-                                                            "column": 12
-                                                        },
-                                                        "end": {
-                                                            "line": 7,
-                                                            "column": 25
-                                                        }
-                                                    }
-                                                }
-                                            ]
+                                            }
                                         }
                                     ]
                                 }
@@ -1585,4 +1565,4 @@ module.exports = {
             ]
         }
     ]
-};
+};