@microsoft/api-extractor - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "1.1.3",
+      "tag": "@microsoft/api-extractor_v1.1.3",
+      "date": "Tue, 24 Jan 2017 01:36:35 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Json schema was updated to reflect feature additions to linkDocElement. The linkDocElement can now be of type 'code' which refers to an API definition reference."
+          }
+        ]
+      }
+    },
+    {
       "version": "1.1.2",
@@ -7,0 +19,0 @@ "tag": "@microsoft/api-extractor_v1.1.2",

CHANGELOG.md

 # Change Log - @microsoft/api-extractor
 
-This log was last generated on Fri, 20 Jan 2017 01:46:41 GMT and should not be manually modified.
+This log was last generated on Tue, 24 Jan 2017 01:36:35 GMT and should not be manually modified.
 
+## 1.1.3
+Tue, 24 Jan 2017 01:36:35 GMT
+
+### Patches
+
+- Json schema was updated to reflect feature additions to linkDocElement. The linkDocElement can now be of type 'code' which refers to an API definition reference.
+
 ## 1.1.2
@@ -6,0 +13,0 @@ Fri, 20 Jan 2017 01:46:41 GMT

lib/JsonFile.d.ts

@@ -1,2 +0,2 @@
-export declare type ValidateErrorCallback = (errorDetail: string) => void;
+export declare type ValidateErrorCallback = (errorDescription: string) => void;
 /**
@@ -14,3 +14,3 @@ * Utilities for reading/writing JSON files.
     private static _validateNoUndefinedMembers(json);
-    private static _formatErrorDetails(errorDetails, indent, result);
+    private static _formatErrorDetails(errorDetails, indent, buffer);
     /**
@@ -17,0 +17,0 @@ * Returns the same thing as targetString.replace(searchValue, replaceValue), except that

lib/JsonFile.js

@@ -24,6 +24,6 @@ "use strict";
         if (!validator.validate(jsonObject, jsonSchemaObject)) {
-            var error = validator.getLastError();
-            var errorDetail = 'JSON schema validation failed:';
-            errorDetail = JsonFile._formatErrorDetails(error.details, '  ', errorDetail);
-            errorCallback(errorDetail);
+            var errorDetails = validator.getLastErrors();
+            var buffer = 'JSON schema validation failed:';
+            buffer = JsonFile._formatErrorDetails(errorDetails, '  ', buffer);
+            errorCallback(buffer);
         }
@@ -70,13 +70,12 @@ };
     };
-    JsonFile._formatErrorDetails = function (errorDetails, indent, result) {
+    JsonFile._formatErrorDetails = function (errorDetails, indent, buffer) {
         for (var _i = 0, errorDetails_1 = errorDetails; _i < errorDetails_1.length; _i++) {
-            var detail = errorDetails_1[_i];
-            result += os.EOL + indent + ("Error: " + detail.path);
-            // result += os.EOL + indent + `       ${detail.code}`;
-            result += os.EOL + indent + ("       " + detail.message);
-            if (detail.inner) {
-                result = JsonFile._formatErrorDetails(detail.inner, indent + '  ', result);
+            var errorDetail = errorDetails_1[_i];
+            buffer += os.EOL + indent + ("Error: " + errorDetail.path);
+            buffer += os.EOL + indent + ("       " + errorDetail.message);
+            if (errorDetail.inner) {
+                buffer = JsonFile._formatErrorDetails(errorDetail.inner, indent + '  ', buffer);
             }
         }
-        return result;
+        return buffer;
     };
@@ -83,0 +82,0 @@ /**

lib/schemas/api-json-schema.json

@@ -53,6 +53,22 @@ {
           "type": "string"
+        },
+        "memberName": {
+          "description": "An optional name that specifies the export item",
+          "type": "string"
+        },
+        "exportName": {
+          "description": "A name that is required if the referenceType is code",
+          "type": "string"
+        },
+        "packageName": {
+          "description": "An optional name of the package where an export is located",
+          "type": "string"
+        },
+        "scopeName": {
+          "description": "An optional name that scopes the package name",
+          "type": "string"
         }
       },
       "additionalProperties": false,
-      "required": [ "kind", "referenceType", "targetUrl" ]
+      "required": [ "kind", "referenceType" ]
     },
@@ -59,0 +75,0 @@

package.json

 {
   "name": "@microsoft/api-extractor",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Validatation, documentation, and auditing for the exported API of a TypeScript package",
@@ -25,3 +25,3 @@ "main": "lib/index.js",
     "@types/node": ">=6.0.51 <6.9.1",
-    "@types/z-schema": "3.16.20-alpha",
+    "@types/z-schema": "~3.16.31",
     "fs-extra": "~0.26.0",
@@ -28,0 +28,0 @@ "jju": "~1.3.0",

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

490400

increased by0.17%

Lines of code

5779

increased by0.47%

Dependency changes

• + Added@types/z-schema@3.16.32(transitive)

• - Removed@types/z-schema@3.16.20-alpha(transitive)

• Updated@types/z-schema@~3.16.31