@proteinjs/reflection-build 1.0.2 → 1.0.4

package/dist/modules/typescript-parser/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "typescript-parser",
+  "version": "0.0.1",
+  "private": true,
+  "description": "Parser for typescript (and javascript) files, that compiles those files and generates a human understandable AST.",
+  "main": "index.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "build": "npm run clean && tsc -p ./config/tsconfig.build.json",
+    "clean": "del-cli ./build ./coverage",
+    "develop": "npm run clean && tsc -p .",
+    "lint": "tslint -c ./tslint.json -p ./config/tsconfig.build.json 'src/**/*.ts'",
+    "test": "npm run lint && npm run clean && jest -c ./jest.json",
+    "test:watch": "npm run clean && jest -c ./jest.json --watch --no-coverage",
+    "typedoc": "del-cli ./docs && typedoc --ignoreCompilerErrors --out ./docs --mode file --tsconfig ./config/tsconfig.build.json ./src/",
+    "semantic-release": "semantic-release"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TypeScript-Heroes/node-typescript-parser.git"
+  },
+  "keywords": [
+    "typescript",
+    "parser",
+    "AST",
+    "parsing"
+  ],
+  "author": "Christoph Bühler <christoph.buehler@bluewin.ch>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/TypeScript-Heroes/node-typescript-parser/issues"
+  },
+  "homepage": "https://github.com/TypeScript-Heroes/node-typescript-parser#readme",
+  "devDependencies": {
+    "@smartive/tslint-config": "^4.0.0",
+    "@types/jest": "^23.3.1",
+    "@types/lodash-es": "^4.17.1",
+    "@types/mock-fs": "^3.6.30",
+    "@types/node": "^10.9.4",
+    "del-cli": "^1.1.0",
+    "jest": "^23.5.0",
+    "mock-fs": "^4.6.0",
+    "semantic-release": "^15.9.12",
+    "ts-jest": "^23.1.4",
+    "tslint": "^5.11.0",
+    "tsutils": "^3.0.0",
+    "typedoc": "^0.12.0"
+  },
+  "dependencies": {
+    "lodash": "^4.17.10",
+    "lodash-es": "^4.17.10",
+    "tslib": "^1.9.3",
+    "typescript": "^3.0.3"
+  }
+}

package/dist/modules/typescript-parser/resources/File.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="node" />
+import { ParsedPath } from 'path';
+import { Declaration } from '../declarations/Declaration';
+import { Export } from '../exports/Export';
+import { Import } from '../imports/Import';
+import { Node } from '../Node';
+import { Resource } from './Resource';
+/**
+ * TypeScript resource. Basically a file that is located somewhere.
+ *
+ * @export
+ * @class File
+ * @implements {Resource}
+ * @implements {Node}
+ */
+export declare class File implements Resource, Node {
+    filePath: string;
+    private rootPath;
+    start: number;
+    end: number;
+    imports: Import[];
+    exports: Export[];
+    declarations: Declaration[];
+    resources: Resource[];
+    usages: string[];
+    get identifier(): string;
+    get nonLocalUsages(): string[];
+    /**
+     * Returns the parsed path of a resource.
+     *
+     * @readonly
+     * @type {ParsedPath}
+     * @memberof File
+     */
+    get parsedPath(): ParsedPath;
+    /**
+     * Determines if a file is a workspace file or an external resource.
+     *
+     * @readonly
+     * @type {boolean}
+     * @memberof File
+     */
+    get isWorkspaceFile(): boolean;
+    constructor(filePath: string, rootPath: string, start: number, end: number);
+}

