@onecx/nx-migration-utils 5.35.0

package/README.md

@@ -0,0 +1,15 @@
+# nx-migration-utils
+
+This library contains helpers for creating NX migrations.
+
+Framework agnostic utility functions are located in the `src/lib/utils` directory and can be imported from `@onecx/nx-migration-utils`. 
+
+Framework specific utilities are located in subdirectories of `src/lib` (e.g. `src/lib/angular`) and can be imported from `@onecx/nx-migration-utils/<framework>`.
+
+## Building
+
+Run `nx build nx-migration-utils` to build the library.
+
+## Running unit tests
+
+Run `nx test nx-migration-utils` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@onecx/nx-migration-utils",
+  "version": "5.35.0",
+  "license": "Apache-2.0",
+  "peerDependencies": {
+    "tslib": "^2.3.0",
+    "@phenomnomnominal/tsquery": "^6",
+    "@nx/devkit": "^19.8.0",
+    "typescript": "^5.5.4"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/utils/detect-method-calls-in-files';
+export * from './lib/utils/print-warnings';

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// General purpose and framework-agnostic utilities for NX migrations
+tslib_1.__exportStar(require("./lib/utils/detect-method-calls-in-files"), exports);
+tslib_1.__exportStar(require("./lib/utils/print-warnings"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/nx-migration-utils/src/index.ts"],"names":[],"mappings":";;;AAAA,qEAAqE;AACrE,mFAAwD;AACxD,qEAA0C"}

package/src/lib/angular/index.js

@@ -0,0 +1,3 @@
+"use strict";
+// Angular specific NX migration utilities
+//# sourceMappingURL=index.js.map

package/src/lib/angular/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/nx-migration-utils/src/lib/angular/index.ts"],"names":[],"mappings":";AAAA,0CAA0C"}

package/src/lib/utils/detect-method-calls-in-files.d.ts

@@ -0,0 +1,5 @@
+import { Tree } from '@nx/devkit';
+import { CallExpression } from 'typescript';
+type MatchingMethodCalls = Map<string, CallExpression[]>;
+export declare function detectMethodCallsInFiles(tree: Tree, rootDir: string, methodName: string, className: string): MatchingMethodCalls;
+export {};

package/src/lib/utils/detect-method-calls-in-files.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectMethodCallsInFiles = detectMethodCallsInFiles;
+const devkit_1 = require("@nx/devkit");
+const tsquery_1 = require("@phenomnomnominal/tsquery");
+const typescript_1 = require("typescript");
+function getDeclarationNames(contentAst, className, type) {
+    const declarations = (0, tsquery_1.query)(contentAst, `${type}:has(NewExpression > Identifier[name="${className}"])`);
+    const memberNames = declarations.map((node) => {
+        if ((type === 'VariableDeclaration' && (0, typescript_1.isVariableDeclaration)(node)) || (type === 'PropertyDeclaration' && (0, typescript_1.isPropertyDeclaration)(node))) {
+            return node.name.getText();
+        }
+        throw new Error(`Node is not a ${type}`);
+    });
+    return memberNames;
+}
+function getAssignmentNames(contentAst, className) {
+    const assignments = (0, tsquery_1.query)(contentAst, `ExpressionStatement:has(BinaryExpression:has(EqualsToken):has(NewExpression > Identifier[name="${className}"]))`);
+    const assignmentNames = assignments.map((node) => {
+        if ((0, typescript_1.isExpressionStatement)(node)) {
+            const binaryExpression = node.expression;
+            if ((0, typescript_1.isBinaryExpression)(binaryExpression)) {
+                if (binaryExpression.operatorToken.kind == typescript_1.SyntaxKind.EqualsToken) {
+                    if ((0, typescript_1.isPropertyAccessExpression)(binaryExpression.left)) {
+                        return binaryExpression.left.name.escapedText.toString();
+                    }
+                    else if ((0, typescript_1.isIdentifier)(binaryExpression.left)) {
+                        return binaryExpression.left.escapedText.toString();
+                    }
+                    else {
+                        throw new Error('Node is not a PropertyAccessExpression or Identifier');
+                    }
+                }
+            }
+        }
+        throw new Error('Node is not an ExpressionStatement');
+    });
+    return assignmentNames;
+}
+function getIdentifierCallQueries(contentAst, className, methodName) {
+    const variableNames = getDeclarationNames(contentAst, className, 'VariableDeclaration');
+    const memberNames = getDeclarationNames(contentAst, className, 'PropertyDeclaration');
+    const assignmentNames = getAssignmentNames(contentAst, className);
+    const allIdentifiers = [...variableNames, ...memberNames, ...assignmentNames];
+    // Only check variables once, even if their value is set multiple times
+    const distinctIdentifiers = Array.from(new Set(allIdentifiers));
+    const identifierCallPatterns = distinctIdentifiers.map((name) => `CallExpression:has(PropertyAccessExpression > Identifier[name="${name}"]):has(Identifier[name="${methodName}"])`);
+    return identifierCallPatterns;
+}
+function detectMethodCallsInFiles(tree, rootDir, methodName, className) {
+    const matchingFiles = new Map();
+    // Look at each file inside of specified rootDir or any of its subdirectories that isn't gitignored
+    (0, devkit_1.visitNotIgnoredFiles)(tree, rootDir, (file) => {
+        const content = tree.read(file, 'utf-8');
+        if (!content)
+            return;
+        const contentAst = (0, tsquery_1.ast)(content);
+        // Queries for method calls on identifiers (e.g. x.method() or this.x.method())
+        const identifierCallPatterns = getIdentifierCallQueries(contentAst, className, methodName);
+        // Query for inline method calls (e.g. new ClassName().method())
+        const inlineCallPattern = `CallExpression:has(NewExpression > Identifier[name="${className}"]):has(Identifier[name="${methodName}"])`;
+        const allPatterns = [...identifierCallPatterns, inlineCallPattern].join(', ');
+        // Search for all elements matching computed queries
+        let potentialMethodCalls = (0, tsquery_1.query)(contentAst, allPatterns);
+        // If no potential method calls are found, file can be ignored
+        if (potentialMethodCalls.length === 0)
+            return;
+        // Ensure that all detected method calls are indeed CallExpressions and filter out any other types
+        potentialMethodCalls = potentialMethodCalls.filter((node) => (0, typescript_1.isCallExpression)(node));
+        matchingFiles.set(file, potentialMethodCalls);
+    });
+    return matchingFiles;
+}
+//# sourceMappingURL=detect-method-calls-in-files.js.map

package/src/lib/utils/detect-method-calls-in-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect-method-calls-in-files.js","sourceRoot":"","sources":["../../../../../../libs/nx-migration-utils/src/lib/utils/detect-method-calls-in-files.ts"],"names":[],"mappings":";;AAoEA,4DAkCC;AAtGD,uCAAuD;AACvD,uDAAsD;AACtD,2CAAwN;AAKxN,SAAS,mBAAmB,CAAC,UAAsB,EAAE,SAAiB,EAAE,IAAqB;IAC3F,MAAM,YAAY,GAAG,IAAA,eAAK,EACxB,UAAU,EACV,GAAG,IAAI,yCAAyC,SAAS,KAAK,CAC/D,CAAA;IACD,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC5C,IAAI,CAAC,IAAI,KAAK,qBAAqB,IAAI,IAAA,kCAAqB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,qBAAqB,IAAI,IAAA,kCAAqB,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACvI,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAA;QAC5B,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IAEF,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,SAAS,kBAAkB,CAAC,UAAsB,EAAE,SAAiB;IACnE,MAAM,WAAW,GAAG,IAAA,eAAK,EACvB,UAAU,EACV,kGAAkG,SAAS,MAAM,CAClH,CAAA;IACD,MAAM,eAAe,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/C,IAAI,IAAA,kCAAqB,EAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAA;YACxC,IAAI,IAAA,+BAAkB,EAAC,gBAAgB,CAAC,EAAE,CAAC;gBACzC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,IAAI,uBAAU,CAAC,WAAW,EAAE,CAAC;oBAClE,IAAG,IAAA,uCAA0B,EAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;wBACrD,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAA;oBAC1D,CAAC;yBAAM,IAAI,IAAA,yBAAY,EAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC/C,OAAO,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAA;oBACrD,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;oBACzE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;IACvD,CAAC,CAAC,CAAA;IAEF,OAAO,eAAe,CAAA;AACxB,CAAC;AAED,SAAS,wBAAwB,CAAC,UAAsB,EAAE,SAAiB,EAAE,UAAkB;IAC7F,MAAM,aAAa,GAAG,mBAAmB,CAAC,UAAU,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAA;IAEvF,MAAM,WAAW,GAAG,mBAAmB,CAAC,UAAU,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAA;IAErF,MAAM,eAAe,GAAG,kBAAkB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IAElE,MAAM,cAAc,GAAG,CAAC,GAAG,aAAa,EAAE,GAAG,WAAW,EAAE,GAAG,eAAe,CAAC,CAAA;IAE7E,uEAAuE;IACvE,MAAM,mBAAmB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC,CAAA;IAE/D,MAAM,sBAAsB,GAAG,mBAAmB,CAAC,GAAG,CACpD,CAAC,IAAI,EAAE,EAAE,CACP,kEAAkE,IAAI,4BAA4B,UAAU,KAAK,CACpH,CAAA;IAED,OAAO,sBAAsB,CAAA;AAC/B,CAAC;AAED,SAAgB,wBAAwB,CACtC,IAAU,EACV,OAAe,EACf,UAAkB,EAClB,SAAiB;IAEjB,MAAM,aAAa,GAAwB,IAAI,GAAG,EAAE,CAAA;IAEpD,mGAAmG;IACnG,IAAA,6BAAoB,EAAC,IAAI,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACxC,IAAI,CAAC,OAAO;YAAE,OAAM;QACpB,MAAM,UAAU,GAAG,IAAA,aAAG,EAAC,OAAO,CAAC,CAAA;QAE/B,+EAA+E;QAC/E,MAAM,sBAAsB,GAAG,wBAAwB,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAA;QAE1F,gEAAgE;QAChE,MAAM,iBAAiB,GAAG,uDAAuD,SAAS,4BAA4B,UAAU,KAAK,CAAA;QAErI,MAAM,WAAW,GAAG,CAAC,GAAG,sBAAsB,EAAE,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE7E,oDAAoD;QACpD,IAAI,oBAAoB,GAAqB,IAAA,eAAK,EAAC,UAAU,EAAE,WAAW,CAAC,CAAA;QAE3E,8DAA8D;QAC9D,IAAI,oBAAoB,CAAC,MAAM,KAAK,CAAC;YAAE,OAAM;QAE7C,kGAAkG;QAClG,oBAAoB,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,6BAAgB,EAAC,IAAI,CAAC,CAAC,CAAA;QACpF,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IAEF,OAAO,aAAa,CAAA;AACtB,CAAC"}

package/src/lib/utils/print-warnings.d.ts

@@ -0,0 +1 @@
+export declare function printWarnings(warning: string, affectedFiles: string[]): void;

package/src/lib/utils/print-warnings.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printWarnings = printWarnings;
+const devkit_1 = require("@nx/devkit");
+function printWarnings(warning, affectedFiles) {
+    if (affectedFiles.length > 0) {
+        devkit_1.logger.warn(warning);
+        devkit_1.logger.warn(`Found in:`);
+        affectedFiles.forEach((file) => {
+            devkit_1.logger.warn(`  - ${file}`);
+        });
+    }
+}
+//# sourceMappingURL=print-warnings.js.map

package/src/lib/utils/print-warnings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"print-warnings.js","sourceRoot":"","sources":["../../../../../../libs/nx-migration-utils/src/lib/utils/print-warnings.ts"],"names":[],"mappings":";;AACA,sCAQC;AATD,uCAAmC;AACnC,SAAgB,aAAa,CAAC,OAAe,EAAE,aAAuB;IAClE,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,eAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpB,eAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACxB,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC7B,eAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;IACJ,CAAC;AACP,CAAC"}