ts2famix 1.0.13 → 1.0.15

package/package.json

@@ -1,47 +1,47 @@
-{
-  "name": "ts2famix",
-  "version": "1.0.13",
-  "description": "A TypeScript to JSON importer for Moose 10.",
-  "main": "dist/ts2famix-cli.js",
-  "scripts": {
-    "dev": "ts-node src/ts2famix-cli.ts",
-    "debug": "node --inspect-brk node_modules/.bin/ts-node",
-    "build": "tsc",
-    "test": "jest --colors --silent",
-    "local": "sudo npm i -g && ts2famix",
-    "refresh": "rm -rf ./node_modules ./package-lock.json && npm install",
-    "doc": "typedoc && touch docs/.gitkeep",
-    "coverage": "jest --colors --silent --coverage --coverageDirectory=coverage",
-    "uml": "./src/generate_uml.sh"
-  },
-  "bin": {
-    "ts2famix": "dist/ts2famix-cli.js"
-  },
-  "keywords": [],
-  "author": "",
-  "nodemonConfig": {
-    "ignore": [
-      "dist/*"
-    ]
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "@types/jest": "^29.5.4",
-    "@types/node": "^20.6.0",
-    "@types/yargs": "^17.0.24",
-    "@typescript-eslint/eslint-plugin": "^6.6.0",
-    "@typescript-eslint/parser": "^6.6.0",
-    "eslint": "^8.49.0",
-    "jest": "^29.6.4",
-    "tplant": "^3.1.2",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "typedoc": "^0.25.1",
-    "typescript": "^5.2.2"
-  },
-  "dependencies": {
-    "ts-morph": "^19.0.0",
-    "tsutils": "^3.21.0",
-    "yargs": "^17.7.2"
-  }
-}
+{
+  "name": "ts2famix",
+  "version": "1.0.15",
+  "description": "A TypeScript to JSON importer for Moose 10.",
+  "main": "dist/ts2famix-cli.js",
+  "scripts": {
+    "dev": "ts-node src/ts2famix-cli.ts",
+    "debug": "node --inspect-brk node_modules/.bin/ts-node",
+    "build": "tsc",
+    "test": "jest --colors --silent",
+    "local": "sudo npm i -g && ts2famix",
+    "refresh": "rm -rf ./node_modules ./package-lock.json && npm install",
+    "doc": "typedoc && touch docs/.gitkeep",
+    "coverage": "jest --colors --silent --coverage --coverageDirectory=coverage",
+    "uml": "./src/generate_uml.sh"
+  },
+  "bin": {
+    "ts2famix": "dist/ts2famix-cli.js"
+  },
+  "keywords": [],
+  "author": "",
+  "nodemonConfig": {
+    "ignore": [
+      "dist/*"
+    ]
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.4",
+    "@types/node": "^20.6.0",
+    "@types/yargs": "^17.0.24",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "eslint": "^8.49.0",
+    "jest": "^29.6.4",
+    "tplant": "^3.1.2",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.25.1",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "ts-morph": "^19.0.0",
+    "tsutils": "^3.21.0",
+    "yargs": "^17.7.2"
+  }
+}

package/src/analyze.ts

