Change: Switch :after to :exit (fixes #605)

eslint · Feb 12, 2014 · f1f453d · f1f453d
1 parent 085cdde
commit f1f453d
Show file tree

Hide file tree

Showing 14 changed files with 54 additions and 37 deletions.
diff --git a/docs/developer-guide/working-with-rules.md b/docs/developer-guide/working-with-rules.md
@@ -41,6 +41,23 @@ module.exports = function(context) {
 
 Each method that matches a node in the AST will be passed the corresponding node. You can then evaluate the node and it's surrounding tree to determine whether or not an issue needs reporting.
 
+By default, the method matching a node name is called during the traversal when the node is first encountered, on the way down the AST. You can also specify to visit the node on the other side of the traversal, as it comes back up the tree, but adding `:exit` to the end of the node type, such as:
+
+```js
+module.exports = function(context) {
+
+    return {
+
+        "Identifier:exit": function(node) {
+            // do something with node
+        }
+    };
+
+};
+```
+
+In this code, `"Identifier:exit"` is called on the way up the AST. This capability allows you to keep track as the traversal enters and exits specific parts of the AST.
+
 The main method you'll use is `context.report()`, which publishes a warning or error (depending on the configuration being used). This method accepts three arguments: the AST node that caused the report, a message to display, and an optional object literal which is used to interpolate. For example:
 
     context.report(node, "This is unexpected!");

diff --git a/lib/eslint.js b/lib/eslint.js
@@ -370,15 +370,15 @@ module.exports = (function() {
 
                     if (trailingComments) {
                         trailingComments.forEach(function(node) {
-                            api.emit(node.type + "Comment:after", node);
+                            api.emit(node.type + "Comment:exit", node);
                         });
                     }
 
-                    api.emit(node.type + ":after", node);
+                    api.emit(node.type + ":exit", node);
 
                     if (leadingComments) {
                         leadingComments.forEach(function(node) {
-                            api.emit(node.type + "Comment:after", node);
+                            api.emit(node.type + "Comment:exit", node);
                         });
                     }
                 }

diff --git a/lib/rules/block-scoped-var.js b/lib/rules/block-scoped-var.js
@@ -85,7 +85,7 @@ module.exports = function(context) {
 
     return {
         "BlockStatement": pushBlock,
-        "BlockStatement:after": popBlock,
+        "BlockStatement:exit": popBlock,
         "CatchClause": addCommonDeclaration,
         "VariableDeclaration": addCommonDeclaration,
         "FunctionDeclaration": addCommonDeclaration,

diff --git a/lib/rules/complexity.js b/lib/rules/complexity.js
@@ -64,8 +64,8 @@ module.exports = function(context) {
     return {
         "FunctionDeclaration": startFunction,
         "FunctionExpression": startFunction,
-        "FunctionDeclaration:after": endFunction,
-        "FunctionExpression:after": endFunction,
+        "FunctionDeclaration:exit": endFunction,
+        "FunctionExpression:exit": endFunction,
 
         "CatchClause": increaseComplexity,
         "ConditionalExpression": increaseComplexity,

diff --git a/lib/rules/consistent-return.js b/lib/rules/consistent-return.js
@@ -33,8 +33,8 @@ module.exports = function(context) {
 
         "FunctionDeclaration": enterFunction,
         "FunctionExpression": enterFunction,
-        "FunctionDeclaration:after": exitFunction,
-        "FunctionExpression:after": exitFunction,
+        "FunctionDeclaration:exit": exitFunction,
+        "FunctionExpression:exit": exitFunction,
 
         "ReturnStatement": function(node) {
 

diff --git a/lib/rules/max-depth.js b/lib/rules/max-depth.js
@@ -57,18 +57,18 @@ module.exports = function(context) {
         "ForStatement": pushBlock,
         "ForInStatement": pushBlock,
 
-        "IfStatement:after": popBlock,
-        "SwitchStatement:after": popBlock,
-        "TryStatement:after": popBlock,
-        "DoWhileStatement:after": popBlock,
-        "WhileStatement:after": popBlock,
-        "WithStatement:after": popBlock,
-        "ForStatement:after": popBlock,
-        "ForInStatement:after": popBlock,
-
-        "FunctionDeclaration:after": endFunction,
-        "FunctionExpression:after": endFunction,
-        "Program:after": endFunction
+        "IfStatement:exit": popBlock,
+        "SwitchStatement:exit": popBlock,
+        "TryStatement:exit": popBlock,
+        "DoWhileStatement:exit": popBlock,
+        "WhileStatement:exit": popBlock,
+        "WithStatement:exit": popBlock,
+        "ForStatement:exit": popBlock,
+        "ForInStatement:exit": popBlock,
+
+        "FunctionDeclaration:exit": endFunction,
+        "FunctionExpression:exit": endFunction,
+        "Program:exit": endFunction
     };
 
 };
diff --git a/lib/rules/max-nested-callbacks.js b/lib/rules/max-nested-callbacks.js
@@ -39,10 +39,10 @@ module.exports = function(context) {
         },
 
 
-        "FunctionExpression:after": function() {
+        "FunctionExpression:exit": function() {
             callbackStack.pop();
         }
 
     };
 
-};
+};
diff --git a/lib/rules/max-statements.js b/lib/rules/max-statements.js
@@ -45,8 +45,8 @@ module.exports = function(context) {
 
         "BlockStatement": countStatements,
 
-        "FunctionDeclaration:after": endFunction,
-        "FunctionExpression:after": endFunction
+        "FunctionDeclaration:exit": endFunction,
+        "FunctionExpression:exit": endFunction
     };
 
 };
diff --git a/lib/rules/no-ex-assign.js b/lib/rules/no-ex-assign.js
@@ -21,7 +21,7 @@ module.exports = function(context) {
             exceptionName = node.param.name;
         },
 
-        "CatchClause:after": function() {
+        "CatchClause:exit": function() {
             inCatch = false;
             exceptionName = null;
         },

diff --git a/lib/rules/no-fallthrough.js b/lib/rules/no-fallthrough.js
@@ -72,7 +72,7 @@ module.exports = function(context) {
             });
         },
 
-        "SwitchStatement:after": function() {
+        "SwitchStatement:exit": function() {
             switches.pop();
         }
     };

diff --git a/lib/rules/no-unused-vars.js b/lib/rules/no-unused-vars.js
@@ -162,7 +162,7 @@ module.exports = function(context) {
             }
         },
 
-        "Program:after": function() {
+        "Program:exit": function() {
             Object.keys(variables)
                 .forEach(function (name) {
                     variables[name].forEach(function (variable) {

diff --git a/lib/rules/one-var.js b/lib/rules/one-var.js
@@ -44,9 +44,9 @@ module.exports = function(context) {
 
         "VariableDeclaration": checkDeclarations,
 
-        "Program:after": endFunction,
-        "FunctionDeclaration:after": endFunction,
-        "FunctionExpression:after": endFunction
+        "Program:exit": endFunction,
+        "FunctionDeclaration:exit": endFunction,
+        "FunctionExpression:exit": endFunction
     };
 
 };
diff --git a/lib/rules/strict.js b/lib/rules/strict.js
@@ -43,9 +43,9 @@ module.exports = function(context) {
         "FunctionDeclaration": enterScope,
         "FunctionExpression": enterScope,
 
-        "Program:after": exitScope,
-        "FunctionDeclaration:after": exitScope,
-        "FunctionExpression:after": exitScope,
+        "Program:exit": exitScope,
+        "FunctionDeclaration:exit": exitScope,
+        "FunctionExpression:exit": exitScope,
 
         "ExpressionStatement": function(node) {
 

diff --git a/tests/lib/eslint.js b/tests/lib/eslint.js
@@ -529,7 +529,7 @@ describe("eslint", function() {
             assert(spy.calledOnce, "Handler should be called.");
         });
 
-        it("should fire LineComment and LineComment:after events", function() {
+        it("should fire LineComment and LineComment:exit events", function() {
 
             function handler(node) {
                 var code = eslint.getSource(node);
@@ -542,7 +542,7 @@ describe("eslint", function() {
 
             eslint.reset();
             eslint.on("LineComment", spy);
-            eslint.on("LineComment:after", spy);
+            eslint.on("LineComment:exit", spy);
 
             eslint.verify(code, config, true);
             assert(spy.calledTwice, "Handler should be called.");
@@ -566,7 +566,7 @@ describe("eslint", function() {
             assert(spy.calledOnce, "Handler should be called.");
         });
 
-        it("should fire BlockComment:after event", function() {
+        it("should fire BlockComment:exit event", function() {
 
             function handler(node) {
                 var code = eslint.getSource(node);
@@ -579,7 +579,7 @@ describe("eslint", function() {
 
             eslint.reset();
             eslint.on("BlockComment", spy);
-            eslint.on("BlockComment:after", spy);
+            eslint.on("BlockComment:exit", spy);
 
             eslint.verify(code, config, true);
             assert(spy.calledTwice, "Handler should be called.");