Merge pull request #99 from SimplrJS/dev

v4.0.0-rc.1

package.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-extractor",
-    "version": "4.0.0-beta.8",
+    "version": "4.0.0-rc.1",
     "description": "TypeScript AST extractor to useful JSON structure.",
     "keywords": [
         "typescript",
@@ -27,7 +27,7 @@
         "test-watch": "start npm run build-tests -- --watchAll && jest --watchAll",
         "build": "tsc -p .",
         "build-watch": "npm run build -- -w",
-        "build-tests": "cd tests && ts-node ./build-tests.ts -p ./",
+        "build-tests": "test-generator-cli",
         "prepublishOnly": "npm run build && rimraf dist/debug.*",
         "travis-release": "node ./tools/travis-release/release.js"
     },
@@ -46,10 +46,10 @@
         "typescript": "^2.6.2"
     },
     "devDependencies": {
+        "@simplrjs/test-generator-cli": "^0.1.3",
         "@types/globby": "^6.1.0",
         "@types/jest": "^21.1.9",
         "coveralls": "^3.0.0",
-        "globby": "^7.1.1",
         "jest": "^22.0.3",
         "rimraf": "^2.6.2",
         "simplr-tslint": "0.0.1",

src/api-helpers.ts

@@ -120,11 +120,13 @@ export namespace ApiHelpers {
         const declarationSourceFile = declaration.getSourceFile();
         const declarationFileName = declarationSourceFile.fileName;
 
+        // External library.
         if (options.Program.isSourceFileFromExternalLibrary(declarationSourceFile)) {
             const match = declarationSourceFile.fileName.match(NODE_MODULES_PACKAGE_REGEX);
             const packageName = match != null ? match[1] : undefined;
 
             if (packageName != null) {
+                // Check if PackageName is in external packages.
                 return options.ExternalPackages.
                     findIndex(x => x.toLowerCase() === packageName.toLowerCase()) !== -1;
             } else {
@@ -133,6 +135,19 @@ export namespace ApiHelpers {
         } else if (!PathIsInside(declarationFileName, options.ExtractorOptions.ProjectDirectory)) {
             // If it's not external package, it should be in project directory.
             return false;
+        } else if (options.ExtractorOptions.Exclude != null) {
+            // Exclude file name.
+            const result = options.ExtractorOptions.Exclude
+                .findIndex(excludeItem => {
+                    const fullPath = path
+                        .resolve(options.ExtractorOptions.ProjectDirectory, excludeItem)
+                        .split(path.sep)
+                        .join(options.ExtractorOptions.OutputPathSeparator);
+
+                    return fullPath === declarationFileName;
+                });
+
+            return result === -1;
         }
 
         return true;
@@ -198,6 +213,11 @@ export namespace ApiHelpers {
             }
         }
 
+        // If symbol doesn't have resolved api definitions.
+        if (symbolItems.length === 0) {
+            return undefined;
+        }
+
         return {
             Alias: symbol.name,
             Ids: symbolItems
@@ -208,7 +228,7 @@ export namespace ApiHelpers {
         declarations: ts.NodeArray<ts.Declaration>,
         options: ApiItemOptions
     ): ApiItemReference[] {
-        const items: ApiItemReference[] = [];
+        let items: ApiItemReference[] = [];
         const typeChecker = options.Program.getTypeChecker();
 
         declarations.forEach(declaration => {
@@ -234,6 +254,9 @@ export namespace ApiHelpers {
             }
         });
 
+        // If symbol doesn't have resolved api definitions.
+        items = items.filter(x => x.Ids.length !== 0);
+
         return items;
     }
 

src/contracts/extractor-options.ts

@@ -1,13 +1,25 @@
 import * as ts from "typescript";
 
 export interface ExtractorOptions {
+    /**
+     * TypeScript compiler options.
+     */
     CompilerOptions: ts.CompilerOptions;
+    /**
+     * Full path to TypeScript project directory.
+     */
     ProjectDirectory: string;
     /**
-     * Not Yet implemented.
+     * File locations that should not be included in extracted data.
      */
     Exclude?: string[];
+    /**
+     * Used to standartize paths in extracted data.
+     */
     OutputPathSeparator?: string;
+    /**
+     * Package names to include in extracted data.
+     */
     ExternalPackages?: string[];
     /**
      * Include TypeScript specific information in extracted data.

src/definitions/api-export.ts

@@ -35,7 +35,7 @@ export class ApiExport extends ApiItem<ts.ExportDeclaration, ApiExportDto> {
         // Extract members from Source file.
         const sourceFileDeclaration = TsHelpers.ResolveSourceFile(this.Declaration, this.Options.Program);
 
-        if (sourceFileDeclaration != null) {
+        if (sourceFileDeclaration != null && ApiHelpers.ShouldVisit(sourceFileDeclaration, this.Options)) {
             const sourceFileSymbol = TsHelpers.GetSymbolFromDeclaration(sourceFileDeclaration, this.TypeChecker);
 
             if (sourceFileSymbol != null) {