Improve parse for module sources (#177)

Improve parse for module sources
microsoft · Aug 7, 2019 · 21ca4d5 · 21ca4d5
2 parents 9555487 + c4bedf9
commit 21ca4d5
Show file tree

Hide file tree

Showing 4 changed files with 507 additions and 112 deletions.
diff --git a/common/changes/@microsoft/tsdoc/declarationReferenceUpdate3_2019-08-02-22-40.json b/common/changes/@microsoft/tsdoc/declarationReferenceUpdate3_2019-08-02-22-40.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/tsdoc",
+      "comment": "Improve DeclarationReference.parse for module sources",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/tsdoc",
+  "email": "[email protected]"
+}
diff --git a/tsdoc/src/beta/DeclarationReference.grammarkdown b/tsdoc/src/beta/DeclarationReference.grammarkdown
@@ -42,7 +42,7 @@ Punctuator:: one of
   `{` `}` `(` `)` `[` `]` `!` `.` `#` `~` `:` `,`
 
 FutureReservedPunctuator:: one of
-  `{` `}`
+  `{` `}` `@`
 
 NavigationPunctuator: one of
   `.`                                           // Navigate via 'exports' of symbol
@@ -107,6 +107,17 @@ Hex4Digits::
 CodePoint::
   > |HexDigits| but only if MV of |HexDigits| ≤ 0x10FFFF
 
+// Represents the path for a module
+ModuleSource::
+  String
+  ModuleSourceCharacters
+
+ModuleSourceCharacters::
+  ModuleSourceCharacter ModuleSourceCharacters?
+
+ModuleSourceCharacter::
+  SourceCharacter but not one of `"` or `!` or LineTerminator
+
 Component::
   String
   ComponentCharacters
@@ -130,13 +141,9 @@ DeclarationReference:
   SymbolReference                               // Shorthand reference to symbol
   ModuleSource `!`                              // Reference to a module
   ModuleSource `!` SymbolReference              // Reference to an export of a module
-  ModuleSource `|` `~` SymbolReference          // Reference to a local of a module
+  ModuleSource `!` `~` SymbolReference          // Reference to a local of a module
   `!` SymbolReference                           // Reference to global symbol
 
-// Represents the path for a module
-ModuleSource:
-  Component
-
 SymbolReference:
   ComponentPath Meaning?
   Meaning