ts2famix 1.0.1

package/test/propertyWithDecorators.test.ts

@@ -0,0 +1,80 @@
+import { Importer } from '../src/analyze';
+import { Decorator } from '../src/lib/famix/src/model/famix/decorator';
+import { Property } from '../src/lib/famix/src/model/famix/property';
+
+const importer = new Importer();
+
+const fmxRep = importer.famixRepFromSource("propertyWithDecorators",
+    'import "reflect-metadata";\n\
+\n\
+const formatMetadataKey = Symbol("format");\n\
+\n\
+function format(formatString: string) {\n\
+    return Reflect.metadata(formatMetadataKey, formatString);\n\
+}\n\
+\n\
+function getFormat(target: any, propertyKey: string) {\n\
+    return Reflect.getMetadata(formatMetadataKey, target, propertyKey);\n\
+}\n\
+\n\
+function deco(bo: boolean) {\n\
+    return function(target: any, propertyKey: string) { // no property descriptor in the signature of the property decorator\n\
+        console.log(bo);\n\
+    };\n\
+}\n\
+\n\
+var h = format("Hello, %s");\n\
+var o = deco(true);\n\
+var t = deco;\n\
+\n\
+class Greeter {\n\
+    @deco(true)\n\
+    @h\n\
+    @o\n\
+    @t(false)\n\
+    @format("Hello, %s")\n\
+    greeting: string;\n\
+    \n\
+    constructor(message: string) {\n\
+        this.greeting = message;\n\
+    }\n\
+    \n\
+    greet() {\n\
+        let formatString = getFormat(this, "greeting");\n\
+        return formatString.replace("%s", this.greeting);\n\
+    }\n\
+}\n\
+');
+
+describe('Tests for property with decorators', () => {
+    
+    it("should contain one class", () => {
+        expect(fmxRep._getAllEntitiesWithType("Class").size).toBe(1);
+    });
+
+    it("should contain a property 'greeting'", () => {
+        expect(fmxRep._getAllEntitiesWithType("Property").size).toBe(1);
+        const theProperty = (Array.from(fmxRep._getFamixClass("Greeter")?.getProperties() as Set<Property>) as Array<Property>).find((f) => f.getName() === "greeting");
+        expect(theProperty).toBeTruthy();
+    });
+
+    it("should contain five decorators", () => {
+        expect(fmxRep._getAllEntitiesWithType("Decorator").size).toBe(5);
+    });
+
+    const theProperty = (Array.from(fmxRep._getFamixClass("Greeter")?.getProperties() as Set<Property>) as Array<Property>).find((f) => f.getName() === "greeting");
+    const d1 = (Array.from(fmxRep._getAllEntitiesWithType("Decorator")) as Array<Decorator>).find((d) => d.getName() === "@deco");
+    const d2 = (Array.from(fmxRep._getAllEntitiesWithType("Decorator")) as Array<Decorator>).find((d) => d.getName() === "@h");
+    const d3 = (Array.from(fmxRep._getAllEntitiesWithType("Decorator")) as Array<Decorator>).find((d) => d.getName() === "@o");
+    const d4 = (Array.from(fmxRep._getAllEntitiesWithType("Decorator")) as Array<Decorator>).find((d) => d.getName() === "@t");
+    const d5 = (Array.from(fmxRep._getAllEntitiesWithType("Decorator")) as Array<Decorator>).find((d) => d.getName() === "@format");
+
+    it("should contain a property with five decorators", () => {
+        expect(theProperty?.getDecorators().size).toBe(5);
+        expect(d1?.getDecoratedEntity()).toBe(theProperty);
+        expect(d2?.getDecoratedEntity()).toBe(theProperty);
+        expect(d3?.getDecoratedEntity()).toBe(theProperty);
+        expect(d4?.getDecoratedEntity()).toBe(theProperty);
+        expect(d5?.getDecoratedEntity()).toBe(theProperty);
+    });
+});

package/test/sample.test.ts

