ts2famix 1.0.13 → 1.0.15

package/.eslintrc.json

@@ -1,24 +1,24 @@
-{
-    "env": {
-        "browser": true,
-        "es2021": true
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "overrides": [
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": "latest",
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-        "@typescript-eslint/no-namespace": "off",
-        "semi": [1, "always"]
-    }
-}
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-namespace": "off",
+        "semi": [1, "always"]
+    }
+}

package/LICENSE

@@ -1,23 +1,23 @@
-MIT License
-
-Copyright (c) 2021 Arezoo Nasrollah Zadeh
-Copyright (c) 2021 Christopher Fuhrman
-Copyright (c) 2023 Maël Paul
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Arezoo Nasrollah Zadeh
+Copyright (c) 2021 Christopher Fuhrman
+Copyright (c) 2023 Maël Paul
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,109 +1,109 @@
-# FamixTypeScriptImporter
-
-[![Node.js CI](https://github.com/maelpaul/FamixTypeScriptImporter/actions/workflows/node.js.yml/badge.svg)](https://github.com/maelpaul/FamixTypeScriptImporter/actions/workflows/node.js.yml)
-
-Create a [FamixTypeScript](https://github.com/fuhrmanator/FamixTypeScript) model in JSON of TypeScript files.
-
-## Installation
-
-```sh
-npm install ts2famix
-```
-
-## Usage
-
-Instructions for using the command-line importer:
-
-```sh
-ts2famix --help
-```
-
-## Parse a full project
-
-```sh
-ts2famix -i ../path/to/project/tsconfig.json -o JSONModels/projectName.json
-```
-or
-```sh
-ts2famix -i "../path/to/project/**/*.ts" -o JSONModels/projectName.json
-```
-
-## Import the JSON model into Moose 🫎
-
-You need to copy the "```JSONModels/projectName.json```" into your "```Pharo/images/[imageName]```" directory.
-
-For a Moose Suite 10 (stable) user with the Pharo directory in the root directory, do : 
-```sh
-cp JSONModels/projectName.json ~/Pharo/images/Moose\ Suite\ 10\ \(stable\)/.
-```
-
-Then, in a Moose Playground, do :
-```st
-Metacello new 
-  githubUser: 'fuhrmanator' project: 'FamixTypeScript' commitish: 'master' path: 'src';
-  baseline: 'FamixTypeScript';
-  load
-```
-
-This command installs the TypeScript metamodel into Moose.
-
-Then, generate the metamodel with :  
-```Library > Famix > Manage metamodels > Regenerate all metamodels```
-
-Then, in a Moose Playground, do :
-```st
-'projectName.json' asFileReference readStreamDo:
-  [ :stream | model := FamixTypeScriptModel new 
-    importFromJSONStream: stream. model install ].
-```
-
-This command imports the JSON model into Moose.
-
-## Developer info
-
-Run tests :
-```sh
-npm test
-```
-
-Generate coverage :
-```sh
-npm run coverage
-```
-
-Then, open "```coverage/lcov-report/index.html```" with your favorite browser : 
-```sh
-firefox coverage/lcov-report/index.html &
-```
-
-Generate documentation :
-```sh
-npm run doc
-```
-
-Then, open "```docs/index.html```" with your favorite browser : 
-```sh
-firefox docs/index.html &
-```
-
-Generate plantuml and svg of the metamodel :
-```sh
-npm run uml
-```
-
-Then, open "```doc-uml/metamodel.svg```" with your favorite image viewer :
-```sh
-eog doc-uml/metamodel.svg &
-```
-
-## Generate an object diagram of the JSON model
-
-```sh
-ts-node src/famix2puml.ts -i JSONModels/projectName.json -o PUMLModels/projectName.puml
-```
-
-## TypeScript Metamodel API documentation (visualization)
-
-The following was generated by CI using [tplant](https://github.com/bafolts/tplant), in a similar fashion described [here](https://modularmoose.org/2021/07/19/automatic-metamodel-documentation-generation.html).
-
-![FamixTypeScript API Metamodel](https://raw.githubusercontent.com/maelpaul/FamixTypeScriptImporter/v1/doc/metamodel.svg)
+# FamixTypeScriptImporter
+
+[![Node.js CI](https://github.com/maelpaul/FamixTypeScriptImporter/actions/workflows/node.js.yml/badge.svg)](https://github.com/maelpaul/FamixTypeScriptImporter/actions/workflows/node.js.yml)
+
+Create a [FamixTypeScript](https://github.com/fuhrmanator/FamixTypeScript) model in JSON of TypeScript files.
+
+## Installation
+
+```sh
+npm install ts2famix
+```
+
+## Usage
+
+Instructions for using the command-line importer:
+
+```sh
+ts2famix --help
+```
+
+## Parse a full project
+
+```sh
+ts2famix -i ../path/to/project/tsconfig.json -o JSONModels/projectName.json
+```
+or
+```sh
+ts2famix -i "../path/to/project/**/*.ts" -o JSONModels/projectName.json
+```
+
+## Import the JSON model into Moose 🫎
+
+You need to copy the "```JSONModels/projectName.json```" into your "```Pharo/images/[imageName]```" directory.
+
+For a Moose Suite 10 (stable) user with the Pharo directory in the root directory, do : 
+```sh
+cp JSONModels/projectName.json ~/Pharo/images/Moose\ Suite\ 10\ \(stable\)/.
+```
+
+Then, in a Moose Playground, do :
+```st
+Metacello new 
+  githubUser: 'fuhrmanator' project: 'FamixTypeScript' commitish: 'master' path: 'src';
+  baseline: 'FamixTypeScript';
+  load
+```
+
+This command installs the TypeScript metamodel into Moose.
+
+Then, generate the metamodel with :  
+```Library > Famix > Manage metamodels > Regenerate all metamodels```
+
+Then, in a Moose Playground, do :
+```st
+'projectName.json' asFileReference readStreamDo:
+  [ :stream | model := FamixTypeScriptModel new 
+    importFromJSONStream: stream. model install ].
+```
+
+This command imports the JSON model into Moose.
+
+## Developer info
+
+Run tests :
+```sh
+npm test
+```
+
+Generate coverage :
+```sh
+npm run coverage
+```
+
+Then, open "```coverage/lcov-report/index.html```" with your favorite browser : 
+```sh
+firefox coverage/lcov-report/index.html &
+```
+
+Generate documentation :
+```sh
+npm run doc
+```
+
+Then, open "```docs/index.html```" with your favorite browser : 
+```sh
+firefox docs/index.html &
+```
+
+Generate plantuml and svg of the metamodel :
+```sh
+npm run uml
+```
+
+Then, open "```doc-uml/metamodel.svg```" with your favorite image viewer :
+```sh
+eog doc-uml/metamodel.svg &
+```
+
+## Generate an object diagram of the JSON model
+
+```sh
+ts-node src/famix2puml.ts -i JSONModels/projectName.json -o PUMLModels/projectName.puml
+```
+
+## TypeScript Metamodel API documentation (visualization)
+
+The following was generated by CI using [tplant](https://github.com/bafolts/tplant), in a similar fashion described [here](https://modularmoose.org/2021/07/19/automatic-metamodel-documentation-generation.html).
+
+![FamixTypeScript API Metamodel](https://raw.githubusercontent.com/maelpaul/FamixTypeScriptImporter/v1/doc/metamodel.svg)

package/dist/analyze.js

@@ -0,0 +1,107 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Importer = void 0;
+const ts_morph_1 = require("ts-morph");
+const fs = __importStar(require("fs"));
+const famix_functions_1 = require("./famix_functions/famix_functions");
+const processFiles_1 = require("./analyze_functions/processFiles");
+const processAccesses_1 = require("./analyze_functions/processAccesses");
+const processInvocations_1 = require("./analyze_functions/processInvocations");
+const processInheritances_1 = require("./analyze_functions/processInheritances");
+const processImportClauses_1 = require("./analyze_functions/processImportClauses");
+/**
+ * This class is used to build a Famix model from a TypeScript source code
+ */
+class Importer {
+    constructor() {
+        this.project = new ts_morph_1.Project(); // The project containing the source files to analyze
+        this.famixFunctions = new famix_functions_1.FamixFunctions(); // FamixFunctions object, it contains all the functions needed to create Famix entities
+        this.processFiles = new processFiles_1.ProcessFiles(this.famixFunctions); // ProcessFiles object, it contains all the functions needed to process the source files
+        this.processAccesses = new processAccesses_1.ProcessAccesses(this.famixFunctions); // ProcessAccesses object, it contains all the functions needed to process the accesses
+        this.processInvocations = new processInvocations_1.ProcessInvocations(this.famixFunctions); // ProcessInvocations object, it contains all the functions needed to process the invocations
+        this.processInheritances = new processInheritances_1.ProcessInheritances(this.famixFunctions); // ProcessInheritances object, it contains all the functions needed to process the inheritances
+        this.processImportClauses = new processImportClauses_1.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
+     */
+    famixRepFromPaths(paths) {
+        //        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;
+    }
+    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
+    famixRepFromSource(filename, source) {
+        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
+     */
+    famixRepFromProject(project) {
+        //const sourceFileNames = project.getSourceFiles().map(f => f.getFilePath()) as Array<string>;
+        //const famixRep = this.famixRepFromPaths(sourceFileNames);
+        this.processEntities(project);
+        return this.famixFunctions.getFamixRepository();
+    }
+}
+exports.Importer = Importer;

package/dist/analyze_functions/processAccesses.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessAccesses = void 0;
+/**
+ * This class is used to build a Famix model for the accesses
+ */
+class ProcessAccesses {
+    /**
+     * Initializes the ProcessAccesses object
+     * @param famixFunctions FamixFunctions object, it contains all the functions needed to create Famix entities
+     */
+    constructor(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
+     */
+    processAccesses(accessMap) {
+        console.info(`processAccesses: Creating accesses:`);
+        accessMap.forEach((v, id) => {
+            console.info(`processAccesses: Accesses to ${v.getName()}`);
+            try {
+                const temp_nodes = v.findReferencesAsNodes();
+                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
+     */
+    processNodeForAccesses(n, id) {
+        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...`);
+        }
+    }
+}
+exports.ProcessAccesses = ProcessAccesses;