nx 19.8.0-canary.20240917-5b34ea5 → 19.8.0-canary.20240919-7f4a877

package/src/utils/git-utils.index-filter.js

@@ -0,0 +1,20 @@
+/**
+ * This is meant to be used with `git filter-branch --index-filter` to rewrite
+ * history such that only commits related to the subdirectory is kept.
+ *
+ * Example:
+ * NX_IMPORT_SOURCE=<source> git filter-branch --index-filter 'node git-utils.index-filter.js' --prune-empty -- --all
+ */
+try {
+    const { execSync } = require('child_process');
+    // NOTE: Using env vars because Windows PowerShell has its own handling of quotes (") messes up quotes in args, even if escaped.
+    const src = process.env.NX_IMPORT_SOURCE;
+    execSync('git read-tree --empty', { stdio: 'inherit' });
+    execSync(`git reset ${process.env.GIT_COMMIT} -- "${src}"`, {
+        stdio: 'inherit',
+    });
+}
+catch (error) {
+    console.error(`Error executing Git commands: ${error}`);
+    process.exit(1);
+}

package/src/utils/git-utils.js

@@ -40,6 +40,10 @@ class GitRepository {
             .toString()
             .trim();
     }
+    async hasUncommittedChanges() {
+        const data = await this.execAsync(`git status --porcelain`);
+        return data.trim() !== '';
+    }
     async addFetchRemote(remoteName, branch) {
         return await this.execAsync(`git config --add remote.${remoteName}.fetch "+refs/heads/${branch}:refs/remotes/${remoteName}/${branch}"`);
     }
@@ -105,32 +109,63 @@ class GitRepository {
     }
     // git-filter-repo is much faster than filter-branch, but needs to be installed by user
     // Use `hasFilterRepoInstalled` to check if it's installed
