@microsoft/api-extractor - npm Package Compare versions

Comparing version 2.3.0 to 2.3.1

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "2.3.1",
+      "tag": "@microsoft/api-extractor_v2.3.1",
+      "date": "Thu, 27 Jul 2017 01:04:48 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Upgrade to the TS2.4 version of the build tools."
+          }
+        ]
+      }
+    },
+    {
       "version": "2.3.0",
@@ -7,0 +19,0 @@ "tag": "@microsoft/api-extractor_v2.3.0",

CHANGELOG.md

 # Change Log - @microsoft/api-extractor
 
-This log was last generated on Tue, 25 Jul 2017 20:03:31 GMT and should not be manually modified.
+This log was last generated on Thu, 27 Jul 2017 01:04:48 GMT and should not be manually modified.
 
+## 2.3.1
+Thu, 27 Jul 2017 01:04:48 GMT
+
+### Patches
+
+- Upgrade to the TS2.4 version of the build tools.
+
 ## 2.3.0
@@ -6,0 +13,0 @@ Tue, 25 Jul 2017 20:03:31 GMT

lib/ApiDefinitionReference.d.ts

@@ -122,3 +122,3 @@ /**
     toMemberString(): string;
-    private constructor(parts);
+    private constructor();
 }

lib/ApiDefinitionReference.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -120,19 +120,19 @@ /**
     };
+    /**
+     * Splits an API reference expression into two parts, first part is the scopename/packageName and
+     * the second part is the exportName.memberName.
+     */
+    ApiDefinitionReference._packageRegEx = /^([^:]*)\:(.*)$/;
+    /**
+     * Splits the exportName.memberName into two respective parts.
+     */
+    ApiDefinitionReference._memberRegEx = /^([^.|:]*)(?:\.(\w+))?$/;
+    /**
+     * Used to ensure that the export name contains only text characters.
+     */
+    ApiDefinitionReference._exportRegEx = /^\w+/;
     return ApiDefinitionReference;
 }());
-/**
- * Splits an API reference expression into two parts, first part is the scopename/packageName and
- * the second part is the exportName.memberName.
- */
-ApiDefinitionReference._packageRegEx = /^([^:]*)\:(.*)$/;
-/**
- * Splits the exportName.memberName into two respective parts.
- */
-ApiDefinitionReference._memberRegEx = /^([^.|:]*)(?:\.(\w+))?$/;
-/**
- * Used to ensure that the export name contains only text characters.
- */
-ApiDefinitionReference._exportRegEx = /^\w+/;
 exports.default = ApiDefinitionReference;
 
 //# sourceMappingURL=ApiDefinitionReference.js.map

lib/ApiItemVisitor.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -56,7 +56,5 @@ var ApiPackage_1 = require("./definitions/ApiPackage");
     };
-    ;
     ApiItemVisitor.prototype.visitApiProperty = function (apiProperty, refObject) {
         this.visitApiMember(apiProperty, refObject);
     };
-    ;
     return ApiItemVisitor;
@@ -63,0 +61,0 @@ }());

lib/DebugRun.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ // NOTE: THIS SOURCE FILE IS FOR DEBUGGING PURPOSES ONLY.

lib/definitions/ApiDocumentation.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -291,34 +291,34 @@ var DocElementParser_1 = require("../DocElementParser");
     };
+    /**
+     * Match AEDoc block tags and inline tags
+     * Example "@a @b@c d@e @f {whatever} {@link a} { @something } \@g" => ["@a", "@f", "{@link a}", "{ @something }"]
+     */
+    ApiDocumentation._aedocTagsRegex = /{\s*@(\\{|\\}|[^{}])*}|(?:^|\s)(\@[a-z_]+)(?=\s|$)/gi;
+    // For guidance about using these tags, please see this documentation:
+    // https://github.com/Microsoft/web-build-tools/wiki/API-Extractor-~-AEDoc-tags
+    ApiDocumentation._allowedRegularAedocTags = [
+        // (alphabetical order)
+        '@alpha',
+        '@beta',
+        '@betadocumentation',
+        '@internal',
+        '@internalremarks',
+        '@param',
+        '@preapproved',
+        '@public',
+        '@returns',
+        '@see',
+        '@deprecated',
+        '@readonly',
+        '@remarks'
+    ];
+    ApiDocumentation._allowedInlineAedocTags = [
+        // (alphabetical order)
+        '@inheritdoc',
+        '@link'
+    ];
     return ApiDocumentation;
 }());