@@ -1,94 +1,94 @@
-import { Project } from "ts-morph";
-import * as fs from 'fs';
-import { FamixRepository } from "./lib/famix/src/famix_repository";
-import { FamixFunctions } from "./famix_functions/famix_functions";
-import { ProcessFiles } from "./analyze_functions/processFiles";
-import { ProcessAccesses } from "./analyze_functions/processAccesses";
-import { ProcessInvocations } from "./analyze_functions/processInvocations";
-import { ProcessInheritances } from "./analyze_functions/processInheritances";
-import { ProcessImportClauses } from "./analyze_functions/processImportClauses";
-
-/**
- * This class is used to build a Famix model from a TypeScript source code
- */
-export class Importer {
-
-    private project = new Project(); // The project containing the source files to analyze
-    private famixFunctions = new FamixFunctions(); // FamixFunctions object, it contains all the functions needed to create Famix entities
-    private processFiles = new ProcessFiles(this.famixFunctions); // ProcessFiles object, it contains all the functions needed to process the source files
-    private processAccesses = new ProcessAccesses(this.famixFunctions); // ProcessAccesses object, it contains all the functions needed to process the accesses
-    private processInvocations = new ProcessInvocations(this.famixFunctions); // ProcessInvocations object, it contains all the functions needed to process the invocations
-    private processInheritances = new ProcessInheritances(this.famixFunctions); // ProcessInheritances object, it contains all the functions needed to process the inheritances
-    private processImportClauses = new ProcessImportClauses(this.famixFunctions); // ProcessImportClauses object, it contains all the functions needed to process the import clauses
-
-    /**
-     * Main method
-     * @param paths An array of paths to the source files to analyze
-     * @returns The Famix repository containing the Famix model
-     */
-    public famixRepFromPaths(paths: Array<string>): FamixRepository {
-
-//        try {
-        console.info(`famixRepFromPaths: paths: ${paths}`);
-        this.project.addSourceFilesAtPaths(paths);
-        this.processEntities(this.project);
-
-        const famixRep = this.famixFunctions.getFamixRepository();
-//        }
-//        catch (error) {
-            // console.error(`> ERROR: got exception ${error}. Exiting...`);
-            // console.error(error.message);
-            // console.error(error.stack);
-            // process.exit(1);
-//        }
-
-        return famixRep;
-    }
-
-    private processEntities(project) {
-        this.processFiles.processFiles(project.getSourceFiles());
-        const accesses = this.processFiles.getAccesses();
-        const methodsAndFunctionsWithId = this.processFiles.getMethodsAndFunctionsWithId();
-        const classes = this.processFiles.getClasses();
-        const interfaces = this.processFiles.getInterfaces();
-        const modules = this.processFiles.getModules();
-        const exports = this.processFiles.getExports();
-
-        this.processImportClauses.processImportClauses(modules, exports);
-        this.processAccesses.processAccesses(accesses);
-        this.processInvocations.processInvocations(methodsAndFunctionsWithId);
-        this.processInheritances.processInheritances(classes, interfaces);
-    }
-
-    /**
-     * Main method for tests
-     *
-     * @param filename The name of the file to analyze
-     * @param source A TypeScript source code
-     * @returns The Famix repository containing the Famix model
-     */
-    // TODO: this is slow because it writes the source code to a file and then reads it again - it's possible to just pass the source code to the ts-morph project
-    public famixRepFromSource(filename: string, source: string): FamixRepository {
-        const filePath = `./test_src/${filename}.ts`;
-
-        fs.writeFileSync(filePath, source, 'utf-8');
-
-        const famixRep = this.famixRepFromPaths([filePath]);
-
-        return famixRep;
-    }
-
-    /**
-     * Main method for a ts-morph project
-     * @param project A ts-morph project
-     * @returns The Famix repository containing the Famix model
-     */
-    public famixRepFromProject(project: Project): FamixRepository {
-        //const sourceFileNames = project.getSourceFiles().map(f => f.getFilePath()) as Array<string>;
-
-        //const famixRep = this.famixRepFromPaths(sourceFileNames);
-        this.processEntities(project);
-
-        return this.famixFunctions.getFamixRepository();
-    }
-}
+import { Project } from "ts-morph";
+import * as fs from 'fs';
+import { FamixRepository } from "./lib/famix/src/famix_repository";
+import { FamixFunctions } from "./famix_functions/famix_functions";
+import { ProcessFiles } from "./analyze_functions/processFiles";
+import { ProcessAccesses } from "./analyze_functions/processAccesses";
+import { ProcessInvocations } from "./analyze_functions/processInvocations";
+import { ProcessInheritances } from "./analyze_functions/processInheritances";
+import { ProcessImportClauses } from "./analyze_functions/processImportClauses";
+
+/**
+ * This class is used to build a Famix model from a TypeScript source code
+ */
+export class Importer {
+
+    private project = new Project(); // The project containing the source files to analyze
+    private famixFunctions = new FamixFunctions(); // FamixFunctions object, it contains all the functions needed to create Famix entities
+    private processFiles = new ProcessFiles(this.famixFunctions); // ProcessFiles object, it contains all the functions needed to process the source files
+    private processAccesses = new ProcessAccesses(this.famixFunctions); // ProcessAccesses object, it contains all the functions needed to process the accesses
+    private processInvocations = new ProcessInvocations(this.famixFunctions); // ProcessInvocations object, it contains all the functions needed to process the invocations
+    private processInheritances = new ProcessInheritances(this.famixFunctions); // ProcessInheritances object, it contains all the functions needed to process the inheritances
+    private processImportClauses = new ProcessImportClauses(this.famixFunctions); // ProcessImportClauses object, it contains all the functions needed to process the import clauses
+
+    /**
+     * Main method
+     * @param paths An array of paths to the source files to analyze
+     * @returns The Famix repository containing the Famix model
+     */
+    public famixRepFromPaths(paths: Array<string>): FamixRepository {
+
+//        try {
+        console.info(`famixRepFromPaths: paths: ${paths}`);
+        this.project.addSourceFilesAtPaths(paths);
+        this.processEntities(this.project);
+
+        const famixRep = this.famixFunctions.getFamixRepository();
+//        }
+//        catch (error) {
+            // console.error(`> ERROR: got exception ${error}. Exiting...`);
+            // console.error(error.message);
+            // console.error(error.stack);
+            // process.exit(1);
+//        }
+
+        return famixRep;
+    }
+
+    private processEntities(project) {
+        this.processFiles.processFiles(project.getSourceFiles());
+        const accesses = this.processFiles.getAccesses();
+        const methodsAndFunctionsWithId = this.processFiles.getMethodsAndFunctionsWithId();
+        const classes = this.processFiles.getClasses();
+        const interfaces = this.processFiles.getInterfaces();
+        const modules = this.processFiles.getModules();
+        const exports = this.processFiles.getExports();
+
+        this.processImportClauses.processImportClauses(modules, exports);
+        this.processAccesses.processAccesses(accesses);
+        this.processInvocations.processInvocations(methodsAndFunctionsWithId);
+        this.processInheritances.processInheritances(classes, interfaces);
+    }
+
+    /**
+     * Main method for tests
+     *
+     * @param filename The name of the file to analyze
+     * @param source A TypeScript source code
+     * @returns The Famix repository containing the Famix model
+     */
+    // TODO: this is slow because it writes the source code to a file and then reads it again - it's possible to just pass the source code to the ts-morph project
+    public famixRepFromSource(filename: string, source: string): FamixRepository {
+        const filePath = `./test_src/${filename}.ts`;
+
+        fs.writeFileSync(filePath, source, 'utf-8');
+
+        const famixRep = this.famixRepFromPaths([filePath]);
+
+        return famixRep;
+    }
+
+    /**
+     * Main method for a ts-morph project
+     * @param project A ts-morph project
+     * @returns The Famix repository containing the Famix model
+     */
+    public famixRepFromProject(project: Project): FamixRepository {
+        //const sourceFileNames = project.getSourceFiles().map(f => f.getFilePath()) as Array<string>;
+
+        //const famixRep = this.famixRepFromPaths(sourceFileNames);
+        this.processEntities(project);
+
+        return this.famixFunctions.getFamixRepository();
+    }
+}

