Merge pull request #1503 from ChadKillingsworth/warn-improper-nosidee…

…ffects Add warning when @nosideeffects is used outside of externs. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=114242321
google · Feb 10, 2016 · 0fe75fa · 0fe75fa
1 parent 78f58a0
commit 0fe75fa
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/src/com/google/javascript/jscomp/CheckJSDoc.java b/src/com/google/javascript/jscomp/CheckJSDoc.java
@@ -83,6 +83,7 @@ public void visit(NodeTraversal t, Node n, Node parent) {
     validateArrowFunction(n);
     validateDefaultValue(n, info);
     validateTempates(n, info);
+    validateNoSideEffects(n, info);
   }
 
   private void validateTempates(Node n, JSDocInfo info) {
@@ -365,4 +366,13 @@ private void validateDefaultValue(Node n, JSDocInfo info) {
       }
     }
   }
+
+  /**
+   * Check that @nosideeeffects annotations are only present in externs.
+   */
+  private void validateNoSideEffects(Node n, JSDocInfo info) {
+    if (info != null && info.isNoSideEffects() && !n.isFromExterns()) {
+      reportMisplaced(n, "nosideeffects", "@nosideeffects is only supported in externs.");
+    }
+  }
 }
diff --git a/test/com/google/javascript/jscomp/CheckJsDocTest.java b/test/com/google/javascript/jscomp/CheckJsDocTest.java
@@ -283,4 +283,10 @@ public void testBadTemplate3() {
     testBadTemplate("/** @template T */ var f = function() {};");
     testBadTemplate("/** @template T */ Foo.prototype.f = function() {};");
   }
+
+  public void testNoSideEffectsInSrc() {
+    testSame("/** @nosideeffects */ function foo() {}; foo();", MISPLACED_ANNOTATION);
+
+    testSame("/** @nosideeffects */ function foo() {};", "foo();", null);
+  }
 }