package/dist/modules/typescript-parser/resources/File.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.File = void 0;
+const path_1 = require("path");
+const PathHelpers_1 = require("../utilities/PathHelpers");
+const Module_1 = require("./Module");
+const Namespace_1 = require("./Namespace");
+/**
+ * TypeScript resource. Basically a file that is located somewhere.
+ *
+ * @export
+ * @class File
+ * @implements {Resource}
+ * @implements {Node}
+ */
+class File {
+    constructor(filePath, rootPath, start, end) {
+        this.filePath = filePath;
+        this.rootPath = rootPath;
+        this.start = start;
+        this.end = end;
+        this.imports = [];
+        this.exports = [];
+        this.declarations = [];
+        this.resources = [];
+        this.usages = [];
+    }
+    get identifier() {
+        return '/' + PathHelpers_1.normalizeFilename(path_1.relative(this.rootPath, this.filePath));
+    }
+    get nonLocalUsages() {
+        return this.usages
+            .filter(usage => !this.declarations.some(o => o.name === usage) &&
+            !this.resources.some(o => (o instanceof Module_1.Module || o instanceof Namespace_1.Namespace) && o.name === usage))
+            .concat(this.resources.reduce((all, cur) => all.concat(cur.nonLocalUsages), []));
+    }
+    /**
+     * Returns the parsed path of a resource.
+     *
+     * @readonly
+     * @type {ParsedPath}
+     * @memberof File
+     */
+    get parsedPath() {
+        return path_1.parse(this.filePath);
+    }
+    /**
+     * Determines if a file is a workspace file or an external resource.
+     *
+     * @readonly
+     * @type {boolean}
+     * @memberof File
+     */
+    get isWorkspaceFile() {
+        return ['node_modules', 'typings'].every(o => this.filePath.indexOf(o) === -1);
+    }
+}
+exports.File = File;

package/dist/modules/typescript-parser/resources/Module.d.ts

@@ -0,0 +1,35 @@
+import { Declaration } from '../declarations/Declaration';
+import { Export } from '../exports/Export';
+import { Import } from '../imports/Import';
+import { Node } from '../Node';
+import { Resource } from './Resource';
+/**
+ * TypeScript resource. Declaration of a typescript module (i.e. declare module "foobar").
+ *
+ * @export
+ * @class Module
+ * @implements {Resource}
+ * @implements {Node}
+ */
+export declare class Module implements Resource, Node {
+    name: string;
+    start: number;
+    end: number;
+    imports: Import[];
+    exports: Export[];
+    declarations: Declaration[];
+    resources: Resource[];
+    usages: string[];
+    get identifier(): string;
+    get nonLocalUsages(): string[];
+    constructor(name: string, start: number, end: number);
+    /**
+     * Function that calculates the alias name of a namespace.
+     * Removes all underlines and dashes and camelcases the name.
+     *
+     * @returns {string}
+     *
+     * @memberof Module
+     */
+    getNamespaceAlias(): string;
+}

package/dist/modules/typescript-parser/resources/Module.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Module = void 0;
+const Namespace_1 = require("./Namespace");
+/**
+ * TypeScript resource. Declaration of a typescript module (i.e. declare module "foobar").
+ *
+ * @export
+ * @class Module
+ * @implements {Resource}
+ * @implements {Node}
+ */
+class Module {
+    constructor(name, start, end) {
+        this.name = name;
+        this.start = start;
+        this.end = end;
+        this.imports = [];
+        this.exports = [];
+        this.declarations = [];
+        this.resources = [];
+        this.usages = [];
+    }
+    get identifier() {
+        return this.name;
+    }
+    get nonLocalUsages() {
+        return this.usages
+            .filter(usage => !this.declarations.some(o => o.name === usage) &&
+            !this.resources.some(o => (o instanceof Module || o instanceof Namespace_1.Namespace) && o.name === usage))
+            .concat(this.resources.reduce((all, cur) => all.concat(cur.nonLocalUsages), []));
+    }
+    /**
+     * Function that calculates the alias name of a namespace.
+     * Removes all underlines and dashes and camelcases the name.
+     *
+     * @returns {string}
+     *
+     * @memberof Module
+     */
+    getNamespaceAlias() {
+        return this.name.split(/[-_]/).reduce((all, cur, idx) => {
+            if (idx === 0) {
+                return all + cur.toLowerCase();
+            }
+            return all + cur.charAt(0).toUpperCase() + cur.substring(1).toLowerCase();
+        }, '');
+    }
+}
+exports.Module = Module;

package/dist/modules/typescript-parser/resources/Namespace.d.ts

