ts2famix 2.0.3 → 2.1.0-beta.1

package/package.json

@@ -1,66 +1,70 @@
-{
-  "name": "ts2famix",
-  "version": "2.0.3",
-  "description": "A TypeScript to JSON importer for Moose.",
-  "main": "dist/ts2famix-cli.js",
-  "scripts": {
-    "dev": "ts-node src/ts2famix-cli.ts",
-    "debug": "node --inspect-brk node_modules/.bin/ts-node",
-    "build": "tsc",
-    "check-tests": "tsc --project tsconfig.check-tests.json",
-    "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-wrapper.js"
-  },
-  "keywords": [
-    "TypeScript",
-    "famix",
-    "static analysis",
-    "moose"
-  ],
-  "author": "Christopher Fuhrman <christopher.fuhrman@etsmtl.ca>",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/fuhrmanator/FamixTypeScriptImporter.git"
-  },
-  "bugs": {
-    "url": "https://github.com/fuhrmanator/FamixTypeScriptImporter/issues"
-  },
-  "homepage": "https://github.com/fuhrmanator/FamixTypeScriptImporter?tab=readme-ov-file#famixtypescriptimporter",
-  "nodemonConfig": {
-    "ignore": [
-      "dist/*"
-    ]
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "@types/jest": "^29.5.12",
-    "@types/node": "^22.3.0",
-    "@types/yargs": "^17.0.33",
-    "eslint": "^9.9.0",
-    "jest": "^29.7.0",
-    "tplant": "3.1.0",
-    "ts-jest": "^29.2.4",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.26.5"
-  },
-  "dependencies": {
-    "@types/lodash": "^4.17.7",
-    "grapheme-splitter": "^1.0.4",
-    "lodash": "^4.17.21",
-    "ts-morph": "^23.0.0",
-    "tslog": "^4.9.2",
-    "tsutils": "^3.21.0",
-    "typescript": "^5.5.4",
-    "yargs": "^17.7.2"
-  },
-  "engines": {
-    "node": ">=18.20.4"
-  }
-}
+{
+  "name": "ts2famix",
+  "version": "2.1.0-beta.1",
+  "description": "A TypeScript to JSON importer for Moose.",
+  "main": "dist/ts2famix-cli.js",
+  "scripts": {
+    "dev": "ts-node src/ts2famix-cli.ts",
+    "debug": "node --inspect-brk node_modules/.bin/ts-node",
+    "build": "tsc",
+    "check-tests": "tsc --project tsconfig.check-tests.json",
+    "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-wrapper.js"
+  },
+  "keywords": [
+    "TypeScript",
+    "famix",
+    "static analysis",
+    "moose"
+  ],
+  "author": "Christopher Fuhrman <christopher.fuhrman@etsmtl.ca>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fuhrmanator/FamixTypeScriptImporter.git"
+  },
+  "bugs": {
+    "url": "https://github.com/fuhrmanator/FamixTypeScriptImporter/issues"
+  },
+  "homepage": "https://github.com/fuhrmanator/FamixTypeScriptImporter?tab=readme-ov-file#famixtypescriptimporter",
+  "nodemonConfig": {
+    "ignore": [
+      "dist/*"
+    ]
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "^9.22.0",
+    "@types/jest": "^29.5.14",
+    "@types/lodash": "^4.17.16",
+    "@types/node": "^22.13.10",
+    "@types/yargs": "^17.0.33",
+    "eslint": "^9.22.0",
+    "globals": "^16.0.0",
+    "jest": "^29.7.0",
+    "jscpd": "^4.0.5",
+    "tplant": "^3.1.0",
+    "ts-jest": "^29.2.6",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.0",
+    "typescript-eslint": "^8.26.1"
+  },
+  "dependencies": {
+    "grapheme-splitter": "^1.0.4",
+    "lodash": "^4.17.21",
+    "ts-morph": "^25.0.1",
+    "tslog": "^4.9.2",
+    "tsutils": "^3.21.0",
+    "typescript": "^5.8.2",
+    "yargs": "^17.7.2"
+  },
+  "engines": {
+    "node": ">=18.20.4"
+  }
+}

package/sample.json

@@ -0,0 +1 @@
+[{"FM3":"FamixTypeScript.SourceLanguage","id":1,"sourcedEntities":[]},{"FM3":"FamixTypeScript.IndexedFileAnchor","id":2,"element":{"ref":3},"startPos":1,"endPos":13,"fileName":":/Users/Cris/Documents/GitHub/FamixTypeScriptImporter/sample.ts"},{"FM3":"FamixTypeScript.ScriptEntity","id":3,"sourceAnchor":{"ref":2},"comments":[],"incomingImports":[],"name":"sample.ts","decorators":[],"types":[{"ref":5}],"functions":[],"localVariables":[]},{"FM3":"FamixTypeScript.IndexedFileAnchor","id":4,"element":{"ref":5},"startPos":1,"endPos":11,"fileName":":/Users/Cris/Documents/GitHub/FamixTypeScriptImporter/sample.ts"},{"FM3":"FamixTypeScript.Class","id":5,"sourceAnchor":{"ref":4},"comments":[],"incomingImports":[],"name":"A","decorators":[],"types":[],"functions":[],"localVariables":[],"incomingReferences":[],"isAbstract":false,"attributes":[],"methods":[],"superInheritances":[],"subInheritances":[]}]

package/sample.ts

@@ -0,0 +1 @@
+class A {}

package/src/analyze.ts

