ts2famix 1.0.15 → 1.0.17

package/dist/famix_functions/famix_functions_index.js

@@ -22,11 +22,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FamixFunctionsIndex = void 0;
 const ts_morph_1 = require("ts-morph");
 const Famix = __importStar(require("../lib/famix/src/model/famix"));
 const fqn_1 = require("../fqn");
+const grapheme_splitter_1 = __importDefault(require("grapheme-splitter"));
 /**
  * This class is used to build a Famix model for the index file anchors
  */
@@ -50,8 +54,40 @@ class FamixFunctionsIndex {
         if (sourceElement !== null) {
             fmxIndexFileAnchor.setFileName(sourceElement.getSourceFile().getFilePath());
             if (!(sourceElement instanceof ts_morph_1.CommentRange)) {
-                fmxIndexFileAnchor.setStartPos(sourceElement.getStart());
-                fmxIndexFileAnchor.setEndPos(sourceElement.getEnd());
+                // sourceElement.getStart() and sourceElement.getEnd() are based on text that has not been split into grapheme clusters, so we need to split the text and then adjust the start and end positions by finding the string inside the split text that has been joined together to form the original text
+                /**
+                 * The following logic handles the case of multi-code point characters (e.g. emoji) in the source text.
+                 * This is needed because Pharo/Smalltalk treats multi-code point characters as a single character,
+                 * but JavaScript treats them as multiple characters. This means that the start and end positions
+                 * of a source element in Pharo/Smalltalk will be different than the start and end positions of the
+                 * same source element in JavaScript. This logic finds the start and end positions of the source
+                 * element in JavaScript and then uses those positions to set the start and end positions of the
+                 * Famix index file anchor.
+                 * It depends on code in the 'grapheme-splitter' package in npm.
+                 */
+                const splitter = new grapheme_splitter_1.default();
+                const sourceFileText = sourceElement.getSourceFile().getFullText();
+                const hasGraphemeClusters = splitter.countGraphemes(sourceFileText) > 1;
+                if (hasGraphemeClusters) {
+                    const sourceElementText = sourceFileText.substring(sourceElement.getStart(), sourceElement.getEnd());
+                    const sourceElementTextGraphemes = splitter.splitGraphemes(sourceElementText);
+                    const sourceFileTextGraphemes = splitter.splitGraphemes(sourceFileText);
+                    const start = sourceElement.getStart();
+                    const numberOfGraphemeClustersBeforeStart = splitter.countGraphemes(sourceFileText.substring(0, start));
+                    // find the start of the sourceElementTextGraphemes array in the sourceFileTextGraphemes array
+                    const newStart = indexOfSplitArray({ searchArray: sourceFileTextGraphemes,
+                        targetArray: sourceElementTextGraphemes,
+                        start: start - numberOfGraphemeClustersBeforeStart });
+                    const newEnd = newStart + sourceElementTextGraphemes.length;
+                    // note: the +1 is because the source anchor is 1-based, but ts-morph is 0-based
+                    fmxIndexFileAnchor.setStartPos(newStart + 1);
+                    fmxIndexFileAnchor.setEndPos(newEnd + 1);
+                }
+                else {
+                    // note: the +1 is because the source anchor is 1-based, but ts-morph is 0-based
+                    fmxIndexFileAnchor.setStartPos(sourceElement.getStart() + 1);
+                    fmxIndexFileAnchor.setEndPos(sourceElement.getEnd() + 1);
+                }
             }
             if (!(famixElement instanceof Famix.Association) && !(famixElement instanceof Famix.Comment) && !(sourceElement instanceof ts_morph_1.CommentRange) && !(sourceElement instanceof ts_morph_1.Identifier) && !(sourceElement instanceof ts_morph_1.ImportSpecifier) && !(sourceElement instanceof ts_morph_1.ExpressionWithTypeArguments)) {
                 famixElement.setFullyQualifiedName(this.FQNFunctions.getFQN(sourceElement));
@@ -60,3 +96,23 @@ class FamixFunctionsIndex {
     }
 }
 exports.FamixFunctionsIndex = FamixFunctionsIndex;
+/**
+ * This function works like indexOf, but it works with arrays of grapheme clusters.
+ * @param targetArray
+ */
+function indexOfSplitArray(params) {
+    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
+}

package/dist/famix_functions/famix_functions_types.js

@@ -52,14 +52,14 @@ class FamixFunctionsTypes {
         let fmxType;
         let isPrimitiveType = false;
         let isParameterizedType = false;
-        console.info("Creating (or getting) type: " + typeName + "' of element: " + element.getText() + " of kind: " + element.getKindName());
+        console.info("Creating (or getting) type: '" + typeName + "' of element: " + element.getText() + " of kind: " + element.getKindName());
         const typeAncestor = this.findTypeAncestor(element);
         const ancestorFullyQualifiedName = this.FQNFunctions.getFQN(typeAncestor);
         const ancestor = this.getFamixEntityByFullyQualifiedName(ancestorFullyQualifiedName);
         if (!ancestor) {
             throw new Error(`Ancestor ${ancestorFullyQualifiedName} not found.`);
         }
-        if (typeName === "number" || typeName === "string" || typeName === "boolean" || typeName === "bigint" || typeName === "symbol" || typeName === "undefined" || typeName === "null") {
+        if (typeName === "number" || typeName === "string" || typeName === "boolean" || typeName === "bigint" || typeName === "symbol" || typeName === "undefined" || typeName === "null" || typeName === "any" || typeName === "unknown" || typeName === "never" || typeName === "void") {
             isPrimitiveType = true;
         }
         if (!isPrimitiveType && typeName.includes("<") && typeName.includes(">") && !(typeName.includes("=>"))) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts2famix",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "A TypeScript to JSON importer for Moose 10.",
   "main": "dist/ts2famix-cli.js",
   "scripts": {
@@ -26,13 +26,13 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@types/jest": "^29.5.4",
-    "@types/node": "^20.6.0",
+    "@types/jest": "^29.5.5",
+    "@types/node": "^20.6.3",
     "@types/yargs": "^17.0.24",
-    "@typescript-eslint/eslint-plugin": "^6.6.0",
-    "@typescript-eslint/parser": "^6.6.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.2",
+    "@typescript-eslint/parser": "^6.7.2",
     "eslint": "^8.49.0",
-    "jest": "^29.6.4",
+    "jest": "^29.7.0",
     "tplant": "^3.1.2",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
@@ -40,6 +40,7 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
+    "grapheme-splitter": "^1.0.4",
     "ts-morph": "^19.0.0",
     "tsutils": "^3.21.0",
     "yargs": "^17.7.2"

package/src/famix_functions/famix_functions_index.ts

@@ -2,6 +2,7 @@ import { ClassDeclaration, ConstructorDeclaration, FunctionDeclaration, Identifi
 import * as Famix from "../lib/famix/src/model/famix";
 import { FamixRepository } from "../lib/famix/src/famix_repository";
 import { FQNFunctions } from "../fqn";
+import GraphemeSplitter from "grapheme-splitter";
 
 /**
  * This class is used to build a Famix model for the index file anchors
@@ -30,10 +31,42 @@ export class FamixFunctionsIndex {
 
         if (sourceElement !== null) {
             fmxIndexFileAnchor.setFileName(sourceElement.getSourceFile().getFilePath());
-            
             if (!(sourceElement instanceof CommentRange)) {
-                fmxIndexFileAnchor.setStartPos(sourceElement.getStart());
-                fmxIndexFileAnchor.setEndPos(sourceElement.getEnd());
+                // sourceElement.getStart() and sourceElement.getEnd() are based on text that has not been split into grapheme clusters, so we need to split the text and then adjust the start and end positions by finding the string inside the split text that has been joined together to form the original text
+                /**
+                 * The following logic handles the case of multi-code point characters (e.g. emoji) in the source text.
+                 * This is needed because Pharo/Smalltalk treats multi-code point characters as a single character, 
+                 * but JavaScript treats them as multiple characters. This means that the start and end positions
+                 * of a source element in Pharo/Smalltalk will be different than the start and end positions of the
+                 * same source element in JavaScript. This logic finds the start and end positions of the source
+                 * element in JavaScript and then uses those positions to set the start and end positions of the
+                 * Famix index file anchor.
+                 * It depends on code in the 'grapheme-splitter' package in npm.
+                 */
+                const splitter = new GraphemeSplitter();
+                const sourceFileText = sourceElement.getSourceFile().getFullText();
+                const hasGraphemeClusters = splitter.countGraphemes(sourceFileText) > 1;
+                if (hasGraphemeClusters) {
+                    const sourceElementText = sourceFileText.substring(sourceElement.getStart(), sourceElement.getEnd());
+                    const sourceElementTextGraphemes = splitter.splitGraphemes(sourceElementText);
+                    const sourceFileTextGraphemes = splitter.splitGraphemes(sourceFileText);
+                    const start = sourceElement.getStart();
+                    const numberOfGraphemeClustersBeforeStart = splitter.countGraphemes(sourceFileText.substring(0, start));
+    
+                    // find the start of the sourceElementTextGraphemes array in the sourceFileTextGraphemes array
+                    const newStart = indexOfSplitArray({searchArray: sourceFileTextGraphemes, 
+                                                        targetArray: sourceElementTextGraphemes, 
+                                                        start: start - numberOfGraphemeClustersBeforeStart});
+                    const newEnd = newStart + sourceElementTextGraphemes.length;
+
+                    // note: the +1 is because the source anchor is 1-based, but ts-morph is 0-based
+                    fmxIndexFileAnchor.setStartPos(newStart + 1);
+                    fmxIndexFileAnchor.setEndPos(newEnd + 1);
+                } else {
+                    // note: the +1 is because the source anchor is 1-based, but ts-morph is 0-based
+                    fmxIndexFileAnchor.setStartPos(sourceElement.getStart() + 1);
+                    fmxIndexFileAnchor.setEndPos(sourceElement.getEnd() + 1);
+                }
             }
 
             if (!(famixElement instanceof Famix.Association) && !(famixElement instanceof Famix.Comment) && !(sourceElement instanceof CommentRange) && !(sourceElement instanceof Identifier) && !(sourceElement instanceof ImportSpecifier) && !(sourceElement instanceof ExpressionWithTypeArguments)) {
@@ -42,3 +75,30 @@ export class FamixFunctionsIndex {
         }
     }
 }
+
+
+interface SearchParameters {
+    searchArray: string[];
+    targetArray: string[];
+    start?: number;
+}
+/**
+ * This function works like indexOf, but it works with arrays of grapheme clusters.
+ * @param targetArray
+ */
+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
+}

package/src/famix_functions/famix_functions_types.ts

@@ -34,7 +34,7 @@ export class FamixFunctionsTypes {
         let isPrimitiveType = false;
         let isParameterizedType = false;
 
-        console.info("Creating (or getting) type: " + typeName + "' of element: " + element.getText() + " of kind: " + element.getKindName());
+        console.info("Creating (or getting) type: '" + typeName + "' of element: " + element.getText() + " of kind: " + element.getKindName());
 
         const typeAncestor = this.findTypeAncestor(element);
         const ancestorFullyQualifiedName = this.FQNFunctions.getFQN(typeAncestor);
@@ -43,7 +43,7 @@ export class FamixFunctionsTypes {
             throw new Error(`Ancestor ${ancestorFullyQualifiedName} not found.`);
         }
 
-        if (typeName === "number" || typeName === "string" || typeName === "boolean" || typeName === "bigint" || typeName === "symbol" || typeName === "undefined" || typeName === "null") {
+        if (typeName === "number" || typeName === "string" || typeName === "boolean" || typeName === "bigint" || typeName === "symbol" || typeName === "undefined" || typeName === "null" || typeName === "any" || typeName === "unknown" || typeName === "never" || typeName === "void") {
             isPrimitiveType = true;
         }