@@ -0,0 +1,35 @@
+import { Declaration } from '../declarations/Declaration';
+import { Export } from '../exports/Export';
+import { Import } from '../imports/Import';
+import { Node } from '../Node';
+import { Resource } from './Resource';
+/**
+ * TypeScript resource. Declaration of a typescript namespace (i.e. declare foobar).
+ *
+ * @export
+ * @class Namespace
+ * @implements {Resource}
+ * @implements {Node}
+ */
+export declare class Namespace implements Resource, Node {
+    name: string;
+    start: number;
+    end: number;
+    imports: Import[];
+    exports: Export[];
+    declarations: Declaration[];
+    resources: Resource[];
+    usages: string[];
+    get identifier(): string;
+    get nonLocalUsages(): string[];
+    constructor(name: string, start: number, end: number);
+    /**
+     * Function that calculates the alias name of a namespace.
+     * Removes all underlines and dashes and camelcases the name.
+     *
+     * @returns {string}
+     *
+     * @memberof Namespace
+     */
+    getNamespaceAlias(): string;
+}

package/dist/modules/typescript-parser/resources/Namespace.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Namespace = void 0;
+const Module_1 = require("./Module");
+/**
+ * TypeScript resource. Declaration of a typescript namespace (i.e. declare foobar).
+ *
+ * @export
+ * @class Namespace
+ * @implements {Resource}
+ * @implements {Node}
+ */
+class Namespace {
+    constructor(name, start, end) {
+        this.name = name;
+        this.start = start;
+        this.end = end;
+        this.imports = [];
+        this.exports = [];
+        this.declarations = [];
+        this.resources = [];
+        this.usages = [];
+    }
+    get identifier() {
+        return this.name;
+    }
+    get nonLocalUsages() {
+        return this.usages
+            .filter(usage => !this.declarations.some(o => o.name === usage) &&
+            !this.resources.some(o => (o instanceof Module_1.Module || o instanceof Namespace) && o.name === usage))
+            .concat(this.resources.reduce((all, cur) => all.concat(cur.nonLocalUsages), []));
+    }
+    /**
+     * Function that calculates the alias name of a namespace.
+     * Removes all underlines and dashes and camelcases the name.
+     *
+     * @returns {string}
+     *
+     * @memberof Namespace
+     */
+    getNamespaceAlias() {
+        return this.name.split(/[-_]/).reduce((all, cur, idx) => {
+            if (idx === 0) {
+                return all + cur.toLowerCase();
+            }
+            return all + cur.charAt(0).toUpperCase() + cur.substring(1).toLowerCase();
+        }, '');
+    }
+}
+exports.Namespace = Namespace;

package/dist/modules/typescript-parser/resources/Resource.d.ts

@@ -0,0 +1,64 @@
+import { Declaration } from '../declarations/Declaration';
+import { Export } from '../exports/Export';
+import { Import } from '../imports/Import';
+/**
+ * Base interface for resources. All resources share the same properties.
+ * Resources are files, namespaces or modules.
+ *
+ * @export
+ * @interface Resource
+ */
+export interface Resource {
+    /**
+     * List of imports contained in this resource.
+     *
+     * @type {Import[]}
+     * @memberof Resource
+     */
+    imports: Import[];
+    /**
+     * List of exports contained in this resource.
+     *
+     * @type {Export[]}
+     * @memberof Resource
+     */
+    exports: Export[];
+    /**
+     * List of declarations that are contained in this resource.
+     *
+     * @type {Declaration[]}
+     * @memberof Resource
+     */
+    declarations: Declaration[];
+    /**
+     * List of subresources (like namespaces in a file) of this resource.
+     *
+     * @type {Resource[]}
+     * @memberof Resource
+     */
+    resources: Resource[];
+    /**
+     * List of used identifiers in this resource.
+     * (i.e. actual used string identifiers to calculate missing imports and stuff.)
+     *
+     * @type {string[]}
+     * @memberof Resource
+     */
+    usages: string[];
+    /**
+     * "Unique" identifier for this resource. Can be the filepath for files or
+     * node identifiers for node modules.
+     *
+     * @type {string}
+     * @memberof Resource
+     */
+    readonly identifier: string;
+    /**
+     * Returns an array of usages (a usage is a used symbol name in the resource)
+     * that are not covered by its own declarations.
+     *
+     * @type {string[]}
+     * @memberof Resource
+     */
+    readonly nonLocalUsages: string[];
+}

package/dist/modules/typescript-parser/resources/Resource.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/typescript-parser/resources/index.d.ts

@@ -0,0 +1,4 @@
+export * from './File';
+export * from './Module';
+export * from './Namespace';
+export * from './Resource';

package/dist/modules/typescript-parser/resources/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./File"), exports);
+tslib_1.__exportStar(require("./Module"), exports);
+tslib_1.__exportStar(require("./Namespace"), exports);
+tslib_1.__exportStar(require("./Resource"), exports);