@@ -1,120 +1,120 @@
-import { Project } from "ts-morph";
-import * as fs from 'fs';
-import { FamixRepository } from "./lib/famix/famix_repository";
-import { Logger } from "tslog";
-import * as processFunctions from "./analyze_functions/process_functions";
-import { EntityDictionary } from "./famix_functions/EntityDictionary";
-import path from "path";
-
-export const logger = new Logger({ name: "ts2famix", minLevel: 3 });
-export const config = { "expectGraphemes": false };
-export const entityDictionary = new EntityDictionary();
-
-/**
- * This class is used to build a Famix model from a TypeScript source code
- */
-export class Importer {
-
-    private project = new Project(
-        {
-            compilerOptions: {
-                baseUrl: "./test_src"
-            }
-        }
-    ); // The project containing the source files to analyze
-
-    /**
-     * 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 {
-        logger.debug(`famixRepFromPaths: paths: ${paths}`);
-
-        this.project.addSourceFilesAtPaths(paths);
-
-        initFamixRep(this.project);
-
-        this.processEntities(this.project);
-
-        const famixRep = entityDictionary.famixRep;
-        //        }
-        //        catch (error) {
-        // logger.error(`> ERROR: got exception ${error}. Exiting...`);
-        // logger.error(error.message);
-        // logger.error(error.stack);
-        // process.exit(1);
-        //        }
-
-        return famixRep;
-    }
-
-    private processEntities(project: Project): void {
-        const onlyTypeScriptFiles = project.getSourceFiles().filter(f => f.getFilePath().endsWith('.ts'));
-        processFunctions.processFiles(onlyTypeScriptFiles);
-        const accesses = processFunctions.accessMap;
-        const methodsAndFunctionsWithId = processFunctions.methodsAndFunctionsWithId;
-        const classes = processFunctions.classes;
-        const interfaces = processFunctions.interfaces;
-        const modules = processFunctions.modules;
-        const exports = processFunctions.listOfExportMaps;
-
-        processFunctions.processImportClausesForImportEqualsDeclarations(project.getSourceFiles(), exports);
-        processFunctions.processImportClausesForModules(modules, exports);
-        processFunctions.processAccesses(accesses);
-        processFunctions.processInvocations(methodsAndFunctionsWithId);
-        processFunctions.processInheritances(classes, interfaces);
-        processFunctions.processConcretisations(classes, interfaces, methodsAndFunctionsWithId);
-
-    }
-
-    /**
-     * 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);
-
-        initFamixRep(project);
-
-        this.processEntities(project);
-
-        return entityDictionary.famixRep;
-    }
-
-}
-
-function initFamixRep(project: Project): void {
-    // get compiler options
-    const compilerOptions = project.getCompilerOptions();
-
-    // get baseUrl
-    const baseUrl = compilerOptions.baseUrl || ".";
-
-    const absoluteBaseUrl = path.resolve(baseUrl);
-
-    entityDictionary.famixRep.setAbsolutePath(path.normalize(absoluteBaseUrl));
-}
+import { Project } from "ts-morph";
+import * as fs from 'fs';
+import { FamixRepository } from "./lib/famix/famix_repository";
+import { Logger } from "tslog";
+import * as processFunctions from "./analyze_functions/process_functions";
+import { EntityDictionary } from "./famix_functions/EntityDictionary";
+import path from "path";
+
+export const logger = new Logger({ name: "ts2famix", minLevel: 3 });
+export const config = { "expectGraphemes": false };
+export const entityDictionary = new EntityDictionary();
+
+/**
+ * This class is used to build a Famix model from a TypeScript source code
+ */
+export class Importer {
+
+    private project = new Project(
+        {
+            compilerOptions: {
+                baseUrl: "./test_src"
+            }
+        }
+    ); // The project containing the source files to analyze
+
+    /**
+     * 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 {
+        logger.debug(`famixRepFromPaths: paths: ${paths}`);
+
+        this.project.addSourceFilesAtPaths(paths);
+
+        initFamixRep(this.project);
+
+        this.processEntities(this.project);
+
+        const famixRep = entityDictionary.famixRep;
+        //        }
+        //        catch (error) {
+        // logger.error(`> ERROR: got exception ${error}. Exiting...`);
+        // logger.error(error.message);
+        // logger.error(error.stack);
+        // process.exit(1);
+        //        }
+
+        return famixRep;
+    }
+
+    private processEntities(project: Project): void {
+        const onlyTypeScriptFiles = project.getSourceFiles().filter(f => f.getFilePath().endsWith('.ts'));
+        processFunctions.processFiles(onlyTypeScriptFiles);
+        const accesses = processFunctions.accessMap;
+        const methodsAndFunctionsWithId = processFunctions.methodsAndFunctionsWithId;
+        const classes = processFunctions.classes;
+        const interfaces = processFunctions.interfaces;
+        const modules = processFunctions.modules;
+        const exports = processFunctions.listOfExportMaps;
+
+        processFunctions.processImportClausesForImportEqualsDeclarations(project.getSourceFiles(), exports);
+        processFunctions.processImportClausesForModules(modules, exports);
+        processFunctions.processAccesses(accesses);
+        processFunctions.processInvocations(methodsAndFunctionsWithId);
+        processFunctions.processInheritances(classes, interfaces);
+        // processFunctions.processConcretisations(classes, interfaces, methodsAndFunctionsWithId);
+
+    }
+
+    /**
+     * 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);
+
+        initFamixRep(project);
+
+        this.processEntities(project);
+
+        return entityDictionary.famixRep;
+    }
+
+}
+
+function initFamixRep(project: Project): void {
+    // get compiler options
+    const compilerOptions = project.getCompilerOptions();
+
+    // get baseUrl
+    const baseUrl = compilerOptions.baseUrl || ".";
+
+    const absoluteBaseUrl = path.resolve(baseUrl);
+
+    entityDictionary.famixRep.setAbsolutePath(path.normalize(absoluteBaseUrl));
+}