ts2famix 2.0.1 → 2.1.0-beta.1

package/src/famix_functions/helpers_creation.ts

@@ -1,135 +1,135 @@
-import * as Famix from "../lib/famix/model/famix";
-import { logger } from "../analyze";
-import { ConstructorDeclaration, Identifier, FunctionDeclaration, MethodDeclaration, MethodSignature, PropertyDeclaration, PropertySignature, VariableDeclaration, ParameterDeclaration, GetAccessorDeclaration, SetAccessorDeclaration, EnumMember, TypeAliasDeclaration, Node, SyntaxKind, FunctionExpression } from "ts-morph";
-import { TypeDeclaration } from "./EntityDictionary";
-
-interface SearchParameters {
-    searchArray: string[];
-    targetArray: string[];
-    start?: number;
-}
-
-/**
- * This function works like indexOf, but it works with arrays of grapheme clusters.
- * @param targetArray
- */
-export function indexOfSplitArray(params: SearchParameters): number {
-    const {searchArray, targetArray, start = 0} = params;
-    for (let i = start; i <= searchArray.length - targetArray.length; i++) {
-        let found = true;
-        for (let j = 0; j < targetArray.length; j++) {
-            if (searchArray[i + j] !== targetArray[j]) {
-                found = false;
-                break;
-            }
-        }
-        if (found) {
-            return i; // Return the index where the target array was found
-        }
-    }
-    return -1; // Return -1 if the target array was not found in the search array
-}
-
-export function getSubTypeName(fmxNamedEntity: Famix.NamedEntity) {
-    const name = fmxNamedEntity instanceof Famix.Class ? 'Class' :
-        fmxNamedEntity instanceof Famix.Interface ? 'Interface' :
-            fmxNamedEntity instanceof Famix.Function ? 'Function' :
-                fmxNamedEntity instanceof Famix.Enum ? 'Enum' :
-                    fmxNamedEntity instanceof Famix.EnumValue ? 'EnumValue' :
-                        fmxNamedEntity instanceof Famix.Alias ? 'Alias' :
-                            fmxNamedEntity instanceof Famix.Variable ? 'Variable' :
-                                fmxNamedEntity instanceof Famix.Type ? 'Type' :
-                                    fmxNamedEntity instanceof Famix.Method ? 'Method' :
-                                        fmxNamedEntity instanceof Famix.Decorator ? 'Decorator' :
-                                            fmxNamedEntity instanceof Famix.Accessor ? 'Accessor' :
-                                                fmxNamedEntity instanceof Famix.Parameter ? 'Parameter' :
-                                                    fmxNamedEntity instanceof Famix.Property ? 'Property' :
-                                                        'NamedEntity';
-    logger.debug(`${fmxNamedEntity.name} is of type ${name}`);
-    return name;
-}
-
-/**
- * Gets the signature of a method or a function
- * @param text A method or a function source code
- * @returns The signature of the method or the function
- */
-export function computeSignature(text: string): string {
-    const endSignatureText = text.indexOf("{");
-    return text.substring(0, endSignatureText).trim();
-}
-
-/**
- * Finds the ancestor of a node
- * @param node A node
- * @returns The ancestor of the node
- */
-export function findAncestor(node: Identifier): Node {
-    let ancestor: Node | undefined;
-    ancestor = node.getAncestors().find(a => 
-        a.getKind() === SyntaxKind.MethodDeclaration || 
-        a.getKind() === SyntaxKind.Constructor || 
-        a.getKind() === SyntaxKind.FunctionDeclaration || 
-        a.getKind() === SyntaxKind.FunctionExpression || 
-        a.getKind() === SyntaxKind.ModuleDeclaration || 
-        a.getKind() === SyntaxKind.SourceFile || 
-        a.getKindName() === "GetAccessor" || 
-        a.getKindName() === "SetAccessor" || 
-        a.getKind() === SyntaxKind.ClassDeclaration);
-    if (!ancestor) {
-        throw new Error(`Ancestor not found for ${node.getText()}`);
-    }
-    return ancestor
-}
-
-/**
- * Finds the ancestor of a ts-morph element
- * @param element A ts-morph element
- * @returns The ancestor of the ts-morph element
- */
-export function findTypeAncestor(element: TypeDeclaration): Node {
-    let ancestor: Node | undefined;
-    ancestor = element.getAncestors().find(a => 
-        a.getKind() === SyntaxKind.MethodDeclaration || 
-        a.getKind() === SyntaxKind.Constructor || 
-        a.getKind() === SyntaxKind.MethodSignature || 
-        a.getKind() === SyntaxKind.FunctionDeclaration || 
-        a.getKind() === SyntaxKind.FunctionExpression || 
-        a.getKind() === SyntaxKind.ModuleDeclaration || 
-        a.getKind() === SyntaxKind.SourceFile || 
-        a.getKindName() === "GetAccessor" || 
-        a.getKindName() === "SetAccessor" || 
-        a.getKind() === SyntaxKind.ClassDeclaration || 
-        a.getKind() === SyntaxKind.InterfaceDeclaration);
-    if (!ancestor) {
-        throw new Error(`Type ancestor not found for ${element.getKindName()}`);
-    }
-    return ancestor;
-}
-
-export function arraysAreEqual(array1: string[], array2: string[]): boolean {
-    if (array1 && array2 ) {
-        return array1.length === array2.length && array1.every((value, index) => value === array2[index]);
-    } else {
-        return false;
-    }
-}
-
-export function replaceLastBetweenTags(input: string, replacement: string): string {
-    const lastTagIndex = input.lastIndexOf('<');
-    
-    if (lastTagIndex === -1) {
-        return input; // Return the original string if no tags are found
-    }
-
-    const closingTagIndex = input.indexOf('>', lastTagIndex);
-    
-    if (closingTagIndex === -1) {
-        return input; // Return the original string if no closing tag is found
-    }
-
-    const beforeTag = input.substring(0, lastTagIndex + 1); // Include '<'
-    const afterTag = input.substring(closingTagIndex); // Include '>'
-
-    return beforeTag + replacement + afterTag;
-}
+import * as Famix from "../lib/famix/model/famix";
+import { logger } from "../analyze";
+import { ConstructorDeclaration, Identifier, FunctionDeclaration, MethodDeclaration, MethodSignature, PropertyDeclaration, PropertySignature, VariableDeclaration, ParameterDeclaration, GetAccessorDeclaration, SetAccessorDeclaration, EnumMember, TypeAliasDeclaration, Node, SyntaxKind, FunctionExpression } from "ts-morph";
+import { TSMorphTypeDeclaration } from "./EntityDictionary";
+
+interface SearchParameters {
+    searchArray: string[];
+    targetArray: string[];
+    start?: number;
+}
+
+/**
+ * This function works like indexOf, but it works with arrays of grapheme clusters.
+ * @param targetArray
+ */
+export function indexOfSplitArray(params: SearchParameters): number {
+    const {searchArray, targetArray, start = 0} = params;
+    for (let i = start; i <= searchArray.length - targetArray.length; i++) {
+        let found = true;
+        for (let j = 0; j < targetArray.length; j++) {
+            if (searchArray[i + j] !== targetArray[j]) {
+                found = false;
+                break;
+            }
+        }
+        if (found) {
+            return i; // Return the index where the target array was found
+        }
+    }
+    return -1; // Return -1 if the target array was not found in the search array
+}
+
+export function getSubTypeName(fmxNamedEntity: Famix.NamedEntity) {
+    const name = fmxNamedEntity instanceof Famix.Class ? 'Class' :
+        fmxNamedEntity instanceof Famix.Interface ? 'Interface' :
+            fmxNamedEntity instanceof Famix.Function ? 'Function' :
+                fmxNamedEntity instanceof Famix.Enum ? 'Enum' :
+                    fmxNamedEntity instanceof Famix.EnumValue ? 'EnumValue' :
+                        fmxNamedEntity instanceof Famix.Alias ? 'Alias' :
+                            fmxNamedEntity instanceof Famix.Variable ? 'Variable' :
+                                fmxNamedEntity instanceof Famix.Type ? 'Type' :
+                                    fmxNamedEntity instanceof Famix.Method ? 'Method' :
+                                        fmxNamedEntity instanceof Famix.Decorator ? 'Decorator' :
+                                            fmxNamedEntity instanceof Famix.Accessor ? 'Accessor' :
+                                                fmxNamedEntity instanceof Famix.Parameter ? 'Parameter' :
+                                                    fmxNamedEntity instanceof Famix.Property ? 'Property' :
+                                                        'NamedEntity';
+    logger.debug(`${fmxNamedEntity.name} is of type ${name}`);
+    return name;
+}
+
+/**
+ * Gets the signature of a method or a function
+ * @param text A method or a function source code
+ * @returns The signature of the method or the function
+ */
+export function computeSignature(text: string): string {
+    const endSignatureText = text.indexOf("{");
+    return text.substring(0, endSignatureText).trim();
+}
+
+/**
+ * Finds the ancestor of a node
+ * @param node A node
+ * @returns The ancestor of the node
+ */
+export function findAncestor(node: Identifier): Node {
+    let ancestor: Node | undefined;
+    ancestor = node.getAncestors().find(a => 
+        a.getKind() === SyntaxKind.MethodDeclaration || 
+        a.getKind() === SyntaxKind.Constructor || 
+        a.getKind() === SyntaxKind.FunctionDeclaration || 
+        a.getKind() === SyntaxKind.FunctionExpression || 
+        a.getKind() === SyntaxKind.ModuleDeclaration || 
+        a.getKind() === SyntaxKind.SourceFile || 
+        a.getKindName() === "GetAccessor" || 
+        a.getKindName() === "SetAccessor" || 
+        a.getKind() === SyntaxKind.ClassDeclaration);
+    if (!ancestor) {
+        throw new Error(`Ancestor not found for ${node.getText()}`);
+    }
+    return ancestor
+}
+
+/**
+ * Finds the ancestor of a ts-morph element
+ * @param element A ts-morph element
+ * @returns The ancestor of the ts-morph element
+ */
+export function findTypeAncestor(element: TSMorphTypeDeclaration): Node {
+    let ancestor: Node | undefined;
+    ancestor = element.getAncestors().find(a => 
+        a.getKind() === SyntaxKind.MethodDeclaration || 
+        a.getKind() === SyntaxKind.Constructor || 
+        a.getKind() === SyntaxKind.MethodSignature || 
+        a.getKind() === SyntaxKind.FunctionDeclaration || 
+        a.getKind() === SyntaxKind.FunctionExpression || 
+        a.getKind() === SyntaxKind.ModuleDeclaration || 
+        a.getKind() === SyntaxKind.SourceFile || 
+        a.getKindName() === "GetAccessor" || 
+        a.getKindName() === "SetAccessor" || 
+        a.getKind() === SyntaxKind.ClassDeclaration || 
+        a.getKind() === SyntaxKind.InterfaceDeclaration);
+    if (!ancestor) {
+        throw new Error(`Type ancestor not found for ${element.getKindName()}`);
+    }
+    return ancestor;
+}
+
+export function arraysAreEqual(array1: string[], array2: string[]): boolean {
+    if (array1 && array2 ) {
+        return array1.length === array2.length && array1.every((value, index) => value === array2[index]);
+    } else {
+        return false;
+    }
+}
+
+export function replaceLastBetweenTags(input: string, replacement: string): string {
+    const lastTagIndex = input.lastIndexOf('<');
+    
+    if (lastTagIndex === -1) {
+        return input; // Return the original string if no tags are found
+    }
+
+    const closingTagIndex = input.indexOf('>', lastTagIndex);
+    
+    if (closingTagIndex === -1) {
+        return input; // Return the original string if no closing tag is found
+    }
+
+    const beforeTag = input.substring(0, lastTagIndex + 1); // Include '<'
+    const afterTag = input.substring(closingTagIndex); // Include '>'
+
+    return beforeTag + replacement + afterTag;
+}

