@microsoft/tsdoc - npm Package Compare versions

Comparing version 0.12.4 to 0.12.5

CHANGELOG.json

@@ -5,2 +5,17 @@ {
     {
+      "version": "0.12.5",
+      "tag": "@microsoft/tsdoc_v0.12.5",
+      "date": "Tue, 29 Jan 2019 22:49:58 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Update parser to allow `$` character in `@param` names, since ECMAScript allows this in unquoted identifiers"
+          },
+          {
+            "comment": "Allow `$` character in declaration reference member identifiers (Example: `{@link Button.$render}`)"
+          }
+        ]
+      }
+    },
+    {
       "version": "0.12.4",
@@ -7,0 +22,0 @@ "tag": "@microsoft/tsdoc_v0.12.4",

CHANGELOG.md

 # Change Log - @microsoft/tsdoc
 
-This log was last generated on Tue, 20 Nov 2018 21:23:06 GMT and should not be manually modified.
+This log was last generated on Tue, 29 Jan 2019 22:49:58 GMT and should not be manually modified.
 
+## 0.12.5
+Tue, 29 Jan 2019 22:49:58 GMT
+
+### Patches
+
+- Update parser to allow `$` character in `@param` names, since ECMAScript allows this in unquoted identifiers
+- Allow `$` character in declaration reference member identifiers (Example: `{@link Button.$render}`)
+
 ## 0.12.4
@@ -6,0 +14,0 @@ Tue, 20 Nov 2018 21:23:06 GMT

lib/parser/StringChecks.d.ts

@@ -9,3 +9,3 @@ /**
     private static readonly _htmlNameRegExp;
-    private static readonly _identifierNotWordCharRegExp;
+    private static readonly _identifierBadCharRegExp;
     private static readonly _identifierNumberStartRegExp;
@@ -12,0 +12,0 @@ private static readonly _validPackageNameRegExp;

lib/parser/StringChecks.js

@@ -115,3 +115,3 @@ "use strict";
         }
-        if (StringChecks._identifierNotWordCharRegExp.test(identifier)) {
+        if (StringChecks._identifierBadCharRegExp.test(identifier)) {
             return 'The identifier cannot non-word characters';
@@ -136,4 +136,12 @@ }
     StringChecks._htmlNameRegExp = /^[a-z]+(\-[a-z]+)*$/i;
-    StringChecks._identifierNotWordCharRegExp = /\W/u;
-    StringChecks._identifierNumberStartRegExp = /^[0-9]/u;
+    // Note: In addition to letters, numbers, underscores, and dollar signs, modern ECMAScript
+    // also allows Unicode categories such as letters, combining marks, digits, and connector punctuation.
+    // These are mostly supported in all environments except IE11, so if someone wants it, we would accept
+    // a PR to allow them (although the test surface might be somewhat large).
+    StringChecks._identifierBadCharRegExp = /[^a-z0-9_$]/i;
+    // Identifiers most not start with a number.
+    StringChecks._identifierNumberStartRegExp = /^[0-9]/;
+    // For detailed notes about NPM package name syntax, see:
+    // tslint:disable-next-line:max-line-length
+    // https://github.com/Microsoft/web-build-tools/blob/a417ca25c63aca31dba43a34d39cc9cd529b9c78/libraries/node-core-library/src/PackageName.ts
     StringChecks._validPackageNameRegExp = /^(?:@[a-z0-9\-_\.]+\/)?[a-z0-9\-_\.]+$/i;
@@ -140,0 +148,0 @@ StringChecks._systemSelectors = new Set([

lib/parser/Token.d.ts

@@ -143,3 +143,8 @@ import { TextRange } from './TextRange';
      */
-    Plus = 2028
+    Plus = 2028,
+    /**
+     * The dollar sign character ("$").
+     * The Token.range will always be a string of length 1.
+     */
+    DollarSign = 2029
 }
@@ -146,0 +151,0 @@ /**

lib/parser/Token.js

@@ -146,2 +146,7 @@ "use strict";
     TokenKind[TokenKind["Plus"] = 2028] = "Plus";
+    /**
+     * The dollar sign character ("$").
+     * The Token.range will always be a string of length 1.
+     */
+    TokenKind[TokenKind["DollarSign"] = 2029] = "DollarSign";
 })(TokenKind = exports.TokenKind || (exports.TokenKind = {}));
@@ -148,0 +153,0 @@ /**

lib/parser/Tokenizer.js

@@ -123,3 +123,4 @@ "use strict";
             '#': Token_1.TokenKind.PoundSymbol,
-            '+': Token_1.TokenKind.Plus
+            '+': Token_1.TokenKind.Plus,
+            '$': Token_1.TokenKind.DollarSign
         };
@@ -126,0 +127,0 @@ for (var _i = 0, _a = Object.getOwnPropertyNames(specialMap); _i < _a.length; _i++) {

package.json

 {
   "name": "@microsoft/tsdoc",
-  "version": "0.12.4",
+  "version": "0.12.5",
   "description": "A parser for the TypeScript doc comment syntax",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

627034

increased by0.51%

Lines of code

10899

increased by0.47%

No dependency changes