-/**
- * Match AEDoc block tags and inline tags
- * Example "@a @b@c d@e @f {whatever} {@link a} { @something } \@g" => ["@a", "@f", "{@link a}", "{ @something }"]
- */
-ApiDocumentation._aedocTagsRegex = /{\s*@(\\{|\\}|[^{}])*}|(?:^|\s)(\@[a-z_]+)(?=\s|$)/gi;
-// For guidance about using these tags, please see this documentation:
-// https://github.com/Microsoft/web-build-tools/wiki/API-Extractor-~-AEDoc-tags
-ApiDocumentation._allowedRegularAedocTags = [
-    // (alphabetical order)
-    '@alpha',
-    '@beta',
-    '@betadocumentation',
-    '@internal',
-    '@internalremarks',
-    '@param',
-    '@preapproved',
-    '@public',
-    '@returns',
-    '@see',
-    '@deprecated',
-    '@readonly',
-    '@remarks'
-];
-ApiDocumentation._allowedInlineAedocTags = [
-    // (alphabetical order)
-    '@inheritdoc',
-    '@link'
-];
 exports.default = ApiDocumentation;
 
 //# sourceMappingURL=ApiDocumentation.js.map

lib/definitions/ApiEnum.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/definitions/ApiEnumValue.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/definitions/ApiFunction.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/definitions/ApiItem.d.ts