@@ -0,0 +1,13 @@
+import { Importer } from '../src/analyze';
+
+const filePaths = ["test_src/sample.ts"];
+const importer = new Importer();
+
+const fmxRep = importer.famixRepFromPaths(filePaths);
+
+describe('Tests for sample', () => {
+    
+    it("should parse generics", () => {
+        expect(fmxRep).toBeTruthy();
+    });
+});

package/test/simpleFunction.test.ts

@@ -0,0 +1,32 @@
+import { Importer } from '../src/analyze';
+import { Function } from "../src/lib/famix/src/model/famix/function";
+
+const importer = new Importer();
+
+const fmxRep = importer.famixRepFromSource("simpleFunction", 
+    'function fct(): number {\n\
+    return 0;\n\
+}\n\
+');
+
+describe('Tests for simple function', () => {
+    
+    const functionList = fmxRep._getAllEntitiesWithType('Function');
+    it("should have one function", () => {
+        expect(functionList?.size).toBe(1);
+    });
+
+    const theFunction = Array.from(functionList)[0] as Function;
+    it("should contain a function 'fct'", () => {
+        expect(theFunction).toBeTruthy();
+        expect(theFunction?.getName()).toBe('fct');
+    });
+
+    it("should return number", () => {
+        expect(theFunction?.getDeclaredType().getName()).toBe("number");
+    });
+
+    it("should have no parameter", () => {
+        expect(theFunction?.getParameters().size).toBe(0);
+    });
+});

package/test/simpleTest.test.ts

@@ -0,0 +1,18 @@
+import { Importer } from '../src/analyze';
+import { ScriptEntity } from '../src/lib/famix/src/model/famix/script_entity';
+
+const importer = new Importer();
+
+const fmxRep = importer.famixRepFromSource("simpleTest", 
+    'console.log("Hello");\n\
+');
+
+describe('Tests for simple test', () => {
+    
+    const scriptEntityList = Array.from(fmxRep._getAllEntitiesWithType('ScriptEntity')) as Array<ScriptEntity>;
+    const theFile = scriptEntityList.find(e => e.getName() === 'simpleTest.ts');
+    it("should have one file", () => {
+        expect(scriptEntityList?.length).toBe(1);
+        expect(theFile).toBeTruthy();
+    });
+});

package/test/simpleTest2.test.ts

@@ -0,0 +1,36 @@
+import { Importer } from '../src/analyze';
+import { Access } from '../src/lib/famix/src/model/famix/access';
+import { ScriptEntity } from '../src/lib/famix/src/model/famix/script_entity';
+import { Variable } from '../src/lib/famix/src/model/famix/variable';
+
+const importer = new Importer();
+
+const fmxRep = importer.famixRepFromSource("simpleTest2", 
+    'var a: number = 10;\n\
+    \n\
+console.log(a);\n\
+');
+
+describe('Tests for simple test 2', () => {
+    
+    const scriptEntityList = Array.from(fmxRep._getAllEntitiesWithType('ScriptEntity')) as Array<ScriptEntity>;
+    const theFile = scriptEntityList.find(e => e.getName() === 'simpleTest2.ts');
+    it("should have one file", () => {
+        expect(scriptEntityList?.length).toBe(1);
+        expect(theFile).toBeTruthy();
+    });
+
+    const variableList = Array.from(fmxRep._getAllEntitiesWithType('Variable')) as Array<Variable>;
+    const theVariable = variableList.find(e => e.getName() === 'a');
+    it("should have one variable", () => {
+        expect(scriptEntityList?.length).toBe(1);
+        expect(theVariable).toBeTruthy();
+    });
+    
+    const accessList = Array.from(fmxRep._getAllEntitiesWithType('Access')) as Array<Access>;
+    const theAccess = accessList.find(e => e.getVariable() === theVariable && e.getAccessor() === theFile);
+    it("should have one access", () => {
+        expect(accessList?.length).toBe(1);
+        expect(theAccess).toBeTruthy();
+    });   
+});

package/test/types.test.ts

