Move the check to find jsdoc in block comments (starting with /* rath…

…er than /**) into the linter.

Due to the current code design, errors / warnings reported in RhinoErrorReporter cannot be suppressed. For the sake of tsickle generated code and / or third party code, we don't want to report this error. Moving it to the linter seems appropriate.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=220483845

src/com/google/javascript/jscomp/CheckJSDoc.java

@@ -20,11 +20,13 @@
 
 import com.google.common.collect.Iterables;
 import com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback;
+import com.google.javascript.jscomp.parsing.parser.trees.Comment;
 import com.google.javascript.rhino.JSDocInfo;
 import com.google.javascript.rhino.JSTypeExpression;
 import com.google.javascript.rhino.Node;
 import com.google.javascript.rhino.Token;
 import java.util.Set;
+import java.util.regex.Pattern;
 import javax.annotation.Nullable;
 
 /**
@@ -80,6 +82,14 @@ final class CheckJSDoc extends AbstractPostOrderCallback implements HotSwapCompi
           "@suppress annotation not allowed here. See"
               + " https://github.com/google/closure-compiler/wiki/@suppress-annotations");
 
+  public static final DiagnosticType JSDOC_IN_BLOCK_COMMENT =
+      DiagnosticType.warning(
+          "JSC_JSDOC_IN_BLOCK_COMMENT",
+          "Non-JSDoc comment has annotations. Did you mean to start it with '/**'?");
+
+  private static final Pattern COMMENT_PATTERN =
+      Pattern.compile("(/|(\n[ \t]*))\\*[ \t]*@[a-zA-Z]+[ \t\n{]");
+
   private final AbstractCompiler compiler;
   private boolean inExterns;
 
@@ -100,8 +110,35 @@ public void hotSwapScript(Node scriptRoot, Node originalRoot) {
     NodeTraversal.traverse(compiler, scriptRoot, this);
   }
 
+  /**
+   * Checks for block comments (e.g. starting with /*) that look like they are JsDoc, and thus
+   * should start with /**.
+   */
+  private void checkJsDocInBlockComments(String fileName) {
+    if (!compiler.getOptions().preservesDetailedSourceInfo()) {
+      // Comments only available if preservesDetailedSourceInfo is true.
+      return;
+    }
+
+    for (Comment comment : compiler.getComments(fileName)) {
+      if (comment.type == Comment.Type.BLOCK) {
+        if (COMMENT_PATTERN.matcher(comment.value).find()) {
+          compiler.report(
+              JSError.make(
+                  fileName,
+                  comment.location.start.line + 1,
+                  comment.location.start.column,
+                  JSDOC_IN_BLOCK_COMMENT));
+        }
+      }
+    }
+  }
+
   @Override
   public void visit(NodeTraversal t, Node n, Node parent) {
+    if (n.isScript()) {
+      checkJsDocInBlockComments(n.getSourceFileName());
+    }
     JSDocInfo info = n.getJSDocInfo();
     validateTypeAnnotations(n, info);
     validateFunctionJsDoc(n, info);

src/com/google/javascript/jscomp/DiagnosticGroups.java

@@ -204,10 +204,11 @@ public DiagnosticGroup forName(String name) {
       DiagnosticGroups.registerGroup("accessControls", VISIBILITY);
 
   public static final DiagnosticGroup NON_STANDARD_JSDOC =
-      DiagnosticGroups.registerGroup("nonStandardJsDocs",
+      DiagnosticGroups.registerGroup(
+          "nonStandardJsDocs",
           RhinoErrorReporter.BAD_JSDOC_ANNOTATION,
           RhinoErrorReporter.INVALID_PARAM,
-          RhinoErrorReporter.JSDOC_IN_BLOCK_COMMENT);
+          CheckJSDoc.JSDOC_IN_BLOCK_COMMENT);
 
   public static final DiagnosticGroup INVALID_CASTS =
       DiagnosticGroups.registerGroup("invalidCasts",

src/com/google/javascript/jscomp/Linter.java

@@ -21,6 +21,7 @@
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.javascript.jscomp.CompilerOptions.LanguageMode;
+import com.google.javascript.jscomp.parsing.Config.JsDocParsing;
 import com.google.javascript.refactoring.ApplySuggestedFixes;
 import com.google.javascript.refactoring.FixingErrorManager;
 import com.google.javascript.refactoring.SuggestedFix;
@@ -50,6 +51,8 @@ static void lint(Path path, Compiler compiler) throws IOException {
     SourceFile file = SourceFile.fromFile(path.toString());
     CompilerOptions options = new CompilerOptions();
     options.setLanguage(LanguageMode.ECMASCRIPT_NEXT);
+    options.setParseJsDocDocumentation(JsDocParsing.INCLUDE_DESCRIPTIONS_WITH_WHITESPACE);
+    options.setPreserveDetailedSourceInfo(true);
 
     // These are necessary to make sure that suggested fixes are printed correctly.
     options.setPrettyPrint(true);

src/com/google/javascript/jscomp/RhinoErrorReporter.java

@@ -72,9 +72,6 @@ class RhinoErrorReporter {
   static final DiagnosticType BAD_JSDOC_ANNOTATION =
       DiagnosticType.warning("JSC_BAD_JSDOC_ANNOTATION", "Parse error. {0}");
 
-  static final DiagnosticType JSDOC_IN_BLOCK_COMMENT =
-      DiagnosticType.warning("JSC_JSDOC_IN_BLOCK_COMMENT", "Parse error. {0}");
-
   static final DiagnosticType INVALID_ES3_PROP_NAME = DiagnosticType.warning(
       "JSC_INVALID_ES3_PROP_NAME",
       "Keywords and reserved words are not allowed as unquoted property " +
@@ -141,12 +138,6 @@ private RhinoErrorReporter(AbstractCompiler compiler) {
                 replacePlaceHolders(SimpleErrorReporter.getMessage0("msg.bad.jsdoc.tag")),
                 BAD_JSDOC_ANNOTATION)
 
-            .put(
-                Pattern.compile("^" + Pattern.quote(
-                    "Non-JSDoc comment has annotations. "
-                        + "Did you mean to start it with '/**'?")),
-                JSDOC_IN_BLOCK_COMMENT)
-
             .put(
                 Pattern.compile(
                     "^Keywords and reserved words are not allowed as unquoted property.*"),

src/com/google/javascript/jscomp/parsing/IRFactory.java

@@ -162,7 +162,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
-import java.util.regex.Pattern;
 import javax.annotation.Nullable;
 
 /**
@@ -180,10 +179,6 @@ class IRFactory {
       "If you are targeting newer versions of JavaScript, " +
       "set the appropriate language_in option.";
 
-  static final String SUSPICIOUS_COMMENT_WARNING =
-      "Non-JSDoc comment has annotations. " +
-      "Did you mean to start it with '/**'?";
-
   static final String INVALID_ES3_PROP_NAME =
       "Keywords and reserved words are not allowed as unquoted property " +
       "names in older versions of JavaScript. " +
@@ -244,9 +239,6 @@ class IRFactory {
           "implements", "interface", "let", "package", "private", "protected",
           "public", "static", "yield");
 
-  private static final Pattern COMMENT_PATTERN =
-      Pattern.compile("(/|(\n[ \t]*))\\*[ \t]*@[a-zA-Z]+[ \t\n{]");
-
   /**
    * If non-null, use this set of keywords instead of TokenStream.isKeyword().
    */
@@ -341,8 +333,6 @@ public static IRFactory transformTree(ProgramTree tree,
         if ((comment.type == Comment.Type.JSDOC || comment.type == Comment.Type.IMPORTANT)
             && !irFactory.parsedComments.contains(comment)) {
           irFactory.handlePossibleFileOverviewJsDoc(comment);
-        } else if (comment.type == Comment.Type.BLOCK) {
-          irFactory.handleBlockComment(comment);
         }
       }
     }
@@ -606,19 +596,6 @@ Node transformBlock(ParseTree node) {
     return irNode;
   }
 
-  /**
-   * Check to see if the given block comment looks like it should be JSDoc.
-   */
-  private void handleBlockComment(Comment comment) {
-    if (COMMENT_PATTERN.matcher(comment.value).find()) {
-      errorReporter.warning(
-          SUSPICIOUS_COMMENT_WARNING,
-          sourceName,
-          lineno(comment.location.start),
-          charno(comment.location.start));
-    }
-  }
-
   /**
    * @return true if the jsDocParser represents a fileoverview.
    */

test/com/google/javascript/jscomp/CheckJsDocTest.java

@@ -23,11 +23,13 @@
 import static com.google.javascript.jscomp.CheckJSDoc.INVALID_DEFINE_ON_LET;
 import static com.google.javascript.jscomp.CheckJSDoc.INVALID_MODIFIES_ANNOTATION;
 import static com.google.javascript.jscomp.CheckJSDoc.INVALID_NO_SIDE_EFFECT_ANNOTATION;
+import static com.google.javascript.jscomp.CheckJSDoc.JSDOC_IN_BLOCK_COMMENT;
 import static com.google.javascript.jscomp.CheckJSDoc.MISPLACED_ANNOTATION;
 import static com.google.javascript.jscomp.CheckJSDoc.MISPLACED_MSG_ANNOTATION;
 import static com.google.javascript.jscomp.CheckJSDoc.MISPLACED_SUPPRESS;
 
 import com.google.javascript.jscomp.CompilerOptions.LanguageMode;
+import com.google.javascript.jscomp.parsing.Config.JsDocParsing;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -57,6 +59,8 @@ public void setUp() throws Exception {
   protected CompilerOptions getOptions() {
     CompilerOptions options = super.getOptions();
     options.setWarningLevel(DiagnosticGroups.MISPLACED_SUPPRESS, CheckLevel.WARNING);
+    options.setParseJsDocDocumentation(JsDocParsing.INCLUDE_DESCRIPTIONS_WITH_WHITESPACE);
+    options.setPreserveDetailedSourceInfo(true);
     return options;
   }
 
@@ -983,4 +987,17 @@ public void testImplicitCastOnlyAllowedInExterns() {
             "Element.prototype.innerHTML;"),
         TypeCheck.ILLEGAL_IMPLICIT_CAST);
   }
+
+  @Test
+  public void testJsDocInBlockComments() {
+    testSame("/** @type {X} */ let x;");
+    testSame("// @type {X}\nlet x;");
+
+    testWarning("/* @type {X} */ let x;", JSDOC_IN_BLOCK_COMMENT);
+
+    // jsdoc tags contain letters only, no underscores etc.
+    testSame("/* @cc_on */ var x = 3;");
+    // a jsdoc tag can't be immediately followed by a paren
+    testSame("/* @TODO(username) */ var x = 3;");
+  }
 }

test/com/google/javascript/jscomp/parsing/ParserTest.java

@@ -50,9 +50,6 @@
 
 @RunWith(JUnit4.class)
 public final class ParserTest extends BaseJSTypeTestCase {
-  private static final String SUSPICIOUS_COMMENT_WARNING =
-      IRFactory.SUSPICIOUS_COMMENT_WARNING;
-
   private static final String TRAILING_COMMA_MESSAGE =
       "Trailing comma is not legal in an ECMA-262 object initializer";
 
@@ -1905,61 +1902,6 @@ public void testTrailingCommaWarning7() {
         "'}' expected");
   }
 
-  @Test
-  public void testSuspiciousBlockCommentWarning1() {
-    parseWarning("/* @type {number} */ var x = 3;", SUSPICIOUS_COMMENT_WARNING);
-  }
-
-  @Test
-  public void testSuspiciousBlockCommentWarning2() {
-    parseWarning("/* \n * @type {number} */ var x = 3;",
-        SUSPICIOUS_COMMENT_WARNING);
-  }
-
-  @Test
-  public void testSuspiciousBlockCommentWarning3() {
-    parseWarning("/* \n *@type {number} */ var x = 3;",
-        SUSPICIOUS_COMMENT_WARNING);
-  }
-
-  @Test
-  public void testSuspiciousBlockCommentWarning4() {
-    parseWarning(
-        "  /*\n" +
-        "   * @type {number}\n" +
-        "   */\n" +
-        "  var x = 3;",
-        SUSPICIOUS_COMMENT_WARNING);
-  }
-
-  @Test
-  public void testSuspiciousBlockCommentWarning5() {
-    parseWarning(
-        "  /*\n" +
-        "   * some random text here\n" +
-        "   * @type {number}\n" +
-        "   */\n" +
-        "  var x = 3;",
-        SUSPICIOUS_COMMENT_WARNING);
-  }
-
-  @Test
-  public void testSuspiciousBlockCommentWarning6() {
-    parseWarning("/* @type{number} */ var x = 3;", SUSPICIOUS_COMMENT_WARNING);
-  }
-
-  @Test
-  public void testSuspiciousBlockCommentWarning7() {
-    // jsdoc tags contain letters only, no underscores etc.
-    parse("/* @cc_on */ var x = 3;");
-  }
-
-  @Test
-  public void testSuspiciousBlockCommentWarning8() {
-    // a jsdoc tag can't be immediately followed by a paren
-    parse("/* @TODO(username) */ var x = 3;");
-  }
-
   @Test
   public void testCatchClauseForbidden() {
     parseError("try { } catch (e if true) {}",