@@ -228,2 +228,26 @@ import * as ts from 'typescript';
     /**
+     * This function is a second stage that happens after Extractor.analyze() calls ApiItem constructor to build up
+     * the abstract syntax tree. In this second stage, we are creating the documentation for each ApiItem.
+     *
+     * This function makes sure we create the documentation for each ApiItem in the correct order.
+     * In the event that a circular dependency occurs, an error is reported. For example, if ApiItemOne has
+     * an \@inheritdoc referencing ApiItemTwo, and ApiItemTwo has an \@inheritdoc referencing ApiItemOne then
+     * we have a circular dependency and an error will be reported.
+     */
+    completeInitialization(): void;
+    /**
+     * A procedure for determining if this ApiItem is missing type
+     * information. We first check if the ApiItem itself is missing
+     * any type information and if not then we check each of it's
+     * innerItems for missing types.
+     *
+     * Ex: On the ApiItem itself, there may be missing type information
+     * on the return value or missing type declaration of itself
+     * (const name;).
+     * Ex: For each innerItem, there may be an ApiParameter that is missing
+     * a type. Or for an ApiMember that is a type literal, there may be an
+     * ApiProperty that is missing type information.
+     */
+    hasAnyIncompleteTypes(): boolean;
+    /**
      * This traverses any type aliases to find the original place where an item was defined.
@@ -256,26 +280,2 @@ * For example, suppose a class is defined as "export default class MyClass { }"
     /**
-     * This function is a second stage that happens after Extractor.analyze() calls ApiItem constructor to build up
-     * the abstract syntax tree. In this second stage, we are creating the documentation for each ApiItem.
-     *
-     * This function makes sure we create the documentation for each ApiItem in the correct order.
-     * In the event that a circular dependency occurs, an error is reported. For example, if ApiItemOne has
-     * an \@inheritdoc referencing ApiItemTwo, and ApiItemTwo has an \@inheritdoc referencing ApiItemOne then
-     * we have a circular dependency and an error will be reported.
-     */
-    completeInitialization(): void;
-    /**
-     * A procedure for determining if this ApiItem is missing type
-     * information. We first check if the ApiItem itself is missing
-     * any type information and if not then we check each of it's
-     * innerItems for missing types.
-     *
-     * Ex: On the ApiItem itself, there may be missing type information
-     * on the return value or missing type declaration of itself
-     * (const name;).
-     * Ex: For each innerItem, there may be an ApiParameter that is missing
-     * a type. Or for an ApiMember that is a type literal, there may be an
-     * ApiProperty that is missing type information.
-     */
-    hasAnyIncompleteTypes(): boolean;
-    /**
      * This is called by ApiItems to visit the types that appear in an expression.  For example,
@@ -282,0 +282,0 @@ * if a Public API function returns a class that is defined in this package, but not exported,

lib/definitions/ApiItem.js

@@ -0,8 +1,7 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable:no-bitwise */
 /* tslint:disable:no-constant-condition */
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var ts = require("typescript");
@@ -198,2 +197,56 @@ var ApiDocumentation_1 = require("./ApiDocumentation");
     /**
+     * This function is a second stage that happens after Extractor.analyze() calls ApiItem constructor to build up
+     * the abstract syntax tree. In this second stage, we are creating the documentation for each ApiItem.
+     *
+     * This function makes sure we create the documentation for each ApiItem in the correct order.
+     * In the event that a circular dependency occurs, an error is reported. For example, if ApiItemOne has
+     * an \@inheritdoc referencing ApiItemTwo, and ApiItemTwo has an \@inheritdoc referencing ApiItemOne then
+     * we have a circular dependency and an error will be reported.
+     */
+    ApiItem.prototype.completeInitialization = function () {
+        switch (this._state) {
+            case InitializationState.Completed:
+                return;
+            case InitializationState.Incomplete:
+                this._state = InitializationState.Completing;
+                this.onCompleteInitialization();
+                this._state = InitializationState.Completed;
+                for (var _i = 0, _a = this.innerItems; _i < _a.length; _i++) {
+                    var innerItem = _a[_i];
+                    innerItem.completeInitialization();
+                }
+                return;
+            case InitializationState.Completing:
+                this.reportError('circular reference');
+                return;
+            default:
+                throw new Error('ApiItem state is invalid');
+        }
+    };
+    /**
+     * A procedure for determining if this ApiItem is missing type
+     * information. We first check if the ApiItem itself is missing
+     * any type information and if not then we check each of it's
+     * innerItems for missing types.
+     *
+     * Ex: On the ApiItem itself, there may be missing type information
+     * on the return value or missing type declaration of itself
+     * (const name;).
+     * Ex: For each innerItem, there may be an ApiParameter that is missing
+     * a type. Or for an ApiMember that is a type literal, there may be an
+     * ApiProperty that is missing type information.
+     */
+    ApiItem.prototype.hasAnyIncompleteTypes = function () {
+        if (this.hasIncompleteTypes) {
+            return true;
+        }
+        for (var _i = 0, _a = this.innerItems; _i < _a.length; _i++) {
+            var innerItem = _a[_i];
+            if (innerItem.hasIncompleteTypes) {
+                return true;
+            }
+        }
+        return false;
+    };
+    /**
      * This traverses any type aliases to find the original place where an item was defined.
@@ -295,56 +348,2 @@ * For example, suppose a class is defined as "export default class MyClass { }"
     /**
-     * This function is a second stage that happens after Extractor.analyze() calls ApiItem constructor to build up
-     * the abstract syntax tree. In this second stage, we are creating the documentation for each ApiItem.
-     *
-     * This function makes sure we create the documentation for each ApiItem in the correct order.
-     * In the event that a circular dependency occurs, an error is reported. For example, if ApiItemOne has
-     * an \@inheritdoc referencing ApiItemTwo, and ApiItemTwo has an \@inheritdoc referencing ApiItemOne then
-     * we have a circular dependency and an error will be reported.
-     */
-    ApiItem.prototype.completeInitialization = function () {
-        switch (this._state) {
-            case InitializationState.Completed:
-                return;
-            case InitializationState.Incomplete:
-                this._state = InitializationState.Completing;
-                this.onCompleteInitialization();
-                this._state = InitializationState.Completed;
-                for (var _i = 0, _a = this.innerItems; _i < _a.length; _i++) {
-                    var innerItem = _a[_i];
-                    innerItem.completeInitialization();
-                }
-                return;
-            case InitializationState.Completing:
-                this.reportError('circular reference');
-                return;
-            default:
-                throw new Error('ApiItem state is invalid');
-        }
-    };
-    /**
-     * A procedure for determining if this ApiItem is missing type
-     * information. We first check if the ApiItem itself is missing
-     * any type information and if not then we check each of it's
-     * innerItems for missing types.
-     *
-     * Ex: On the ApiItem itself, there may be missing type information
-     * on the return value or missing type declaration of itself
-     * (const name;).
-     * Ex: For each innerItem, there may be an ApiParameter that is missing
-     * a type. Or for an ApiMember that is a type literal, there may be an
-     * ApiProperty that is missing type information.
-     */
-    ApiItem.prototype.hasAnyIncompleteTypes = function () {
-        if (this.hasIncompleteTypes) {
-            return true;
-        }
-        for (var _i = 0, _a = this.innerItems; _i < _a.length; _i++) {
-            var innerItem = _a[_i];
-            if (innerItem.hasIncompleteTypes) {
-                return true;
-            }
-        }
-        return false;
-    };
-    /**
      * This is called by ApiItems to visit the types that appear in an expression.  For example,
@@ -473,10 +472,10 @@ * if a Public API function returns a class that is defined in this package, but not exported,
     };
+    /**
+     * Names of API items should only contain letters, numbers and underscores.
+     */
+    ApiItem._allowedNameRegex = /^[a-zA-Z_]+[a-zA-Z_0-9]*$/;
     return ApiItem;
 }());