@@ -0,0 +1,58 @@
+import { Importer } from '../src/analyze';
+import { ParameterizedType } from '../src/lib/famix/src/model/famix/parameterized_type';
+import { PrimitiveType } from '../src/lib/famix/src/model/famix/primitive_type';
+import { Type } from '../src/lib/famix/src/model/famix/type';
+
+const importer = new Importer();
+
+const fmxRep = importer.famixRepFromSource("types", 
+    'let a: string;\n\
+let b: number;\n\
+let c: Map<any, boolean>;\n\
+class A {}\n\
+let d = new A();\n\
+');
+
+describe('Tests for types', () => {
+    
+    it("should contain one class", () => {
+        expect(fmxRep._getAllEntitiesWithType("Class").size).toBe(1);
+        expect(fmxRep._getFamixClass("A")).toBeTruthy();
+    });
+
+    it("should contain three types, three primitive types and one parameterized type", () => {
+        expect(fmxRep._getAllEntitiesWithType("Type").size).toBe(3);
+        expect(Array.from(fmxRep._getAllEntitiesWithType("Type") as Set<Type>).find(t => t.getName() === "Map")).toBeTruthy();
+        expect(Array.from(fmxRep._getAllEntitiesWithType("Type") as Set<Type>).find(t => t.getName() === "any")).toBeTruthy();
+        expect(Array.from(fmxRep._getAllEntitiesWithType("Type") as Set<Type>).find(t => t.getName() === "A")).toBeTruthy();
+        expect(fmxRep._getAllEntitiesWithType("PrimitiveType").size).toBe(3);
+        expect(Array.from(fmxRep._getAllEntitiesWithType("PrimitiveType") as Set<PrimitiveType>).find(t => t.getName() === "string")).toBeTruthy();
+        expect(Array.from(fmxRep._getAllEntitiesWithType("PrimitiveType") as Set<PrimitiveType>).find(t => t.getName() === "number")).toBeTruthy();
+        expect(Array.from(fmxRep._getAllEntitiesWithType("PrimitiveType") as Set<PrimitiveType>).find(t => t.getName() === "boolean")).toBeTruthy();
+        expect(Array.from(fmxRep._getAllEntitiesWithType("PrimitiveType") as Set<PrimitiveType>).find(t => t.getName() === "string")?.getIsStub()).toBe(true);
+        expect(Array.from(fmxRep._getAllEntitiesWithType("PrimitiveType") as Set<PrimitiveType>).find(t => t.getName() === "number")?.getIsStub()).toBe(true);
+        expect(Array.from(fmxRep._getAllEntitiesWithType("PrimitiveType") as Set<PrimitiveType>).find(t => t.getName() === "boolean")?.getIsStub()).toBe(true);
+        expect(fmxRep._getAllEntitiesWithType("ParameterizedType").size).toBe(1);
+        expect(Array.from(fmxRep._getAllEntitiesWithType("ParameterizedType") as Set<ParameterizedType>).find(t => t.getName() === "Map<any, boolean>")).toBeTruthy();
+    });
+
+    it("should have types.ts for container", () => {
+        const theFile = fmxRep._getFamixFile("types.ts");
+        expect(Array.from(fmxRep._getAllEntitiesWithType("Type") as Set<Type>)[0].getContainer()).toBe(theFile);
+    });
+
+    it("should have Map for base type of Map<any, boolean>", () => {
+        const theBaseType = Array.from(fmxRep._getAllEntitiesWithType("Type") as Set<Type>).find(t => t.getName() === "Map");
+        const theParameterizedType = Array.from(fmxRep._getAllEntitiesWithType("ParameterizedType") as Set<ParameterizedType>).find(t => t.getName() === "Map<any, boolean>");
+        expect(theParameterizedType?.getBaseType()).toBe(theBaseType);
+    });
+
+    it("should have any and boolean for arguments of Map<any, boolean>", () => {
+        const theAnyType = Array.from(fmxRep._getAllEntitiesWithType("Type") as Set<Type>).find(t => t.getName() === "any");
+        const theBooleanType = Array.from(fmxRep._getAllEntitiesWithType("PrimitiveType") as Set<PrimitiveType>).find(t => t.getName() === "boolean");
+        const theParameterizedType = Array.from(fmxRep._getAllEntitiesWithType("ParameterizedType") as Set<ParameterizedType>).find(t => t.getName() === "Map<any, boolean>");
+        expect(theParameterizedType?.getArguments().size).toBe(2);
+        expect(Array.from(theParameterizedType?.getArguments() as Set<Type>)[0]).toBe(theAnyType);
+        expect(Array.from(theParameterizedType?.getArguments() as Set<Type>)[1]).toBe(theBooleanType);
+    });
+});