-    async filterRepo(subdirectory) {
-        // filter-repo requires POSIX path to work
-        const posixPath = subdirectory.split(path_1.sep).join(path_1.posix.sep);
-        return await this.execAsync(`git filter-repo -f --subdirectory-filter ${this.quotePath(posixPath)}`);
-    }
-    async filterBranch(subdirectory, branchName) {
-        // filter-repo requires POSIX path to work
-        const posixPath = subdirectory.split(path_1.sep).join(path_1.posix.sep);
+    async filterRepo(source, destination) {
+        // NOTE: filter-repo requires POSIX path to work
+        const sourcePosixPath = source.split(path_1.sep).join(path_1.posix.sep);
+        const destinationPosixPath = destination.split(path_1.sep).join(path_1.posix.sep);
+        await this.execAsync(`git filter-repo -f ${source !== '' ? `--path ${this.quotePath(sourcePosixPath)}` : ''} ${source !== destination
+            ? `--path-rename ${this.quotePath(sourcePosixPath, true)}:${this.quotePath(destinationPosixPath, true)}`
+            : ''}`);
+    }
+    async filterBranch(source, destination, branchName) {
         // We need non-ASCII file names to not be quoted, or else filter-branch will exclude them.
         await this.execAsync(`git config core.quotepath false`);
-        return await this.execAsync(`git filter-branch --subdirectory-filter ${this.quotePath(posixPath)} -- ${branchName}`);
+        // NOTE: filter-repo requires POSIX path to work
+        const sourcePosixPath = source.split(path_1.sep).join(path_1.posix.sep);
+        const destinationPosixPath = destination.split(path_1.sep).join(path_1.posix.sep);
+        // First, if the source is not a root project, then only include commits relevant to the subdirectory.
+        if (source !== '') {
+            const indexFilterCommand = this.quoteArg(`node ${(0, path_1.join)(__dirname, 'git-utils.index-filter.js')}`);
+            await this.execAsync(`git filter-branch -f --index-filter ${indexFilterCommand} --prune-empty -- ${branchName}`, {
+                NX_IMPORT_SOURCE: sourcePosixPath,
+                NX_IMPORT_DESTINATION: destinationPosixPath,
+            });
+        }
+        // Then, move files to their new location if necessary.
+        if (source === '' || source !== destination) {
+            const treeFilterCommand = this.quoteArg(`node ${(0, path_1.join)(__dirname, 'git-utils.tree-filter.js')}`);
+            await this.execAsync(`git filter-branch -f --tree-filter ${treeFilterCommand} -- ${branchName}`, {
+                NX_IMPORT_SOURCE: sourcePosixPath,
+                NX_IMPORT_DESTINATION: destinationPosixPath,
+            });
+        }
     }
-    execAsync(command) {
+    execAsync(command, env) {
         return execAsync(command, {
             cwd: this.root,
             maxBuffer: 10 * 1024 * 1024,
+            env: {
+                ...process.env,
+                ...env,
+            },
         });
     }
-    quotePath(path) {
+    quotePath(path, ensureTrailingSlash) {
+        return this.quoteArg(ensureTrailingSlash && path !== '' && !path.endsWith('/')
+            ? `${path}/`
+            : path);
+    }
+    quoteArg(arg) {
         return process.platform === 'win32'
             ? // Windows/CMD only understands double-quotes, single-quotes are treated as part of the file name
                 // Bash and other shells will substitute `$` in file names with a variable value.
-                `"${path}"`
+                `"${arg
+                    // Need to keep two slashes for Windows or else the path will be invalid.
+                    // e.g. 'C:\Users\bob\projects\repo' is invalid, but 'C:\\Users\\bob\\projects\\repo' is valid
+                    .replaceAll('\\', '\\\\')}"`
             : // e.g. `git mv "$$file.txt" "libs/a/$$file.txt"` will not work since `$$` is swapped with the PID of the last process.
                 // Using single-quotes prevents this substitution.
-                `'${path}'`;
+                `'${arg}'`;
     }
 }
 exports.GitRepository = GitRepository;

package/src/utils/git-utils.tree-filter.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This is meant to be used with `git filter-branch --tree-filter` to rewrite
+ * history to only include commits related to the source project folder. If the
+ * destination folder is different, this script also moves the files over.
+ *
+ * Example:
+ * NX_IMPORT_SOURCE=<source> NX_IMPORT_DESTINATION=<destination> git filter-branch --tree-filter 'node git-utils.tree-filter.js' --prune-empty -- --all
+ */
+declare const execSync: any;
+declare const existsSync: any, mkdirSync: any, renameSync: any, rmSync: any;
+declare const posix: any;

package/src/utils/git-utils.tree-filter.js

@@ -0,0 +1,43 @@
+/**
+ * This is meant to be used with `git filter-branch --tree-filter` to rewrite
+ * history to only include commits related to the source project folder. If the
+ * destination folder is different, this script also moves the files over.
+ *
+ * Example:
+ * NX_IMPORT_SOURCE=<source> NX_IMPORT_DESTINATION=<destination> git filter-branch --tree-filter 'node git-utils.tree-filter.js' --prune-empty -- --all
+ */
+const { execSync } = require('child_process');
+const { existsSync, mkdirSync, renameSync, rmSync } = require('fs');
+// NOTE: The path passed to `git filter-branch` is POSIX, so we need to use the `posix` module.
+const { posix } = require('path');
+try {
+    // NOTE: Using env vars because Windows PowerShell has its own handling of quotes (") messes up quotes in args, even if escaped.
+    const src = process.env.NX_IMPORT_SOURCE;
+    const dest = process.env.NX_IMPORT_DESTINATION;
+    const files = execSync(`git ls-files -z ${src}`)
+        .toString()
+        .trim()
+        .split('\x00')
+        .map((s) => s.trim())
+        .filter(Boolean);
+    for (const file of files) {
+        if (src === '' || file.startsWith(src)) {
+            // If source and destination are the same, then keep the file as is.
+            if (src === dest)
+                continue;
+            const destFile = posix.join(dest, file.replace(src, ''));
+            const dir = posix.dirname(destFile);
+            if (!existsSync(dir))
+                mkdirSync(dir, { recursive: true });
+            renameSync(file, destFile);
+        }
+        else {
+            // If not matching the source we are filtering, remove it.
+            rmSync(file);
+        }
+    }
+}
+catch (error) {
+    console.error(`Error executing Git commands: ${error}`);
+    process.exit(1);
+}

package/src/utils/plugins/output.d.ts

@@ -2,4 +2,5 @@ import { ProjectConfiguration } from '../../config/workspace-json-project-json';
 import { PluginCapabilities } from './plugin-capabilities';
 export declare function listPlugins(plugins: Map<string, PluginCapabilities>, title: string): void;
 export declare function listAlsoAvailableCorePlugins(installedPlugins: Map<string, PluginCapabilities>): void;
+export declare function listPowerpackPlugins(): void;
 export declare function listPluginCapabilities(pluginName: string, projects: Record<string, ProjectConfiguration>): Promise<void>;

package/src/utils/plugins/output.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.listPlugins = listPlugins;
 exports.listAlsoAvailableCorePlugins = listAlsoAvailableCorePlugins;
+exports.listPowerpackPlugins = listPowerpackPlugins;
 exports.listPluginCapabilities = listPluginCapabilities;
 const chalk = require("chalk");
 const output_1 = require("../output");
@@ -45,6 +46,12 @@ function listAlsoAvailableCorePlugins(installedPlugins) {
         });
     }
 }