-/**
- * Names of API items should only contain letters, numbers and underscores.
- */
-ApiItem._allowedNameRegex = /^[a-zA-Z_]+[a-zA-Z_0-9]*$/;
 exports.default = ApiItem;
 
 //# sourceMappingURL=ApiItem.js.map

lib/definitions/ApiItemContainer.d.ts

@@ -20,10 +20,10 @@ import ApiItem, { IApiItemOptions } from './ApiItem';
     /**
+     * @virtual
+     */
+    visitTypeReferencesForApiItem(): void;
+    /**
      * Add a child item to the container.
      */
     protected addMemberItem(apiItem: ApiItem): void;
-    /**
-     * @virtual
-     */
-    visitTypeReferencesForApiItem(): void;
 }
 export default ApiItemContainer;

lib/definitions/ApiItemContainer.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -15,3 +15,2 @@ var extendStatics = Object.setPrototypeOf ||
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var ApiItem_1 = require("./ApiItem");
@@ -49,2 +48,11 @@ /**
     /**
+     * @virtual
+     */
+    ApiItemContainer.prototype.visitTypeReferencesForApiItem = function () {
+        _super.prototype.visitTypeReferencesForApiItem.call(this);
+        this._memberItems.forEach(function (apiItem) {
+            apiItem.visitTypeReferencesForApiItem();
+        });
+    };
+    /**
      * Add a child item to the container.
@@ -62,11 +70,2 @@ */
     };
-    /**
-     * @virtual
-     */
-    ApiItemContainer.prototype.visitTypeReferencesForApiItem = function () {
-        _super.prototype.visitTypeReferencesForApiItem.call(this);
-        this._memberItems.forEach(function (apiItem) {
-            apiItem.visitTypeReferencesForApiItem();
-        });
-    };
     return ApiItemContainer;
@@ -73,0 +72,0 @@ }(ApiItem_1.default));

lib/definitions/ApiMember.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -15,3 +15,2 @@ var extendStatics = Object.setPrototypeOf ||
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var ts = require("typescript");
@@ -18,0 +17,0 @@ var ApiItem_1 = require("./ApiItem");