package/src/fqn.ts

@@ -1,20 +1,20 @@
-import { ArrowFunction, CallExpression, ClassDeclaration, ClassExpression, ConstructorDeclaration, Decorator, EnumDeclaration, FunctionDeclaration, FunctionExpression, GetAccessorDeclaration, Identifier, ImportDeclaration, ImportEqualsDeclaration, InterfaceDeclaration, MethodDeclaration, MethodSignature, ModuleDeclaration, Node, PropertyDeclaration, SetAccessorDeclaration, SourceFile, SyntaxKind, TypeParameterDeclaration, VariableDeclaration } from "ts-morph";
+import { ArrowFunction, CallExpression, ClassDeclaration, ConstructorDeclaration, Decorator, EnumDeclaration, FunctionDeclaration, FunctionExpression, GetAccessorDeclaration, Identifier, ImportDeclaration, ImportEqualsDeclaration, InterfaceDeclaration, MethodDeclaration, MethodSignature, ModuleDeclaration, Node, PropertyDeclaration, SetAccessorDeclaration, SourceFile, SyntaxKind, TypeParameterDeclaration, VariableDeclaration } from "ts-morph";
 import { entityDictionary, logger } from "./analyze";
 import path from "path";
-import { TypeDeclaration } from "./famix_functions/EntityDictionary";
+import { TSMorphTypeDeclaration } from "./famix_functions/EntityDictionary";
 