package/src/analyze_functions/processAccesses.ts

@@ -1,57 +1,57 @@
-import { Identifier, ParameterDeclaration, VariableDeclaration, PropertyDeclaration, EnumMember } from "ts-morph";
-import { FamixFunctions } from "../famix_functions/famix_functions";
-
-/**
- * This class is used to build a Famix model for the accesses
- */
-export class ProcessAccesses {
-
-    private famixFunctions: FamixFunctions; // FamixFunctions object, it contains all the functions needed to create Famix entities
-
-    /**
-     * Initializes the ProcessAccesses object
-     * @param famixFunctions FamixFunctions object, it contains all the functions needed to create Famix entities
-     */
-    constructor(famixFunctions: FamixFunctions) {
-        this.famixFunctions = famixFunctions;
-    }
-
-    /**
-     * Builds a Famix model for the accesses on the parameters, variables, properties and enum members of the source files
-     * @param accessMap A map of parameters, variables, properties and enum members with their id
-     */
-    public processAccesses(accessMap: Map<number, ParameterDeclaration | VariableDeclaration | PropertyDeclaration | EnumMember>): void {
-        console.info(`processAccesses: Creating accesses:`);
-        accessMap.forEach((v, id) => {
-            console.info(`processAccesses: Accesses to ${v.getName()}`);
-            try {
-                const temp_nodes = v.findReferencesAsNodes() as Array<Identifier>;
-                temp_nodes.forEach(node => this.processNodeForAccesses(node, id));
-            } catch (error) {
-                console.error(`> WARNING: got exception ${error}. Continuing...`);
-            }
-        });
-    }
-
-    /**
-     * Builds a Famix model for an access on a parameter, variable, property or enum member
-     * @param n A node
-     * @param id An id of a parameter, a variable, a property or an enum member
-     */
-    private processNodeForAccesses(n: Identifier, id: number): void {
-        try {
-            // sometimes node's first ancestor is a PropertyDeclaration, which is not an access
-            // see https://github.com/fuhrmanator/FamixTypeScriptImporter/issues/9
-            // check for a node whose first ancestor is a property declaration and bail?
-            // This may be a bug in ts-morph?
-            if (n.getFirstAncestorOrThrow().getKindName() === "PropertyDeclaration") {
-                console.info(`processNodeForAccesses: node kind: ${n.getKindName()}, ${n.getText()}, (${n.getType().getText()})'s first ancestor is a PropertyDeclaration. Skipping...`);
-                return;
-            }
-            this.famixFunctions.createFamixAccess(n, id);
-            console.info(`processNodeForAccesses: node kind: ${n.getKindName()}, ${n.getText()}, (${n.getType().getText()})`);
-        } catch (error) {
-            console.error(`> WARNING: got exception ${error}. ScopeDeclaration invalid for ${n.getSymbol().getFullyQualifiedName()}. Continuing...`);
-        }
-    }
-}
+import { Identifier, ParameterDeclaration, VariableDeclaration, PropertyDeclaration, EnumMember } from "ts-morph";
+import { FamixFunctions } from "../famix_functions/famix_functions";
+
+/**
+ * This class is used to build a Famix model for the accesses
+ */
+export class ProcessAccesses {
+
+    private famixFunctions: FamixFunctions; // FamixFunctions object, it contains all the functions needed to create Famix entities
+
+    /**
+     * Initializes the ProcessAccesses object
+     * @param famixFunctions FamixFunctions object, it contains all the functions needed to create Famix entities
+     */
+    constructor(famixFunctions: FamixFunctions) {
+        this.famixFunctions = famixFunctions;
+    }
+
+    /**
+     * Builds a Famix model for the accesses on the parameters, variables, properties and enum members of the source files
+     * @param accessMap A map of parameters, variables, properties and enum members with their id
+     */
+    public processAccesses(accessMap: Map<number, ParameterDeclaration | VariableDeclaration | PropertyDeclaration | EnumMember>): void {
+        console.info(`processAccesses: Creating accesses:`);
+        accessMap.forEach((v, id) => {
+            console.info(`processAccesses: Accesses to ${v.getName()}`);
+            try {
+                const temp_nodes = v.findReferencesAsNodes() as Array<Identifier>;
+                temp_nodes.forEach(node => this.processNodeForAccesses(node, id));
+            } catch (error) {
+                console.error(`> WARNING: got exception ${error}. Continuing...`);
+            }
+        });
+    }
+
+    /**
+     * Builds a Famix model for an access on a parameter, variable, property or enum member
+     * @param n A node
+     * @param id An id of a parameter, a variable, a property or an enum member
+     */
+    private processNodeForAccesses(n: Identifier, id: number): void {
+        try {
+            // sometimes node's first ancestor is a PropertyDeclaration, which is not an access
+            // see https://github.com/fuhrmanator/FamixTypeScriptImporter/issues/9
+            // check for a node whose first ancestor is a property declaration and bail?
+            // This may be a bug in ts-morph?
+            if (n.getFirstAncestorOrThrow().getKindName() === "PropertyDeclaration") {
+                console.info(`processNodeForAccesses: node kind: ${n.getKindName()}, ${n.getText()}, (${n.getType().getText()})'s first ancestor is a PropertyDeclaration. Skipping...`);
+                return;
+            }
+            this.famixFunctions.createFamixAccess(n, id);
+            console.info(`processNodeForAccesses: node kind: ${n.getKindName()}, ${n.getText()}, (${n.getType().getText()})`);
+        } catch (error) {
+            console.error(`> WARNING: got exception ${error}. ScopeDeclaration invalid for ${n.getSymbol().getFullyQualifiedName()}. Continuing...`);
+        }
+    }
+}