Merge pull request #686 from DanielXMoore/684

Fix #684: Add support for TypeScript /// directives

source/parser.hera

@@ -6255,8 +6255,8 @@ Shebang
   /#![^\r\n]*/ EOL
 
 CivetPrologue
-  [\t ]* DoubleQuote CivetPrologueContent:content DoubleQuote $SimpleStatementDelimiter EOS? -> content
-  [\t ]* SingleQuote CivetPrologueContent:content SingleQuote $SimpleStatementDelimiter EOS? -> content
+  [\t ]* DoubleQuote CivetPrologueContent:content DoubleQuote SimpleStatementDelimiter EOS? -> content
+  [\t ]* SingleQuote CivetPrologueContent:content SingleQuote SimpleStatementDelimiter EOS? -> content
 
 CivetPrologueContent
   "civet" NonIdContinue CivetOption*:options [\s]* ->
@@ -6290,7 +6290,14 @@ UnknownPrologue
   # Can't use $EOS because it will prevent re-writing of coffee style comments
   [\t ]* StringLiteral:s $SimpleStatementDelimiter EOS
 
+TripleSlashDirective
+  # https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html
+  /\/\/\/[^\r\n]*/ EOS?
+
 DirectivePrologue
+  PrologueString
+
+PrologueString
   CivetPrologue
   UnknownPrologue
 
@@ -6726,7 +6733,7 @@ Reset
     }
 
 Init
-  Shebang? DirectivePrologue*:directives "" ->
+  Shebang? TripleSlashDirective* DirectivePrologue*:directives ->
     directives.forEach((directive) => {
       if (directive.type === "CivetPrologue") {
         Object.assign(module.config, directive.config)

test/prologues.civet

@@ -0,0 +1,21 @@
+{testCase} from ./helper.civet
+
+describe "shebang", ->
+  testCase """
+    keeps it at the top
+    ---
+    #! /usr/bin/env node
+    ---
+    #! /usr/bin/env node
+  """
+
+describe "Triple Slash directives", ->
+  testCase """
+    https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html
+    ---
+    /// <reference path="..." />
+    x = 1
+    ---
+    /// <reference path="..." />
+    x = 1
+  """

test/regex.civet

@@ -76,169 +76,207 @@ describe "regexp", ->
       Math.floor(x / y) // comment
     """
 
+  // NOTE: Need the ';' so that the heregex isn't interperted as a https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html
   describe "heregex", ->
     testCase """
       basic
       ---
+      ;
       ///abc///
       ---
+      ;
       /abc/
     """
 
     testCase """
       flags
       ---
+      ;
       ///abc///g
       ---
+      ;
       /abc/g
     """
 
     testCase """
       escapes
       ---
+      ;
       ///\\u200C///
       ---
+      ;
       /\\u200C/
     """
 
     testCase """
       strips whitespace
       ---
+      ;
       ///  abc  ///
       ---
+      ;
       /abc/
     """
 
     testCase """
       escapes single slashes
       ---
+      ;
       /// / ///
       ---
+      ;
       /\\//
     """
 
     testCase """
       escaped space
       ---
+      ;
       ///\\ ///
       ---
+      ;
       / /
     """
 
     testCase """
       escaped newline
       ---
+      ;
       ///\\\n///
       ---
+      ;
       /\\n/
     """
 
     testCase """
       space in character class
       ---
+      ;
       ///[ ]///
       ---
+      ;
       /[ ]/
     """
 
     testCase """
       comment in character class
       ---
+      ;
       ///[/*]///
       ---
+      ;
       /[/*]/
     """
 
     testCase """
       coffee comment in character class
       ---
+      ;
       ///[ # hey ]///
       ---
+      ;
       /[ # hey ]/
     """
 
     testCase """
       triple slash inside character class
       ---
+      ;
       ///a[///]///
       ---
+      ;
       /a[///]/
     """
 
     testCase """
       JS comment
       ---
+      ;
       ///
         abb // hey
       ///
       ---
+      ;
       /abb/
     """
 
     testCase '''
       substitutions
       ---
+      ;
       ///#{a}///
       ---
+      ;
       RegExp(`${a}`)
     '''
 
     testCase '''
       substitutions escape backticks
       ---
+      ;
       ///
        `#{a}
       ///
       ---
+      ;
       RegExp(`\\`${a}`)
     '''
 
     testCase '''
       allows both kinds of substitutions
       ---
+      ;
       ///
         ${yo}
         $ { x }
         #{a}
       ///
       ---
+      ;
       RegExp(`${yo}\\${x}${a}`)
     '''
 
     testCase '''
       escaped bracket
       ---
+      ;
       ///
         \\[
       ///
       ---
+      ;
       /\\[/
     '''
 
     testCase '''
       escaped bracket with substitution
       ---
+      ;
       ///
         \\[#{a}]
       ///
       ---
+      ;
       RegExp(`\\\\[${a}]`)
     '''
 
     testCase '''
       substitutions keep flags
       ---
+      ;
       ///
         x#{a}
       ///g
       ---
+      ;
       RegExp(`x${a}`, "g")
     '''
 
     // NOTE: Added escapes for '#' to work around https://github.com/jashkenas/coffeescript/issues/5428
     testCase '''
       coffee script's heregex
       ---
+      ;
       /// ^
         (?:
             # Match any character, except those that need special handling below.
@@ -254,5 +292,6 @@ describe "regexp", ->
         )*
       ///
       ---
+      ;
       /^(?:[^\\\\/\\#\\s]|\\\\[\\s\\S]|\\/(?!\\/\\/)|\\#(?!\\{)|\\s+(?:\\#(?!\\{).*)?)*/
     '''