[linter] Issue 295. Skip comment tokens with GitHub code blocks (in ```).

pkg/analyzer/lib/src/generated/parser.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library analyzer.src.generated.parser;
 
 import 'dart:collection';
 import "dart:math" as math;
 
 import 'package:analyzer/dart/ast/ast.dart';
@@ skipping 5160 matching lines @@
    *
    *     commentReference ::=
    *         '[' 'new'? qualified ']' libraryReference?
    *
    *     libraryReference ::=
    *          '(' stringLiteral ')'
    */
   List<CommentReference> _parseCommentReferences(
       List<DocumentationCommentToken> tokens) {
     List<CommentReference> references = <CommentReference>[];
+    bool isInGitHubCodeBlock = false;
     for (DocumentationCommentToken token in tokens) {
       String comment = token.lexeme;
-      comment = _removeCodeBlocksGitHub(comment);
+      // Skip GitHub code blocks.
+      // https://help.github.com/articles/creating-and-highlighting-code-blocks/
+      if (tokens.length != 1) {
+        if (comment.indexOf('```') != -1) {

[Brian Wilkerson, 2016/09/01 21:06:58]

Do we care about the case where the tripled-quote is not the first thing on the
line?

[scheglov, 2016/09/01 21:14:22]

It seems even less used case for me.
So, no, not now.

+          isInGitHubCodeBlock = !isInGitHubCodeBlock;
+        }
+        if (isInGitHubCodeBlock) {
+          continue;
+        }
+      }
+      // Remove GitHub include code.
+      comment = _removeGitHubInlineCode(comment);
+      // Find references.
       int length = comment.length;
       List<List<int>> codeBlockRanges = _getCodeBlockRanges(comment);
       int leftIndex = comment.indexOf('[');
       while (leftIndex >= 0 && leftIndex + 1 < length) {
         List<int> range = _findRange(codeBlockRanges, leftIndex);
         if (range == null) {
           int nameOffset = token.offset + leftIndex + 1;
           int rightIndex = JavaString.indexOf(comment, ']', leftIndex);
           if (rightIndex >= 0) {
             int firstChar = comment.codeUnitAt(leftIndex + 1);
@@ skipping 3682 matching lines @@
    * is the current token, `1` is the next token, etc.
    */
   Token _peekAt(int distance) {
     Token token = _currentToken;
     for (int i = 0; i < distance; i++) {
       token = token.next;
     }
     return token;
   }
 
-  String _removeCodeBlocksGitHub(String comment) {
+  String _removeGitHubInlineCode(String comment) {
     int index = 0;
     while (true) {
       int beginIndex = comment.indexOf('`', index);
       if (beginIndex == -1) {
         break;
       }
       int endIndex = comment.indexOf('`', beginIndex + 1);
       if (endIndex == -1) {
         break;
       }
@@ skipping 1633 matching lines @@
    */
   const ParserErrorCode(String name, String message, [String correction])
       : super(name, message, correction);
 
   @override
   ErrorSeverity get errorSeverity => ErrorSeverity.ERROR;
 
   @override
   ErrorType get type => ErrorType.SYNTACTIC_ERROR;
 }