-type FQNNode = SourceFile | VariableDeclaration | ArrowFunction | Identifier | MethodDeclaration | MethodSignature | FunctionDeclaration | FunctionExpression | PropertyDeclaration | TypeDeclaration | EnumDeclaration | ImportDeclaration | ImportEqualsDeclaration | CallExpression | GetAccessorDeclaration | SetAccessorDeclaration | ConstructorDeclaration | TypeParameterDeclaration | ClassDeclaration | InterfaceDeclaration | Decorator | ModuleDeclaration;
+type FQNNode = SourceFile | VariableDeclaration | ArrowFunction | Identifier | MethodDeclaration | MethodSignature | FunctionDeclaration | FunctionExpression | PropertyDeclaration | TSMorphTypeDeclaration | EnumDeclaration | ImportDeclaration | ImportEqualsDeclaration | CallExpression | GetAccessorDeclaration | SetAccessorDeclaration | ConstructorDeclaration | TypeParameterDeclaration | ClassDeclaration | InterfaceDeclaration | Decorator | ModuleDeclaration;
 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 function isFQNNode(node: Node): node is FQNNode {
     return Node.isVariableDeclaration(node) || Node.isArrowFunction(node) || Node.isIdentifier(node) || Node.isMethodDeclaration(node) || Node.isClassDeclaration(node) || Node.isClassExpression(node) || Node.isDecorator(node) || Node.isModuleDeclaration(node) || Node.isCallExpression(node);
-
 }
 
 export function getFQN(node: FQNNode | Node): string {
     const absolutePathProject = entityDictionary.famixRep.getAbsolutePath();
 
     const sourceFile = node.getSourceFile();
-    let parts: string[] = [];
+    const parts: string[] = [];
     let currentNode: Node | undefined = node;
 
     while (currentNode && !Node.isSourceFile(currentNode)) {
@@ -29,11 +29,24 @@ export function getFQN(node: FQNNode | Node): string {
             Node.isVariableDeclaration(currentNode) || 
             Node.isGetAccessorDeclaration(currentNode) ||
             Node.isSetAccessorDeclaration(currentNode) ||
+            Node.isTypeParameterDeclaration(currentNode) ||
+            Node.isPropertyDeclaration(currentNode) ||
+            Node.isParameterDeclaration(currentNode) ||
+            Node.isDecorator(currentNode) ||
+            Node.isTypeAliasDeclaration(currentNode) ||
+            Node.isEnumDeclaration(currentNode) ||
+            Node.isEnumMember(currentNode) ||
+            Node.isParametered(currentNode) ||
+            Node.isPropertySignature(currentNode) ||
+            Node.isArrayLiteralExpression(currentNode) ||
+            Node.isImportSpecifier(currentNode) ||
             Node.isIdentifier(currentNode)) {
-            let name = Node.isIdentifier(currentNode) ? currentNode.getText() 
+            const name = Node.isIdentifier(currentNode) ? currentNode.getText() 
                 : getNameOfNode(currentNode) /* currentNode.getName() */ || 'Unnamed_' + currentNode.getKindName() + `(${lc})`;
             parts.unshift(name);
-        } else if (Node.isArrowFunction(currentNode) || 
+        }
+        // unnamed nodes
+        else if (Node.isArrowFunction(currentNode) || 
                    Node.isBlock(currentNode) || 
                    Node.isForInStatement(currentNode) || 
                    Node.isForOfStatement(currentNode) || 
@@ -44,7 +57,7 @@ export function getFQN(node: FQNNode | Node): string {
             parts.unshift(`constructor`);
         } else {
             // For other kinds, you might want to handle them specifically or ignore
-            //console.log(`Ignoring node kind: ${currentNode.getKindName()}`);
+            logger.debug(`Ignoring node kind: ${currentNode.getKindName()}`);
         }
         currentNode = currentNode.getParent();
     }
@@ -52,20 +65,27 @@ export function getFQN(node: FQNNode | Node): string {
 
 
     // Prepend the relative path of the source file
-    const relativePath = entityDictionary.convertToRelativePath(
+    let relativePath = entityDictionary.convertToRelativePath(
         path.normalize(sourceFile.getFilePath()), 
                        absolutePathProject).replace(/\\/sg, "/");
+                       
+    if (relativePath.includes("..")) {
+        logger.error(`Relative path contains ../: ${relativePath}`);
+    }
+    if (relativePath.startsWith("/")) {
+        relativePath = relativePath.substring(1);
+    }
     parts.unshift(`{${relativePath}}`);
     const fqn = parts.join(".") + `[${node.getKindName()}]`;  // disambiguate
 
-    logger.debug(fqn);
+    logger.debug(`Generated FQN: ${fqn} for node: ${node.getKindName()}`);
     return fqn;
 }
 
 
 export function getUniqueFQN(node: Node): string | undefined {
     const absolutePathProject = entityDictionary.famixRep.getAbsolutePath();
-    let parts: string[] = [];
+    const parts: string[] = [];
 
     if (node instanceof SourceFile) {
         return entityDictionary.convertToRelativePath(path.normalize(node.getFilePath()), absolutePathProject).replace(/\\/g, "/");
@@ -75,6 +95,9 @@ export function getUniqueFQN(node: Node): string | undefined {
     while (currentNode) {
         if (Node.isSourceFile(currentNode)) {
             const relativePath = entityDictionary.convertToRelativePath(path.normalize(currentNode.getFilePath()), absolutePathProject).replace(/\\/g, "/");
+            if (relativePath.includes("..")) {
+                logger.error(`Relative path contains ../: ${relativePath}`);
+            }
             parts.unshift(relativePath); // Add file path at the start
             break;
         } else if (currentNode.getSymbol()) {
@@ -95,6 +118,11 @@ export function getUniqueFQN(node: Node): string | undefined {
  * @returns The name of the node, or an empty string if it doesn't have one
  */
 export function getNameOfNode(a: Node): string {
+    let cKind: ClassDeclaration | undefined;
+    let iKind: InterfaceDeclaration | undefined;
+    let mKind: MethodDeclaration | undefined;
+    let fKind: FunctionDeclaration | undefined; 
+    let alias: TSMorphTypeDeclaration | undefined;
     switch (a.getKind()) {
         case SyntaxKind.SourceFile:
             return a.asKind(SyntaxKind.SourceFile)!.getBaseName();
@@ -103,7 +131,7 @@ export function getNameOfNode(a: Node): string {
             return a.asKind(SyntaxKind.ModuleDeclaration)!.getName(); 
 
         case SyntaxKind.ClassDeclaration:
-            const cKind = a.asKind(SyntaxKind.ClassDeclaration);
+            cKind = a.asKind(SyntaxKind.ClassDeclaration);
             if (cKind && cKind.getTypeParameters().length > 0) {
                 return cKind.getName() + getParameters(a);
             } else {
@@ -111,7 +139,7 @@ export function getNameOfNode(a: Node): string {
             }
 
         case SyntaxKind.InterfaceDeclaration:
-            const iKind = a.asKind(SyntaxKind.InterfaceDeclaration);
+            iKind = a.asKind(SyntaxKind.InterfaceDeclaration);
             if (iKind && iKind.getTypeParameters().length > 0) {
                 return iKind.getName() + getParameters(a);
             } else {
@@ -125,7 +153,7 @@ export function getNameOfNode(a: Node): string {
             return a.asKind(SyntaxKind.PropertySignature)!.getName();    
     
         case SyntaxKind.MethodDeclaration:
-            const mKind = a.asKind(SyntaxKind.MethodDeclaration);
+            mKind = a.asKind(SyntaxKind.MethodDeclaration);
             if (mKind && mKind.getTypeParameters().length > 0) {
                 return mKind.getName() + getParameters(a);
             } else {
@@ -142,7 +170,7 @@ export function getNameOfNode(a: Node): string {
             return a.asKind(SyntaxKind.SetAccessor)!.getName();
     
         case SyntaxKind.FunctionDeclaration:
-            const fKind = a.asKind(SyntaxKind.FunctionDeclaration);
+            fKind = a.asKind(SyntaxKind.FunctionDeclaration);
             if (fKind && fKind.getTypeParameters().length > 0) {
                 return fKind.getName() + getParameters(a);
             } else {
@@ -171,12 +199,18 @@ export function getNameOfNode(a: Node): string {
             return a.asKind(SyntaxKind.EnumMember)!.getName();
 
         case SyntaxKind.TypeAliasDeclaration:
+            // special case for parameterized types
+            alias = a.asKind(SyntaxKind.TypeAliasDeclaration);
+            if (alias && alias.getTypeParameters().length > 0) {
+                return alias.getName() + "<" + alias.getTypeParameters().map(tp => tp.getName()).join(", ") + ">";
+            }
             return a.asKind(SyntaxKind.TypeAliasDeclaration)!.getName();
 
         case SyntaxKind.Constructor:
             return "constructor";   
-            
+        
         default:
+            // throw new Error(`getNameOfNode called on a node that doesn't have a name: ${a.getKindName()}`);
             // ancestor hasn't got a useful name
             return "";
         }

package/src/generate_uml.sh

@@ -1,20 +1,20 @@
-#!/usr/bin/env bash
-# Gets latest plantuml
-rm -f plantuml.jar
-wget --no-verbose https://downloads.sourceforge.net/project/plantuml/plantuml.jar
-# echo the version
-echo "PlantUML version: $(java -jar plantuml.jar -version)"
-echo "tplant version: $(npx tplant --version)"
-# Builds metamodel plantuml from TypeScript sources
-npx tplant -i src/lib/famix/**/*.ts -o doc-metamodel/famix-typescript-model.puml
-sed -i 's/@startuml/& metamodel/' doc-metamodel/famix-typescript-model.puml
-# Converts plantuml source to SVG image
-java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml
-mv doc-metamodel/metamodel.svg doc-metamodel/metamodel-full.svg
-# Inserts include line to customize the file
-sed -i '/@startuml metamodel/a !include skins.include.puml' doc-metamodel/famix-typescript-model.puml
-# Converts plantuml source to SVG image
-java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml
-# Moves artifacts
-rm -f doc-uml/*
-mv doc-metamodel/*.svg doc-uml
+#!/usr/bin/env bash
+# Gets latest plantuml
+rm -f plantuml.jar
+wget --no-verbose https://downloads.sourceforge.net/project/plantuml/plantuml.jar
+# echo the version
+echo "PlantUML version: $(java -jar plantuml.jar -version)"
+echo "tplant version: $(npx tplant --version)"
+# Builds metamodel plantuml from TypeScript sources
+npx tplant -i src/lib/famix/**/*.ts -o doc-metamodel/famix-typescript-model.puml
+sed -i 's/@startuml/& metamodel/' doc-metamodel/famix-typescript-model.puml
+# Converts plantuml source to SVG image
+java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml
+mv doc-metamodel/metamodel.svg doc-metamodel/metamodel-full.svg
+# Inserts include line to customize the file
+sed -i '/@startuml metamodel/a !include skins.include.puml' doc-metamodel/famix-typescript-model.puml
+# Converts plantuml source to SVG image
+java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml
+# Moves artifacts
+rm -f doc-uml/*
+mv doc-metamodel/*.svg doc-uml

package/src/lib/famix/License.md

@@ -1,23 +1,23 @@
-Portions of the code in the famix directory:
-
-MIT License
-
-Copyright (c) 2019 Pascal Erni
-
-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
+Portions of the code in the famix directory:
+
+MIT License
+
+Copyright (c) 2019 Pascal Erni
+
+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/src/lib/famix/famix_JSON_exporter.ts

@@ -1,56 +1,56 @@
-import { FamixBaseElement } from "./famix_base_element";
-
-/**
- * This class is used to export Famix elements to JSON
- */
-export class FamixJSONExporter {
-
-    private element: FamixBaseElement; // A Famix element to export
-    private bufferArray: any = {}; // A buffer to store the properties of the Famix element
-    private FamixPrefix = "FamixTypeScript"; // Prefix of the Famix element
-
-    /**
-     * Constructor of the FamixJSONExporter class
-     * @param packageClass Name of a Famix class
-     * @param element A Famix element to export, this element is an instance of the class named "packageClass"
-     */
-    constructor(packageClass: string, element: FamixBaseElement) {
-        this.element = element;
-        this.bufferArray["FM3"] = this.FamixPrefix + "." + packageClass;
-        this.bufferArray["id"] = this.element.id;
-    }
-
-    /**
-     * Adds a property to the Famix element
-     * @param name Name of the property
-     * @param prop A property
-     */
-    public addProperty(name: string, prop: unknown): void {
-        if (prop instanceof Set) {
-            const valueArray: Array<unknown> = [];
-            for (const value of Array.from(prop.values())) {
-                if (value instanceof FamixBaseElement) {
-                    valueArray.push({ "ref": value.id });
-                }
-                else {
-                    valueArray.push(value);
-                }
-            }
-            this.bufferArray[name] = valueArray;
-        }
-        else if (prop instanceof FamixBaseElement) {
-            this.bufferArray[name] = { "ref": prop.id };
-        }
-        else if (prop !== undefined && !(prop instanceof Set)) {
-            this.bufferArray[name] = prop;
-        }
-    }
-
-    /**
-     * Gets a JSON representation of the Famix element
-     * @returns A JSON representation of the Famix element
-     */
-    public getJSON(): string {
-        return JSON.stringify(this.bufferArray);
-    }
-}
+import { FamixBaseElement } from "./famix_base_element";
+
+/**
+ * This class is used to export Famix elements to JSON
+ */
+export class FamixJSONExporter {
+
+    private element: FamixBaseElement; // A Famix element to export
+    private bufferArray: any = {}; // A buffer to store the properties of the Famix element
+    private FamixPrefix = "FamixTypeScript"; // Prefix of the Famix element
+
+    /**
+     * Constructor of the FamixJSONExporter class
+     * @param packageClass Name of a Famix class
+     * @param element A Famix element to export, this element is an instance of the class named "packageClass"
+     */
+    constructor(packageClass: string, element: FamixBaseElement) {
+        this.element = element;
+        this.bufferArray["FM3"] = this.FamixPrefix + "." + packageClass;
+        this.bufferArray["id"] = this.element.id;
+    }
+
+    /**
+     * Adds a property to the Famix element
+     * @param name Name of the property
+     * @param prop A property
+     */
+    public addProperty(name: string, prop: unknown): void {
+        if (prop instanceof Set) {
+            const valueArray: Array<unknown> = [];
+            for (const value of Array.from(prop.values())) {
+                if (value instanceof FamixBaseElement) {
+                    valueArray.push({ "ref": value.id });
+                }
+                else {
+                    valueArray.push(value);
+                }
+            }
+            this.bufferArray[name] = valueArray;
+        }
+        else if (prop instanceof FamixBaseElement) {
+            this.bufferArray[name] = { "ref": prop.id };
+        }
+        else if (prop !== undefined && !(prop instanceof Set)) {
+            this.bufferArray[name] = prop;
+        }
+    }
+
+    /**
+     * Gets a JSON representation of the Famix element
+     * @returns A JSON representation of the Famix element
+     */
+    public getJSON(): string {
+        return JSON.stringify(this.bufferArray);
+    }
+}