package/test_src/sample.ts

@@ -0,0 +1,103 @@
+var x = "hello";
+
+export class ClassA {
+    aFred: number;
+    aWilma: "green" | "blue" | 12;
+    aMethod1(aMethodArg1: string) {
+        return aMethodArg1 + "!";
+        function fInAMethod() {
+            function fInfInAMethod() {
+                var w = 0;
+            }
+        }
+    }    
+}
+
+namespace ANamespace {
+    var w = 15;
+    let x;
+    x = w;
+    class B {
+        bFred: number;
+        bWilma: "yellow" | "red";
+        bMethod1(bMethodArg1: number) {
+            let varInBMethod;
+            return bMethodArg1 + 1;
+            function fInBMethod() {
+                let varInFInBMethod;
+                function fInfInBMethod() {
+                    var w = 0;
+                }
+            }
+        }
+    }
+    let b = new B();
+}
+
+export const y = 12.5;
+
+function f() {
+    var k = 0;
+    { var blockVar = 66; }
+    switch (k) {
+        case 0:
+            var kSwitchCase = 99;
+            break;
+        default:
+            var kSwitchDefault = 90;
+    }
+    if (true) {
+        var ifBlockL = 12;
+    }
+    let cond = true;
+    do {
+        var doBlockL = 8;
+        cond = false;
+    } while (cond);
+    try {
+        var tryBlockL = 1;
+    } catch (error) {
+        var catchBlockL = 12;
+    }
+    while (false) {
+        var kWhile = 9;
+    }
+    let array = [1, 2, 3];
+    for (let forIndex = 0; forIndex < array.length; forIndex++) {
+        const elementInFor = array[forIndex];
+    }
+    let object = {};
+    for (const key in object) {
+        if (Object.prototype.hasOwnProperty.call(object, key)) {
+            const elementInForIn = object[key];
+        }
+    }
+    for (const iterator of array) {
+        let elementInForOf = "blah";
+    }
+    g();
+
+    function g() {
+        var a_G: string;
+        h();
+
+        function h() {
+            var a_H: string;
+            i();
+
+            function i() {
+                var a_I: string;
+
+                console.info("Hello");
+
+                try {
+                    let tryX = 0;
+                } catch (error) {
+                    let catchY = 15;
+                } finally {
+                    let finallyZ = 99;
+                }
+            }
+        }
+    }
+}

package/test_src/sampleForModule.ts

@@ -0,0 +1,10 @@
+class ClassZ {}
+class ClassY {}
+export class ClassX {}
+
+export { ClassZ, ClassY };
+export { Importer } from '../src/analyze';
+
+export default class ClassW {}
+
+export namespace Nsp {}

package/test_src/sampleForModule2.ts

@@ -0,0 +1,7 @@
+import * as Famix from "../src/lib/famix/src/model/famix";
+import { ClassDeclaration, ConstructorDeclaration } from "ts-morph";
+import { Importer } from "../test_src/sampleForModule";
+import { ClassZ } from "../test_src/sampleForModule";
+import Cls from "../test_src/sampleForModule";
+import { Nsp } from "../test_src/sampleForModule";
+import * as express from "express";

package/test_src/sampleForModule3.ts

@@ -0,0 +1,2 @@
+import { ClassX } from "express.ts";
+import * as test from "./sampleForModule.ts";

package/tsconfig.json

@@ -0,0 +1,70 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "ES2017",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist",                        /* Redirect output structure to the directory. */
+    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "incremental": true,                   /* Enable incremental compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": false,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/*.spec.ts"],
+  "typedocOptions": {
+    "entryPoints": ["src/*"],
+    "entryPointStrategy": "expand",
+    "out": "docs",
+    "githubPages": false
+  }
+}