package/dist/modules/typescript-parser/type-guards/TypescriptGuards.d.ts

@@ -0,0 +1,153 @@
+import { ArrayBindingPattern, ConstructorDeclaration, ExportDeclaration, ExternalModuleReference, FunctionDeclaration, GetAccessorDeclaration, Identifier, ImportDeclaration, ImportEqualsDeclaration, MethodDeclaration, MethodSignature, NamedExports, NamedImports, NamespaceImport, Node, ObjectBindingPattern, PropertyDeclaration, PropertySignature, SetAccessorDeclaration, StringLiteral } from 'typescript';
+/**
+ * Determines if the given node is an ImportDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is ImportDeclaration}
+ */
+export declare function isImportDeclaration(node?: Node): node is ImportDeclaration;
+/**
+ * Determines if the given node is an ImportEqualsDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is ImportEqualsDeclaration}
+ */
+export declare function isImportEqualsDeclaration(node?: Node): node is ImportEqualsDeclaration;
+/**
+ * Determines if the given node is a NamespaceImport.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is NamespaceImport}
+ */
+export declare function isNamespaceImport(node?: Node): node is NamespaceImport;
+/**
+ * Determines if the given node are NamedImports.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is NamedImports}
+ */
+export declare function isNamedImports(node?: Node): node is NamedImports;
+/**
+ * Determines if the given node are NamedExports.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is NamedExports}
+ */
+export declare function isNamedExports(node?: Node): node is NamedExports;
+/**
+ * Determines if the given node is a StringLiteral.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is StringLiteral}
+ */
+export declare function isStringLiteral(node?: Node): node is StringLiteral;
+/**
+ * Determines if the given node is an Identifier.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is Identifier}
+ */
+export declare function isIdentifier(node?: Node): node is Identifier;
+/**
+ * Determines if the given node is an ExternalModuleReference.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is ExternalModuleReference}
+ */
+export declare function isExternalModuleReference(node?: Node): node is ExternalModuleReference;
+/**
+ * Determines if the given node is an ExportDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is ExportDeclaration}
+ */
+export declare function isExportDeclaration(node?: Node): node is ExportDeclaration;
+/**
+ * Determines if the given node is an ObjectBindingPattern (i.e. let {x, y} = foo).
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is ObjectBindingPattern}
+ */
+export declare function isObjectBindingPattern(node?: Node): node is ObjectBindingPattern;
+/**
+ * Determines if the given node is an ArrayBindingPattern (i.e. let [x, y] = foo).
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is ArrayBindingPattern}
+ */
+export declare function isArrayBindingPattern(node?: Node): node is ArrayBindingPattern;
+/**
+ * Determines if the given node is a FunctionDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is FunctionDeclaration}
+ */
+export declare function isFunctionDeclaration(node?: Node): node is FunctionDeclaration;
+/**
+ * Determines if the given node is a MethodSignature.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is MethodSignature}
+ */
+export declare function isMethodSignature(node?: Node): node is MethodSignature;
+/**
+ * Determines if the given node is a PropertySignature.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is PropertySignature}
+ */
+export declare function isPropertySignature(node?: Node): node is PropertySignature;
+/**
+ * Determines if the given node is a MethodDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is MethodDeclaration}
+ */
+export declare function isMethodDeclaration(node?: Node): node is MethodDeclaration;
+/**
+ * Determines if the given node is a PropertyDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is PropertyDeclaration}
+ */
+export declare function isPropertyDeclaration(node?: Node): node is PropertyDeclaration;
+/**
+ * Determines if the given node is a ConstructorDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is ConstructorDeclaration}
+ */
+export declare function isConstructorDeclaration(node?: Node): node is ConstructorDeclaration;
+/**
+ * Determines if the given node is a isGetAccessorDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is isGetAccessorDeclaration}
+ */
+export declare function isGetAccessorDeclaration(node?: Node): node is GetAccessorDeclaration;
+/**
+ * Determines if the given node is a SetAccessorDeclaration.
+ *
+ * @export
+ * @param {Node} [node]
+ * @returns {node is SetAccessorDeclaration}
+ */
+export declare function isSetAccessorDeclaration(node?: Node): node is SetAccessorDeclaration;