lib/definitions/ApiMethod.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -15,3 +15,2 @@ var extendStatics = Object.setPrototypeOf ||
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var ts = require("typescript");
@@ -18,0 +17,0 @@ var ApiItem_1 = require("./ApiItem");

lib/definitions/ApiModuleVariable.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/definitions/ApiNamespace.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -16,3 +16,2 @@ var extendStatics = Object.setPrototypeOf ||
 /* tslint:disable:no-bitwise */
-/* tslint:disable:no-trailing-whitespace whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var ts = require("typescript");
@@ -19,0 +18,0 @@ var ApiModuleVariable_1 = require("./ApiModuleVariable");

lib/definitions/ApiPackage.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/definitions/ApiParameter.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/definitions/ApiProperty.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/definitions/ApiStructuredType.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -16,3 +16,2 @@ var extendStatics = Object.setPrototypeOf ||
 /* tslint:disable:no-bitwise */
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var ts = require("typescript");
@@ -19,0 +18,0 @@ var ApiMethod_1 = require("./ApiMethod");

lib/definitions/test/ApiDocumentation.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /// <reference types="mocha" />

lib/DocElementParser.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -246,27 +246,27 @@ var ApiDefinitionReference_1 = require("./ApiDefinitionReference");
     };
+    /**
+     * Used to validate the display text for an \@link tag.  The display text can contain any
+     * characters except for certain AEDoc delimiters: "@", "|", "{", "}".
+     * This RegExp matches the first bad character.
+     * Example: "Microsoft's {spec}" --> "{"
+     */
+    DocElementParser._displayTextBadCharacterRegEx = /[@|{}]/;
+    /**
+     * Matches a href reference. This is used to get an idea whether a given reference is for an href
+     * or an API definition reference.
+     *
+     * For example, the following would be matched:
+     * 'http://'
+     * 'https://'
+     *
+     * The following would not be matched:
+     * '@microsoft/sp-core-library:Guid.newGuid'
+     * 'Guid.newGuid'
+     * 'Guid'
+     */
+    DocElementParser._hrefRegEx = /^[a-z]+:\/\//;
     return DocElementParser;
 }());
-/**
- * Used to validate the display text for an \@link tag.  The display text can contain any
- * characters except for certain AEDoc delimiters: "@", "|", "{", "}".
- * This RegExp matches the first bad character.
- * Example: "Microsoft's {spec}" --> "{"
- */
-DocElementParser._displayTextBadCharacterRegEx = /[@|{}]/;
-/**
- * Matches a href reference. This is used to get an idea whether a given reference is for an href
- * or an API definition reference.
- *
- * For example, the following would be matched:
- * 'http://'
- * 'https://'
- *
- * The following would not be matched:
- * '@microsoft/sp-core-library:Guid.newGuid'
- * 'Guid.newGuid'
- * 'Guid'
- */
-DocElementParser._hrefRegEx = /^[a-z]+:\/\//;
 exports.default = DocElementParser;
 
 //# sourceMappingURL=DocElementParser.js.map

lib/DocItemLoader.js

@@ -0,6 +1,5 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var fsx = require("fs-extra");
@@ -7,0 +6,0 @@ var os = require("os");

lib/ExternalApiHelper.js

@@ -0,6 +1,5 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var ts = require("typescript");
@@ -7,0 +6,0 @@ var os = require("os");

lib/Extractor.js

@@ -0,6 +1,5 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var ts = require("typescript");
@@ -7,0 +6,0 @@ var fsx = require("fs-extra");

lib/generators/ApiFileGenerator.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -15,3 +15,2 @@ var extendStatics = Object.setPrototypeOf ||
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var fs = require("fs");
@@ -18,0 +17,0 @@ var ApiItem_1 = require("../definitions/ApiItem");

lib/generators/ApiJsonFile.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -79,17 +79,17 @@ var ApiItem_1 = require("../definitions/ApiItem");
     };