+function listPowerpackPlugins() {
+    const powerpackLink = 'https://nx.dev/plugin-registry';
+    output_1.output.log({
+        title: `Available Powerpack Plugins: ${powerpackLink}`,
+    });
+}
 async function listPluginCapabilities(pluginName, projects) {
     const plugin = await (0, plugin_capabilities_1.getPluginCapabilities)(workspace_root_1.workspaceRoot, pluginName, projects);
     if (!plugin) {

package/src/utils/powerpack.d.ts

@@ -0,0 +1,5 @@
+export declare function printPowerpackLicense(): Promise<void>;
+export declare function getPowerpackLicenseInformation(): Promise<any>;
+export declare class NxPowerpackNotInstalledError extends Error {
+    constructor(e: Error);
+}

package/src/utils/powerpack.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NxPowerpackNotInstalledError = void 0;
+exports.printPowerpackLicense = printPowerpackLicense;
+exports.getPowerpackLicenseInformation = getPowerpackLicenseInformation;
+const logger_1 = require("./logger");
+const package_manager_1 = require("./package-manager");
+const workspace_root_1 = require("./workspace-root");
+async function printPowerpackLicense() {
+    try {
+        const { organizationName, seatCount, workspaceCount } = await getPowerpackLicenseInformation();
+        logger_1.logger.log(`Nx Powerpack Licensed to ${organizationName} for ${seatCount} user${seatCount > 1 ? '' : 's'} in ${workspaceCount} workspace${workspaceCount > 1 ? '' : 's'}`);
+    }
+    catch { }
+}
+async function getPowerpackLicenseInformation() {
+    try {
+        const { getPowerpackLicenseInformation } = (await Promise.resolve().then(() => require(
+        // @ts-ignore
+        '@nx/powerpack-license'
+        // TODO(@FrozenPandaz): Provide the right type here.
+        )));
+        // )) as typeof import('@nx/powerpack-license');
+        return getPowerpackLicenseInformation(workspace_root_1.workspaceRoot);
+    }
+    catch (e) {
+        if ('code' in e && e.code === 'ERR_MODULE_NOT_FOUND') {
+            throw new NxPowerpackNotInstalledError(e);
+        }
+        throw e;
+    }
+}
+class NxPowerpackNotInstalledError extends Error {
+    constructor(e) {
+        super(`The "@nx/powerpack-license" package is needed to use Nx Powerpack enabled features. Please install the @nx/powerpack-license with ${(0, package_manager_1.getPackageManagerCommand)().addDev} @nx/powerpack-license`, { cause: e });
+    }
+}
+exports.NxPowerpackNotInstalledError = NxPowerpackNotInstalledError;