@microsoft/api-extractor - npm Package Compare versions

Comparing version 2.3.1 to 2.3.2

CHANGELOG.json

@@ -5,2 +5,14 @@ {
     {
+      "version": "2.3.2",
+      "tag": "@microsoft/api-extractor_v2.3.2",
+      "date": "Tue, 15 Aug 2017 01:29:31 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Introduce Span parser for upcoming *.d.ts generator"
+          }
+        ]
+      }
+    },
+    {
       "version": "2.3.1",
@@ -7,0 +19,0 @@ "tag": "@microsoft/api-extractor_v2.3.1",

CHANGELOG.md

 # Change Log - @microsoft/api-extractor
 
-This log was last generated on Thu, 27 Jul 2017 01:04:48 GMT and should not be manually modified.
+This log was last generated on Tue, 15 Aug 2017 01:29:31 GMT and should not be manually modified.
 
+## 2.3.2
+Tue, 15 Aug 2017 01:29:31 GMT
+
+### Patches
+
+- Introduce Span parser for upcoming *.d.ts generator
+
 ## 2.3.1
@@ -6,0 +13,0 @@ Thu, 27 Jul 2017 01:04:48 GMT

lib/DebugRun.js

@@ -8,2 +8,3 @@ "use strict";
 var ts = require("typescript");
+var path = require("path");
 var os = require("os");
@@ -13,3 +14,4 @@ var Extractor_1 = require("./Extractor");
 var ApiJsonGenerator_1 = require("./generators/ApiJsonGenerator");
-var ApiDefinitionReference_1 = require("./ApiDefinitionReference");
+var ROOT_DIR = './test/inputs/example4';
+var ENTRY_POINT = 'src/index.ts';
 var compilerOptions = {
@@ -21,4 +23,4 @@ target: ts.ScriptTarget.ES5,
     jsx: ts.JsxEmit.React,
-    rootDir: './testInputs/example4',
-    typeRoots: ['./'] // We need to ignore @types in these tests
+    rootDir: ROOT_DIR,
+    types: ['es6-collections', 'webpack-env']
 };
@@ -33,20 +35,18 @@ var extractor = new Extractor_1.default({
 extractor.loadExternalPackages('./testInputs/external-api-json');
-extractor.analyze({ entryPointFile: './testInputs/example4/src/index.ts',
-    otherFiles: [] });
-var externalPackageApiRef = {
-    scopeName: '',
-    packageName: 'es6-collections',
-    exportName: '',
-    memberName: ''
-};
+process.chdir(ROOT_DIR);
+extractor.analyze({
+    entryPointFile: path.join(ROOT_DIR, ENTRY_POINT),
+    otherFiles: [
+        path.join(ROOT_DIR, './typings/tsd.d.ts')
+    ]
+});
 // Normally warnings are kept by the ApiItem data structure,
 // and written to the '*.api.ts' file.
 var warnings = [];
-var apiDefinitionRef = ApiDefinitionReference_1.default.createFromParts(externalPackageApiRef);
 var apiFileGenerator = new ApiFileGenerator_1.default();
-apiFileGenerator.writeApiFile('./lib/DebugRun.api.ts', extractor);
+apiFileGenerator.writeApiFile(path.join(__dirname, './DebugRun-Output.api.ts'), extractor);
 var apiJsonGenerator = new ApiJsonGenerator_1.default();
-apiJsonGenerator.writeJsonFile('./lib/DebugRun.json', extractor);
+apiJsonGenerator.writeJsonFile(path.join(__dirname, './DebugRun-Output.json'), extractor);
 console.log('DebugRun completed.');
 
 //# sourceMappingURL=DebugRun.js.map

lib/IndentedWriter.d.ts

@@ -25,2 +25,7 @@ /**
 export default class IndentedWriter {
+    /**
+     * The text characters used to create one level of indentation.
+     * Two spaces by default.
+     */
+    spacing: string;
     private _output;
@@ -30,3 +35,9 @@ private _indentStack;
     private _needsIndent;
+    constructor();
     /**
+     * Resets the stream, erasing any output and indentation levels.
+     * Does not reset the "spacing" configuration.
+     */
+    clear(): void;
+    /**
      * Retrieves the indented output.
@@ -42,3 +53,3 @@ */
      */
-    increaseIndent(prefix?: string): void;
+    increaseIndent(): void;
     /**
@@ -45,0 +56,0 @@ * Decreases the indentation, reverting the effect of the corresponding call

lib/IndentedWriter.js

@@ -30,2 +30,14 @@ "use strict";
     function IndentedWriter() {
+        /**
+         * The text characters used to create one level of indentation.
+         * Two spaces by default.
+         */
+        this.spacing = '  ';
+        this.clear();
+    }
+    /**
+     * Resets the stream, erasing any output and indentation levels.
+     * Does not reset the "spacing" configuration.
+     */
+    IndentedWriter.prototype.clear = function () {
         this._output = '';
@@ -35,3 +47,3 @@ this._indentStack = [];
         this._needsIndent = true;
-    }
+    };
     /**
@@ -50,5 +62,4 @@ * Retrieves the indented output.
      */
-    IndentedWriter.prototype.increaseIndent = function (prefix) {
-        if (prefix === void 0) { prefix = '  '; }
-        this._indentStack.push(prefix);
+    IndentedWriter.prototype.increaseIndent = function () {
+        this._indentStack.push(this.spacing);
         this._updateIndentText();
@@ -55,0 +66,0 @@ };

package.json

 {
   "name": "@microsoft/api-extractor",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "Validate, document, and review the exported API for a TypeScript library",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Lines of code

10012

1.67%

Number of low supply chain risk alerts

8

-11.11%

Worsened metrics

Total package byte prevSize

794670

-0.29%

Number of package files

166

-3.49%

No dependency changes