+    ApiJsonFile._KIND_CONSTRUCTOR = 'constructor';
+    ApiJsonFile._KIND_CLASS = 'class';
+    ApiJsonFile._KIND_ENUM = 'enum';
+    ApiJsonFile._KIND_ENUM_VALUE = 'enum value';
+    ApiJsonFile._KIND_INTERFACE = 'interface';
+    ApiJsonFile._KIND_FUNCTION = 'function';
+    ApiJsonFile._KIND_PACKAGE = 'package';
+    ApiJsonFile._KIND_PROPERTY = 'property';
+    ApiJsonFile._KIND_METHOD = 'method';
+    ApiJsonFile._KIND_NAMESPACE = 'namespace';
+    ApiJsonFile._KIND_MODULEVARIABLE = 'module variable';
     return ApiJsonFile;
 }());
-ApiJsonFile._KIND_CONSTRUCTOR = 'constructor';
-ApiJsonFile._KIND_CLASS = 'class';
-ApiJsonFile._KIND_ENUM = 'enum';
-ApiJsonFile._KIND_ENUM_VALUE = 'enum value';
-ApiJsonFile._KIND_INTERFACE = 'interface';
-ApiJsonFile._KIND_FUNCTION = 'function';
-ApiJsonFile._KIND_PACKAGE = 'package';
-ApiJsonFile._KIND_PROPERTY = 'property';
-ApiJsonFile._KIND_METHOD = 'method';
-ApiJsonFile._KIND_NAMESPACE = 'namespace';
-ApiJsonFile._KIND_MODULEVARIABLE = 'module variable';
 exports.default = ApiJsonFile;
 
 //# sourceMappingURL=ApiJsonFile.js.map

lib/generators/ApiJsonGenerator.d.ts

@@ -31,4 +31,4 @@ import Extractor from '../Extractor';
     protected jsonOutput: Object;
+    writeJsonFile(reportFilename: string, extractor: Extractor): void;
     protected visit(apiItem: ApiItem, refObject?: Object): void;
-    writeJsonFile(reportFilename: string, extractor: Extractor): void;
     protected visitApiStructuredType(apiStructuredType: ApiStructuredType, refObject?: Object): void;
@@ -35,0 +35,0 @@ protected visitApiEnum(apiEnum: ApiEnum, refObject?: Object): void;

lib/generators/ApiJsonGenerator.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -15,3 +15,2 @@ var extendStatics = Object.setPrototypeOf ||
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var os = require("os");
@@ -44,14 +43,2 @@ var path = require("path");
     }
-    // @override
-    ApiJsonGenerator.prototype.visit = function (apiItem, refObject) {
-        switch (apiItem.documentation.releaseTag) {
-            case ApiDocumentation_1.ReleaseTag.None:
-            case ApiDocumentation_1.ReleaseTag.Beta:
-            case ApiDocumentation_1.ReleaseTag.Public:
-                break;
-            default:
-                return; // skip @alpha and @internal definitions
-        }
-        _super.prototype.visit.call(this, apiItem, refObject);
-    };
     ApiJsonGenerator.prototype.writeJsonFile = function (reportFilename, extractor) {
@@ -71,2 +58,14 @@ this.visit(extractor.package, this.jsonOutput);
     };
+    // @override
+    ApiJsonGenerator.prototype.visit = function (apiItem, refObject) {
+        switch (apiItem.documentation.releaseTag) {
+            case ApiDocumentation_1.ReleaseTag.None:
+            case ApiDocumentation_1.ReleaseTag.Beta:
+            case ApiDocumentation_1.ReleaseTag.Public:
+                break;
+            default:
+                return; // skip @alpha and @internal definitions
+        }
+        _super.prototype.visit.call(this, apiItem, refObject);
+    };
     ApiJsonGenerator.prototype.visitApiStructuredType = function (apiStructuredType, refObject) {
@@ -280,9 +279,9 @@ if (!apiStructuredType.supportedName) {
     };
+    ApiJsonGenerator._methodCounter = 0;
+    ApiJsonGenerator._MEMBERS_KEY = 'members';
+    ApiJsonGenerator._EXPORTS_KEY = 'exports';
     return ApiJsonGenerator;
 }(ApiItemVisitor_1.default));
