@nx/devkit 0.0.0-pr-28229-afe192c → 0.0.0-pr-28517-630ecca

package/migrations.json

@@ -1,18 +1,5 @@
 {
-  "generators": {
-    "update-16-0-0-add-nx-packages": {
-      "cli": "nx",
-      "version": "16.0.0-beta.1",
-      "description": "Replace @nrwl/devkit with @nx/devkit",
-      "implementation": "./src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages"
-    },
-    "update-16-9-0-migrate-mf-usage-to-webpack": {
-      "cli": "nx",
-      "version": "16.9.0-beta.1",
-      "description": "Replace imports of Module Federation utils frm @nx/devkit to @nx/webpack",
-      "implementation": "./src/migrations/update-16-9-0/migrate-mf-util-usage"
-    }
-  },
+  "generators": {},
   "packageJsonUpdates": {},
   "version": "0.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/devkit",
-  "version": "0.0.0-pr-28229-afe192c",
+  "version": "0.0.0-pr-28517-630ecca",
   "private": false,
   "description": "The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more. Learn more about [extending Nx by leveraging the Nx Devkit](https://nx.dev/extending-nx/intro/getting-started) on our docs.",
   "repository": {
@@ -38,7 +38,7 @@
     "enquirer": "~2.3.6"
   },
   "peerDependencies": {
-    "nx": ">= 17 <= 20"
+    "nx": ">= 19 <= 21"
   },
   "publishConfig": {
     "access": "public"

package/src/executors/parse-target-string.d.ts

@@ -1,8 +1,4 @@
 import { ExecutorContext, ProjectGraph, Target } from 'nx/src/devkit-exports';
-/**
- * @deprecated(v17) A project graph should be passed to parseTargetString for best accuracy.
- */
-export declare function parseTargetString(targetString: string): Target;
 /**
  * Parses a target string into {project, target, configuration}
  *

package/src/executors/read-target-options.js

@@ -9,7 +9,7 @@ const devkit_internals_1 = require("nx/src/devkit-internals");
  * Works as if you invoked the target yourself without passing any command lint overrides.
  */
 function readTargetOptions({ project, target, configuration }, context) {
-    const projectConfiguration = (context.workspace || context.projectsConfigurations).projects[project];
+    const projectConfiguration = context.projectsConfigurations.projects[project];
     if (!projectConfiguration) {
         throw new Error(`Unable to find project ${project}`);
     }
@@ -18,7 +18,7 @@ function readTargetOptions({ project, target, configuration }, context) {
         throw new Error(`Unable to find target ${target} for project ${project}`);
     }
     const [nodeModule, executorName] = targetConfiguration.executor.split(':');
-    const { schema } = (0, devkit_internals_1.getExecutorInformation)(nodeModule, executorName, context.root, context.projectsConfigurations?.projects ?? context.workspace.projects);
+    const { schema } = (0, devkit_internals_1.getExecutorInformation)(nodeModule, executorName, context.root, context.projectsConfigurations?.projects);
     const defaultProject = (0, devkit_internals_1.calculateDefaultProjectName)(context.cwd, context.root, { version: 2, projects: context.projectsConfigurations.projects }, context.nxJsonConfiguration);
     return (0, devkit_internals_1.combineOptionsForExecutor)({}, configuration ?? targetConfiguration.defaultConfiguration ?? '', targetConfiguration, schema, defaultProject, (0, path_1.relative)(context.root, context.cwd));
 }

package/src/generators/format-files.d.ts

@@ -3,4 +3,9 @@ import { Tree } from 'nx/src/devkit-exports';
  * Formats all the created or updated files using Prettier
  * @param tree - the file system tree
  */
-export declare function formatFiles(tree: Tree): Promise<void>;
+export declare function formatFiles(tree: Tree, 
+/**
+ * TODO(v21): Stop sorting tsconfig paths by default, paths are now less common/important
+ * in Nx workspace setups, and the sorting causes comments to be lost.
+ */
+sortRootTsConfigPaths?: boolean): Promise<void>;

package/src/generators/format-files.js

@@ -8,13 +8,20 @@ const devkit_internals_1 = require("nx/src/devkit-internals");
  * Formats all the created or updated files using Prettier
  * @param tree - the file system tree
  */
-async function formatFiles(tree) {
+async function formatFiles(tree, 
+/**
+ * TODO(v21): Stop sorting tsconfig paths by default, paths are now less common/important
+ * in Nx workspace setups, and the sorting causes comments to be lost.
+ */
+sortRootTsConfigPaths = true) {
     let prettier;
     try {
         prettier = await Promise.resolve().then(() => require('prettier'));
     }
     catch { }
-    sortTsConfig(tree);
+    if (sortRootTsConfigPaths) {
+        sortTsConfig(tree);
+    }
     if (!prettier)
         return;
     const files = new Set(tree.listChanges().filter((file) => file.type !== 'DELETE'));

package/src/tasks/install-packages-task.js

@@ -27,7 +27,7 @@ function installPackagesTask(tree, alwaysRun = false, cwd = '', packageManager =
         const execSyncOptions = {
             cwd: (0, path_1.join)(tree.root, cwd),
             stdio: process.env.NX_GENERATE_QUIET === 'true' ? 'ignore' : 'inherit',
-            windowsHide: true,
+            windowsHide: false,
         };
         // ensure local registry from process is not interfering with the install
         // when we start the process from temp folder the local registry would override the custom registry

package/src/utils/package-json.js

@@ -305,7 +305,7 @@ function ensurePackage(pkgOrTree, requiredVersionOrPackage, maybeRequiredVersion
         (0, child_process_1.execSync)(preInstallCommand, {
             cwd: tempDir,
             stdio: isVerbose ? 'inherit' : 'ignore',
-            windowsHide: true,
+            windowsHide: false,
         });
     }
     let addCommand = (0, devkit_exports_1.getPackageManagerCommand)(packageManager).addDev;
@@ -315,7 +315,7 @@ function ensurePackage(pkgOrTree, requiredVersionOrPackage, maybeRequiredVersion
     (0, child_process_1.execSync)(`${addCommand} ${pkg}@${requiredVersion}`, {
         cwd: tempDir,
         stdio: isVerbose ? 'inherit' : 'ignore',
-        windowsHide: true,
+        windowsHide: false,
     });
     addToNodePath((0, path_1.join)(devkit_exports_1.workspaceRoot, 'node_modules'));
     addToNodePath((0, path_1.join)(tempDir, 'node_modules'));

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.d.ts

@@ -1,2 +0,0 @@
-import type { Tree } from 'nx/src/devkit-exports';
-export default function replacePackage(tree: Tree): Promise<void>;

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = replacePackage;
-const format_files_1 = require("../../generators/format-files");
-const replace_package_1 = require("../../utils/replace-package");
-async function replacePackage(tree) {
-    await (0, replace_package_1.replaceNrwlPackageWithNxPackage)(tree, '@nrwl/devkit', '@nx/devkit');
-    await (0, format_files_1.formatFiles)(tree);
-}

package/src/migrations/update-16-9-0/migrate-mf-util-usage.d.ts

@@ -1,3 +0,0 @@
-import { GeneratorCallback, Tree } from 'nx/src/devkit-exports';
-declare const _default: (tree: Tree) => Promise<GeneratorCallback | void>;
-export default _default;

package/src/migrations/update-16-9-0/migrate-mf-util-usage.js

@@ -1,200 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const visit_not_ignored_files_1 = require("../../generators/visit-not-ignored-files");
-const format_files_1 = require("../../generators/format-files");
-const package_json_1 = require("../../utils/package-json");
-const versions_1 = require("../../utils/versions");
-const devkit_exports_1 = require("nx/src/devkit-exports");
-let tsModule;
-const MODULE_FEDERATION_PUBLIC_TOKENS = [
-    'AdditionalSharedConfig',
-    'ModuleFederationConfig',
-    'SharedLibraryConfig',
-    'SharedWorkspaceLibraryConfig',
-    'WorkspaceLibrary',
-    'SharedFunction',
-    'WorkspaceLibrarySecondaryEntryPoint',
-    'Remotes',
-    'ModuleFederationLibrary',
-    'applySharedFunction',
-    'applyAdditionalShared',
-    'getNpmPackageSharedConfig',
-    'shareWorkspaceLibraries',
-    'sharePackages',
-    'mapRemotes',
-    'mapRemotesForSSR',
-    'getDependentPackagesForProject',
-    'readRootPackageJson',
-];
-exports.default = async (tree) => {
-    let hasFileToMigrate = false;
-    (0, visit_not_ignored_files_1.visitNotIgnoredFiles)(tree, '/', (path) => {
-        if (!path.endsWith('.ts') && !path.endsWith('.js')) {
-            return;
-        }
-        let fileContents = tree.read(path, 'utf-8');
-        if (MODULE_FEDERATION_PUBLIC_TOKENS.every((token) => !fileContents.includes(token))) {
-            return;
-        }
-        hasFileToMigrate = true;
-        fileContents = replaceTSImports(tree, path, fileContents);
-        fileContents = replaceRequireCalls(tree, path, fileContents);
-        fileContents = replaceJSDoc(tree, path, fileContents);
-        tree.write(path, fileContents);
-    });
-    if (hasFileToMigrate) {
-        await (0, format_files_1.formatFiles)(tree);
-        const pkgJson = (0, devkit_exports_1.readJson)(tree, 'package.json');
-        const nxVersion = pkgJson.devDependencies?.['nx'] ??
-            pkgJson.dependencies?.['nx'] ??
-            '17.0.0';
-        return (0, package_json_1.addDependenciesToPackageJson)(tree, {}, { '@nx/webpack': nxVersion });
-    }
-};
-function replaceJSDoc(tree, path, fileContents) {
-    let newFileContents = fileContents;
-    for (const token of MODULE_FEDERATION_PUBLIC_TOKENS) {
-        newFileContents = newFileContents.replaceAll(new RegExp(`(@type)+\\s({)+(\\s)*(import\\(('|")+@nx\/devkit('|")+\\)\.)+(${token})+\\s*(})+`, 'g'), `@type {import('@nx/webpack').${token}}`);
-    }
-    return newFileContents;
-}
-function replaceRequireCalls(tree, path, fileContents) {
-    if (!tsModule) {
-        tsModule = (0, package_json_1.ensurePackage)('typescript', versions_1.typescriptVersion);
-    }
-    const sourceFile = tsModule.createSourceFile(path, fileContents, tsModule.ScriptTarget.Latest, true);
-    const allDevkitRequires = findNodes(sourceFile, tsModule.SyntaxKind.VariableStatement)
-        .filter((node) => [`require("@nx/devkit")`, `require('@nx/devkit')`].some((r) => node.getText().includes(r)))
-        .filter((node) => findNodes(node, tsModule.SyntaxKind.ObjectBindingPattern).length);
-    const mfUtilRequires = allDevkitRequires.filter((node) => MODULE_FEDERATION_PUBLIC_TOKENS.some((token) => node.getText().includes(token)));
-    if (!mfUtilRequires.length) {
-        return fileContents;
-    }
-    const mfUtilTokens = mfUtilRequires.map((node) => {
-        const allTokens = findNodes(node, tsModule.SyntaxKind.BindingElement);
-        const mfTokens = allTokens.filter((node) => MODULE_FEDERATION_PUBLIC_TOKENS.some((token) => node.getText() === token));
-        return {
-            requireNode: node,
-            onlyMf: allTokens.length === mfTokens.length,
-            mfTokens,
-        };
-    });
-    const changes = [];
-    for (const mfUtilRequireData of mfUtilTokens) {
-        if (mfUtilRequireData.onlyMf) {
-            changes.push({
-                startPosition: mfUtilRequireData.requireNode.getStart(),
-                endPosition: mfUtilRequireData.requireNode.getEnd(),
-                content: '',
-            });
-        }
-        else {
-            for (const mfToken of mfUtilRequireData.mfTokens) {
-                const replaceTrailingComma = mfToken.getText().charAt(mfToken.getEnd() + 1) === ',';
-                changes.push({
-                    startPosition: mfToken.getStart(),
-                    endPosition: replaceTrailingComma
-                        ? mfToken.getEnd() + 1
-                        : mfToken.getEnd(),
-                    content: '',
-                });
-            }
-        }
-    }
-    changes.push({
-        startPosition: mfUtilTokens[mfUtilTokens.length - 1].requireNode.getEnd(),
-        content: `\nconst { ${mfUtilTokens
-            .map((mfUtilToken) => mfUtilToken.mfTokens.map((node) => node.getText()))
-            .join(', ')} } = require('@nx/webpack');`,
-    });
-    let newFileContents = fileContents;
-    while (changes.length) {
-        const change = changes.pop();
-        newFileContents = `${newFileContents.substring(0, change.startPosition)}${change.content}${newFileContents.substring(change.endPosition ? change.endPosition : change.startPosition)}`;
-    }
-    return newFileContents;
-}
-function replaceTSImports(tree, path, fileContents) {
-    if (!tsModule) {
-        tsModule = (0, package_json_1.ensurePackage)('typescript', versions_1.typescriptVersion);
-    }
-    const sourceFile = tsModule.createSourceFile(path, fileContents, tsModule.ScriptTarget.Latest, true);
-    const allImports = findNodes(sourceFile, tsModule.SyntaxKind.ImportDeclaration);
-    const devkitImports = allImports.filter((i) => i.getText().includes(`'@nx/devkit';`));
-    const mfUtilsImports = devkitImports.filter((i) => MODULE_FEDERATION_PUBLIC_TOKENS.some((token) => i.getText().includes(token)));
-    if (!mfUtilsImports.length) {
-        return fileContents;
-    }
-    const mfUtilsWithMultipleImports = mfUtilsImports.map((i) => {
-        const importSpecifierNodes = findNodes(i, tsModule.SyntaxKind.ImportSpecifier);
-        const mfImportSpecifierNodes = importSpecifierNodes.filter((node) => MODULE_FEDERATION_PUBLIC_TOKENS.some((token) => node.getText().includes(token)));
-        return {
-            importDeclarationNode: i,
-            onlyMf: mfImportSpecifierNodes.length === importSpecifierNodes.length,
-            mfImportSpecifierNodes,
-        };
-    });
-    const changes = [];
-    for (const importDeclaration of mfUtilsWithMultipleImports) {
-        if (importDeclaration.onlyMf) {
-            changes.push({
-                startPosition: importDeclaration.importDeclarationNode.getStart(),
-                endPosition: importDeclaration.importDeclarationNode.getEnd(),
-                content: '',
-            });
-        }
-        else {
-            for (const mfImportSpecifierNodes of importDeclaration.mfImportSpecifierNodes) {
-                const replaceTrailingComma = importDeclaration.importDeclarationNode
-                    .getText()
-                    .charAt(mfImportSpecifierNodes.getEnd() + 1) === ',';
-                changes.push({
-                    startPosition: mfImportSpecifierNodes.getStart(),
-                    endPosition: replaceTrailingComma
-                        ? mfImportSpecifierNodes.getEnd() + 1
-                        : mfImportSpecifierNodes.getEnd(),
-                    content: '',
-                });
-            }
-        }
-    }
-    changes.push({
-        startPosition: mfUtilsWithMultipleImports[mfUtilsWithMultipleImports.length - 1].importDeclarationNode.getEnd(),
-        content: `\nimport { ${mfUtilsWithMultipleImports
-            .map((importDeclaration) => importDeclaration.mfImportSpecifierNodes.map((node) => node.getText()))
-            .join(', ')} } from '@nx/webpack';`,
-    });
-    let newFileContents = fileContents;
-    while (changes.length) {
-        const change = changes.pop();
-        newFileContents = `${newFileContents.substring(0, change.startPosition)}${change.content}${newFileContents.substring(change.endPosition ? change.endPosition : change.startPosition)}`;
-    }
-    return newFileContents;
-}
-function findNodes(node, kind, max = Infinity) {
-    if (!node || max == 0) {
-        return [];
-    }
-    const arr = [];
-    const hasMatch = Array.isArray(kind)
-        ? kind.includes(node.kind)
-        : node.kind === kind;
-    if (hasMatch) {
-        arr.push(node);
-        max--;
-    }
-    if (max > 0) {
-        for (const child of node.getChildren()) {
-            findNodes(child, kind, max).forEach((node) => {
-                if (max > 0) {
-                    arr.push(node);
-                }
-                max--;
-            });
-            if (max <= 0) {
-                break;
-            }
-        }
-    }
-    return arr;
-}