-ApiJsonGenerator._methodCounter = 0;
-ApiJsonGenerator._MEMBERS_KEY = 'members';
-ApiJsonGenerator._EXPORTS_KEY = 'exports';
 exports.default = ApiJsonGenerator;
 
 //# sourceMappingURL=ApiJsonGenerator.js.map

lib/generators/test/ApiFileGenerator.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /// <reference types="mocha" />

lib/generators/test/ApiJsonGenerator.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /// <reference types="mocha" />

lib/IDocElement.js

@@ -0,6 +1,6 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 
 //# sourceMappingURL=IDocElement.js.map

lib/IDocItem.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /**

lib/IExportedSymbol.js

@@ -0,6 +1,6 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 
 //# sourceMappingURL=IExportedSymbol.js.map

lib/IndentedWriter.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /**

lib/index.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ var Extractor_1 = require("./Extractor");

lib/JsonFile.js

@@ -0,6 +1,5 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var fsx = require("fs-extra");
@@ -7,0 +6,0 @@ var os = require("os");

lib/PackageJsonLookup.js

@@ -0,7 +1,6 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable:no-constant-condition */
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var fsx = require("fs-extra");
@@ -8,0 +7,0 @@ var path = require("path");

lib/PrettyPrinter.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /* tslint:disable:no-bitwise */

lib/ResolvedApiItem.d.ts

@@ -34,3 +34,3 @@ import ApiItem, { ApiItemKind } from './definitions/ApiItem';
     static createFromJson(docItem: IDocItem): ResolvedApiItem;
-    private constructor(kind, summary, remarks, deprecatedMessage, isBeta, params, returnsMessage, releaseTag, apiItem);
+    private constructor();
 }

lib/ResolvedApiItem.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ var ApiDocumentation_1 = require("./definitions/ApiDocumentation");

lib/test/ApiDefinitionReference.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /// <reference types="mocha" />

lib/test/DocElementParser.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/test/DocItemLoader.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /// <reference types="mocha" />

lib/test/PackageJsonLookup.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /// <reference types="mocha" />

lib/test/Token.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /// <reference types="mocha" />

lib/test/Tokenizer.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 var __extends = (this && this.__extends) || (function () {
@@ -5,0 +5,0 @@ var extendStatics = Object.setPrototypeOf ||

lib/test/TypeScriptHelpers.test.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /// <reference types="mocha" />

lib/TestFileComparer.js

@@ -0,6 +1,5 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var chai_1 = require("chai");
@@ -7,0 +6,0 @@ var fs = require("fs");

lib/TestRun.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ // NOTE: THIS SOURCE FILE IS FOR DEBUGGING PURPOSES ONLY.

lib/Token.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,0 +5,0 @@ /**

lib/Tokenizer.d.ts

@@ -17,2 +17,4 @@ import Token from './Token';
     constructor(docs: string, reportError: (message: string) => void);
+    peekToken(): Token;
+    getToken(): Token;
     /**
@@ -36,4 +38,2 @@ * Converts a doc comment string into an array of Tokens. This processing is done so that docs
     protected _tokenizeInline(docEntry: string): Token;
-    peekToken(): Token;
-    getToken(): Token;
     /**
@@ -40,0 +40,0 @@ * Trims whitespace on either end of the entry (which is just a string within the doc comments),

lib/Tokenizer.js

@@ -0,6 +1,5 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/* tslint:disable:no-trailing-whitespace */ /* Remove this when GCB-TS is published and upgraded */
 var Token_1 = require("./Token");
@@ -16,2 +15,8 @@ var TypeScriptHelpers_1 = require("./TypeScriptHelpers");
     }
+    Tokenizer.prototype.peekToken = function () {
+        return (!this._tokenStream || this._tokenStream.length === 0) ? undefined : this._tokenStream[0];
+    };
+    Tokenizer.prototype.getToken = function () {
+        return (!this._tokenStream || this._tokenStream.length === 0) ? undefined : this._tokenStream.shift();
+    };
     /**
@@ -98,8 +103,2 @@ * Converts a doc comment string into an array of Tokens. This processing is done so that docs
     };
-    Tokenizer.prototype.peekToken = function () {
-        return (!this._tokenStream || this._tokenStream.length === 0) ? undefined : this._tokenStream[0];
-    };
-    Tokenizer.prototype.getToken = function () {
-        return (!this._tokenStream || this._tokenStream.length === 0) ? undefined : this._tokenStream.shift();
-    };
     /**
@@ -124,11 +123,11 @@ * Trims whitespace on either end of the entry (which is just a string within the doc comments),
     };
+    /**
+     * Match AEDoc block tags and inline tags
+     * Example "@a @b@c d@e @f {whatever} {@link a} { @something } \@g" => ["@a", "@f", "{@link a}", "{ @something }"]
+     */
+    Tokenizer._aedocTagsRegex = /{\s*@(\\{|\\}|[^{}])*}|(?:^|\s)(\@[a-z_]+)(?=\s|$)/gi;
     return Tokenizer;
 }());
-/**
- * Match AEDoc block tags and inline tags
- * Example "@a @b@c d@e @f {whatever} {@link a} { @something } \@g" => ["@a", "@f", "{@link a}", "{ @something }"]
- */
-Tokenizer._aedocTagsRegex = /{\s*@(\\{|\\}|[^{}])*}|(?:^|\s)(\@[a-z_]+)(?=\s|$)/gi;
 exports.default = Tokenizer;
 
 //# sourceMappingURL=Tokenizer.js.map

lib/TypeScriptHelpers.js

@@ -0,4 +1,4 @@
+"use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-"use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -199,22 +199,22 @@ var PrettyPrinter_1 = require("./PrettyPrinter");
     };
+    /**
+     * Splits by the characters '\r\n'.
+     */
+    TypeScriptHelpers.newLineRegEx = /\r\n|\n/g;
+    /**
+     * Start sequence is '/**'.
+     */
+    TypeScriptHelpers.jsdocStartRegEx = /^\s*\/\*\*\s?/g;
+    /**
+     * End sequence is '*\/'.
+     */
+    TypeScriptHelpers.jsdocEndRegEx = /\s*\*\/\s*$/g;
+    /**
+     * Intermediate lines of JSDoc comment character.
+     */
+    TypeScriptHelpers.jsdocIntermediateRegEx = /^\s*[*]\s?/g;
     return TypeScriptHelpers;
 }());
-/**
- * Splits by the characters '\r\n'.
- */
-TypeScriptHelpers.newLineRegEx = /\r\n|\n/g;
-/**
- * Start sequence is '/**'.
- */
-TypeScriptHelpers.jsdocStartRegEx = /^\s*\/\*\*\s?/g;
-/**
- * End sequence is '*\/'.
- */
-TypeScriptHelpers.jsdocEndRegEx = /\s*\*\/\s*$/g;
-/**
- * Intermediate lines of JSDoc comment character.
- */
-TypeScriptHelpers.jsdocIntermediateRegEx = /^\s*[*]\s?/g;
 exports.default = TypeScriptHelpers;
 
 //# sourceMappingURL=TypeScriptHelpers.js.map

package.json

 {
   "name": "@microsoft/api-extractor",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "Validate, document, and review the exported API for a TypeScript library",
@@ -35,3 +35,3 @@ "keywords": [
     "mocha": "~3.4.2",
-    "@microsoft/node-library-build": "~3.1.0"
+    "@microsoft/node-library-build": "~3.2.0"
   },
@@ -38,0 +38,0 @@ "dependencies": {

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

Worsened metrics

Total package byte prevSize

797010

decreased by-0.42%

Lines of code

9848

decreased by-0.05%

No dependency changes