@rushstack/package-extractor 0.8.1 → 0.9.1

package/lib/scripts/create-links.js

@@ -1,145 +1,119 @@
 "use strict";
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __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 });
 // THIS SCRIPT IS GENERATED BY THE "rush deploy" COMMAND.
-/* eslint-disable no-console */
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
+const node_os_1 = __importDefault(require("node:os"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+const terminal_1 = require("@rushstack/terminal");
+const MAX_CONCURRENCY = node_os_1.default.cpus().length * 2;
+const CREATE_ACTION_NAME = 'create';
+const REMOVE_ACTION_NAME = 'remove';
+const REALIZE_FILES_OPTION_NAME = '--realize-files';
 const TARGET_ROOT_SCRIPT_RELATIVE_PATH = '{TARGET_ROOT_SCRIPT_RELATIVE_PATH}';
-const TARGET_ROOT_FOLDER = path.resolve(__dirname, TARGET_ROOT_SCRIPT_RELATIVE_PATH);
-// API borrowed from @rushstack/node-core-library, since this script avoids using any
-// NPM dependencies.
-class FileSystem {
-    static createSymbolicLinkJunction(options) {
-        fs.symlinkSync(options.linkTargetPath, options.newLinkPath, 'junction');
-    }
-    static createSymbolicLinkFile(options) {
-        fs.symlinkSync(options.linkTargetPath, options.newLinkPath, 'file');
-    }
-    static createSymbolicLinkFolder(options) {
-        fs.symlinkSync(options.linkTargetPath, options.newLinkPath, 'dir');
-    }
-    static createHardLink(options) {
-        fs.linkSync(options.linkTargetPath, options.newLinkPath);
-    }
-}
-function ensureFolder(folderPath) {
-    if (!folderPath) {
-        return;
-    }
-    if (fs.existsSync(folderPath)) {
-        return;
-    }
-    const parentPath = path.dirname(folderPath);
-    if (parentPath && parentPath !== folderPath) {
-        ensureFolder(parentPath);
-    }
-    fs.mkdirSync(folderPath);
-}
-function removeLinks(targetRootFolder, extractorMetadataObject) {
-    for (const linkInfo of extractorMetadataObject.links) {
-        // Link to the relative path for symlinks
-        const newLinkPath = path.join(targetRootFolder, linkInfo.linkPath);
-        if (fs.existsSync(newLinkPath)) {
-            fs.unlinkSync(newLinkPath);
-        }
-    }
+const TARGET_ROOT_FOLDER = node_path_1.default.resolve(__dirname, TARGET_ROOT_SCRIPT_RELATIVE_PATH);
+async function removeLinksAsync(terminal, targetRootFolder, extractorMetadataObject) {
+    await node_core_library_1.Async.forEachAsync(extractorMetadataObject.links, async ({ linkPath }) => {
+        const newLinkPath = `${targetRootFolder}/${linkPath}`;
+        terminal.writeVerboseLine(`Removing link at path "${newLinkPath}"`);
+        await node_core_library_1.FileSystem.deleteFileAsync(newLinkPath, { throwIfNotExists: false });
+    }, { concurrency: MAX_CONCURRENCY });
 }
-function createLinks(targetRootFolder, extractorMetadataObject) {
-    for (const linkInfo of extractorMetadataObject.links) {
+async function createLinksAsync(terminal, targetRootFolder, extractorMetadataObject) {
+    await node_core_library_1.Async.forEachAsync(extractorMetadataObject.links, async (linkInfo) => {
         // Link to the relative path for symlinks
-        const newLinkPath = path.join(targetRootFolder, linkInfo.linkPath);
-        const linkTargetPath = path.join(targetRootFolder, linkInfo.targetPath);
+        const newLinkPath = `${targetRootFolder}/${linkInfo.linkPath}`;
+        const linkTargetPath = `${targetRootFolder}/${linkInfo.targetPath}`;
         // Make sure the containing folder exists
-        ensureFolder(path.dirname(newLinkPath));
+        await node_core_library_1.FileSystem.ensureFolderAsync(node_path_1.default.dirname(newLinkPath));
         // NOTE: This logic is based on NpmLinkManager._createSymlink()
-        if (process.platform === 'win32') {
-            if (linkInfo.kind === 'folderLink') {
-                // For directories, we use a Windows "junction".  On Unix, this produces a regular symlink.
-                FileSystem.createSymbolicLinkJunction({ newLinkPath, linkTargetPath });
+        if (linkInfo.kind === 'folderLink') {
+            terminal.writeVerboseLine(`Creating linked folder at path "${newLinkPath}"`);
+            await node_core_library_1.FileSystem.createSymbolicLinkJunctionAsync({ newLinkPath, linkTargetPath });
+        }
+        else if (linkInfo.kind === 'fileLink') {
+            // Use hardlinks for Windows and symlinks for other platforms since creating a symbolic link
+            // requires administrator permission on Windows. This may cause unexpected behaviour for consumers
+            // of the hardlinked files. If this becomes an issue, we may need to revisit this.
+            terminal.writeVerboseLine(`Creating linked file at path "${newLinkPath}"`);
+            if (process.platform === 'win32') {
+                await node_core_library_1.FileSystem.createHardLinkAsync({ newLinkPath, linkTargetPath });
             }
             else {
-                // For files, we use a Windows "hard link", because creating a symbolic link requires
-                // administrator permission.
-                // NOTE: We cannot use the relative path for hard links
-                FileSystem.createHardLink({ newLinkPath, linkTargetPath });
+                await node_core_library_1.FileSystem.createSymbolicLinkFileAsync({ newLinkPath, linkTargetPath });
             }
         }
-        else {
-            // However hard links seem to cause build failures on Mac, so for all other operating systems
-            // we use symbolic links for this case.
-            if (linkInfo.kind === 'folderLink') {
-                FileSystem.createSymbolicLinkFolder({ newLinkPath, linkTargetPath });
+    }, { concurrency: MAX_CONCURRENCY });
+}
+async function realizeFilesAsync(terminal, targetRootFolder, extractorMetadataObject) {
+    await node_core_library_1.Async.forEachAsync(extractorMetadataObject.files, async (relativeFilePath) => {
+        const filePath = `${targetRootFolder}/${relativeFilePath}`;
+        const realFilePath = await node_core_library_1.FileSystem.getRealPathAsync(filePath);
+        if (!node_core_library_1.Path.isEqual(realFilePath, filePath)) {
+            await node_core_library_1.FileSystem.deleteFileAsync(filePath);
+            // Hard links seem to cause build failures on Mac, so for all other operating
+            // systems we copy files.
+            terminal.writeVerboseLine(`Realizing file at path "${filePath}"`);
+            if (process.platform === 'win32') {
+                await node_core_library_1.FileSystem.createHardLinkAsync({ newLinkPath: filePath, linkTargetPath: realFilePath });
             }
             else {
-                FileSystem.createSymbolicLinkFile({ newLinkPath, linkTargetPath });
+                await node_core_library_1.FileSystem.copyFileAsync({ sourcePath: realFilePath, destinationPath: filePath });
             }
         }
-    }
+    }, { concurrency: MAX_CONCURRENCY });
 }
-function showUsage() {
-    console.log('Usage:');
-    console.log('  node create-links.js create');
-    console.log('  node create-links.js remove');
-    console.log('\nCreates or removes the symlinks for the output folder created by "rush deploy".');
-    console.log('The link information is read from "extractor-metadata.json" in the same folder.');
+function showUsage(terminal) {
+    terminal.writeLine('Usage:');
+    terminal.writeLine(`  node create-links.js ${CREATE_ACTION_NAME} [${REALIZE_FILES_OPTION_NAME}]`);
+    terminal.writeLine(`  node create-links.js ${REMOVE_ACTION_NAME}`);
+    terminal.writeLine('');
+    terminal.writeLine('Creates or removes the symlinks for the output folder created by "rush deploy".');
+    terminal.writeLine('The link information is read from "extractor-metadata.json" in the same folder.');
 }
-function main() {
+async function runAsync(terminal) {
     // Example: [ "node.exe", "create-links.js", ""create" ]
     const args = process.argv.slice(2);
-    if (args.length !== 1 || (args[0] !== 'create' && args[0] !== 'remove')) {
-        showUsage();
+    if ((args[0] !== CREATE_ACTION_NAME && args[0] !== REMOVE_ACTION_NAME) ||
+        (args[0] === CREATE_ACTION_NAME && args[1] && args[1] !== REALIZE_FILES_OPTION_NAME) ||
+        (args[0] === REMOVE_ACTION_NAME && args[1])) {
+        showUsage(terminal);
         return false;
     }
     const extractorMetadataPath = `${__dirname}/extractor-metadata.json`;
-    if (!fs.existsSync(extractorMetadataPath)) {
+    if (!node_fs_1.default.existsSync(extractorMetadataPath)) {
         throw new Error('Input file not found: ' + extractorMetadataPath);
     }
-    const extractorMetadataJson = fs.readFileSync(extractorMetadataPath).toString();
+    const extractorMetadataJson = node_fs_1.default.readFileSync(extractorMetadataPath).toString();
     const extractorMetadataObject = JSON.parse(extractorMetadataJson);
     if (args[0] === 'create') {
-        console.log(`\nCreating links for extraction at path "${TARGET_ROOT_FOLDER}"`);
-        removeLinks(TARGET_ROOT_FOLDER, extractorMetadataObject);
-        createLinks(TARGET_ROOT_FOLDER, extractorMetadataObject);
+        const realizeFiles = args[1] === '--realize-files';
+        terminal.writeLine(`Creating links for extraction at path "${TARGET_ROOT_FOLDER}"`);
+        await removeLinksAsync(terminal, TARGET_ROOT_FOLDER, extractorMetadataObject);
+        await createLinksAsync(terminal, TARGET_ROOT_FOLDER, extractorMetadataObject);
+        if (realizeFiles) {
+            await realizeFilesAsync(terminal, TARGET_ROOT_FOLDER, extractorMetadataObject);
+        }
     }
-    else {
-        console.log(`\nRemoving links for extraction at path "${TARGET_ROOT_FOLDER}"`);
-        removeLinks(TARGET_ROOT_FOLDER, extractorMetadataObject);
+    else if (args[0] === 'remove') {
+        terminal.writeLine(`Removing links for extraction at path "${TARGET_ROOT_FOLDER}"`);
+        await removeLinksAsync(terminal, TARGET_ROOT_FOLDER, extractorMetadataObject);
     }
-    console.log('The operation completed successfully.');
+    terminal.writeLine('The operation completed successfully.');
     return true;
 }
-try {
-    process.exitCode = 1;
-    if (main()) {
-        process.exitCode = 0;
-    }
-}
-catch (error) {
-    console.log('ERROR: ' + error);
-}
+process.exitCode = 1;
+const terminal = new terminal_1.Terminal(new terminal_1.ConsoleTerminalProvider());
+runAsync(terminal)
+    .then((result) => {
+    process.exitCode = result ? 0 : 1;
+})
+    .catch((error) => {
+    terminal.writeErrorLine('ERROR: ' + error);
+});
 //# sourceMappingURL=create-links.js.map

package/lib/scripts/create-links.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-links.js","sourceRoot":"","sources":["../../src/scripts/create-links.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,yDAAyD;AAEzD,+BAA+B;AAE/B,uCAAyB;AACzB,2CAA6B;AAO7B,MAAM,gCAAgC,GACpC,oCAAoC,CAAC;AACvC,MAAM,kBAAkB,GAAW,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;AAE7F,qFAAqF;AACrF,oBAAoB;AACpB,MAAM,UAAU;IACP,MAAM,CAAC,0BAA0B,CAAC,OAAqC;QAC5E,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAEM,MAAM,CAAC,sBAAsB,CAAC,OAAqC;QACxE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,wBAAwB,CAAC,OAAqC;QAC1E,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,OAAqC;QAChE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,SAAS,YAAY,CAAC,UAAkB;IACtC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IACD,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IACD,MAAM,UAAU,GAAW,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACpD,IAAI,UAAU,IAAI,UAAU,KAAK,UAAU,EAAE,CAAC;QAC5C,YAAY,CAAC,UAAU,CAAC,CAAC;IAC3B,CAAC;IACD,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,WAAW,CAAC,gBAAwB,EAAE,uBAA+C;IAC5F,KAAK,MAAM,QAAQ,IAAI,uBAAuB,CAAC,KAAK,EAAE,CAAC;QACrD,yCAAyC;QACzC,MAAM,WAAW,GAAW,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3E,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,gBAAwB,EAAE,uBAA+C;IAC5F,KAAK,MAAM,QAAQ,IAAI,uBAAuB,CAAC,KAAK,EAAE,CAAC;QACrD,yCAAyC;QACzC,MAAM,WAAW,GAAW,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3E,MAAM,cAAc,GAAW,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;QAEhF,yCAAyC;QACzC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;QAExC,+DAA+D;QAC/D,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YACjC,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACnC,2FAA2F;gBAC3F,UAAU,CAAC,0BAA0B,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;YACzE,CAAC;iBAAM,CAAC;gBACN,qFAAqF;gBACrF,4BAA4B;gBAE5B,uDAAuD;gBACvD,UAAU,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,6FAA6F;YAC7F,uCAAuC;YACvC,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACnC,UAAU,CAAC,wBAAwB,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;YACvE,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,SAAS;IAChB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACtB,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAE7C,OAAO,CAAC,GAAG,CAAC,mFAAmF,CAAC,CAAC;IACjG,OAAO,CAAC,GAAG,CAAC,iFAAiF,CAAC,CAAC;AACjG,CAAC;AAED,SAAS,IAAI;IACX,wDAAwD;IACxD,MAAM,IAAI,GAAa,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAE7C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;QACxE,SAAS,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,qBAAqB,GAAW,GAAG,SAAS,0BAA0B,CAAC;IAC7E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,qBAAqB,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,qBAAqB,GAAW,EAAE,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE,CAAC;IACxF,MAAM,uBAAuB,GAA2B,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAE1F,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QACzB,OAAO,CAAC,GAAG,CAAC,4CAA4C,kBAAkB,GAAG,CAAC,CAAC;QAC/E,WAAW,CAAC,kBAAkB,EAAE,uBAAuB,CAAC,CAAC;QACzD,WAAW,CAAC,kBAAkB,EAAE,uBAAuB,CAAC,CAAC;IAC3D,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,4CAA4C,kBAAkB,GAAG,CAAC,CAAC;QAC/E,WAAW,CAAC,kBAAkB,EAAE,uBAAuB,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;IACrD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,IAAI,CAAC;IACH,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACrB,IAAI,IAAI,EAAE,EAAE,CAAC;QACX,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,OAAO,CAAC,GAAG,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC;AACjC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n// THIS SCRIPT IS GENERATED BY THE \"rush deploy\" COMMAND.\n\n/* eslint-disable no-console */\n\nimport * as fs from 'fs';\nimport * as path from 'path';\nimport type { IFileSystemCreateLinkOptions } from '@rushstack/node-core-library';\nimport type {\n  TARGET_ROOT_SCRIPT_RELATIVE_PATH_TEMPLATE_STRING as TargetRootScriptRelativePathTemplateString,\n  IExtractorMetadataJson\n} from '../PackageExtractor';\n\nconst TARGET_ROOT_SCRIPT_RELATIVE_PATH: typeof TargetRootScriptRelativePathTemplateString =\n  '{TARGET_ROOT_SCRIPT_RELATIVE_PATH}';\nconst TARGET_ROOT_FOLDER: string = path.resolve(__dirname, TARGET_ROOT_SCRIPT_RELATIVE_PATH);\n\n// API borrowed from @rushstack/node-core-library, since this script avoids using any\n// NPM dependencies.\nclass FileSystem {\n  public static createSymbolicLinkJunction(options: IFileSystemCreateLinkOptions): void {\n    fs.symlinkSync(options.linkTargetPath, options.newLinkPath, 'junction');\n  }\n\n  public static createSymbolicLinkFile(options: IFileSystemCreateLinkOptions): void {\n    fs.symlinkSync(options.linkTargetPath, options.newLinkPath, 'file');\n  }\n\n  public static createSymbolicLinkFolder(options: IFileSystemCreateLinkOptions): void {\n    fs.symlinkSync(options.linkTargetPath, options.newLinkPath, 'dir');\n  }\n\n  public static createHardLink(options: IFileSystemCreateLinkOptions): void {\n    fs.linkSync(options.linkTargetPath, options.newLinkPath);\n  }\n}\n\nfunction ensureFolder(folderPath: string): void {\n  if (!folderPath) {\n    return;\n  }\n  if (fs.existsSync(folderPath)) {\n    return;\n  }\n  const parentPath: string = path.dirname(folderPath);\n  if (parentPath && parentPath !== folderPath) {\n    ensureFolder(parentPath);\n  }\n  fs.mkdirSync(folderPath);\n}\n\nfunction removeLinks(targetRootFolder: string, extractorMetadataObject: IExtractorMetadataJson): void {\n  for (const linkInfo of extractorMetadataObject.links) {\n    // Link to the relative path for symlinks\n    const newLinkPath: string = path.join(targetRootFolder, linkInfo.linkPath);\n    if (fs.existsSync(newLinkPath)) {\n      fs.unlinkSync(newLinkPath);\n    }\n  }\n}\n\nfunction createLinks(targetRootFolder: string, extractorMetadataObject: IExtractorMetadataJson): void {\n  for (const linkInfo of extractorMetadataObject.links) {\n    // Link to the relative path for symlinks\n    const newLinkPath: string = path.join(targetRootFolder, linkInfo.linkPath);\n    const linkTargetPath: string = path.join(targetRootFolder, linkInfo.targetPath);\n\n    // Make sure the containing folder exists\n    ensureFolder(path.dirname(newLinkPath));\n\n    // NOTE: This logic is based on NpmLinkManager._createSymlink()\n    if (process.platform === 'win32') {\n      if (linkInfo.kind === 'folderLink') {\n        // For directories, we use a Windows \"junction\".  On Unix, this produces a regular symlink.\n        FileSystem.createSymbolicLinkJunction({ newLinkPath, linkTargetPath });\n      } else {\n        // For files, we use a Windows \"hard link\", because creating a symbolic link requires\n        // administrator permission.\n\n        // NOTE: We cannot use the relative path for hard links\n        FileSystem.createHardLink({ newLinkPath, linkTargetPath });\n      }\n    } else {\n      // However hard links seem to cause build failures on Mac, so for all other operating systems\n      // we use symbolic links for this case.\n      if (linkInfo.kind === 'folderLink') {\n        FileSystem.createSymbolicLinkFolder({ newLinkPath, linkTargetPath });\n      } else {\n        FileSystem.createSymbolicLinkFile({ newLinkPath, linkTargetPath });\n      }\n    }\n  }\n}\n\nfunction showUsage(): void {\n  console.log('Usage:');\n  console.log('  node create-links.js create');\n  console.log('  node create-links.js remove');\n\n  console.log('\\nCreates or removes the symlinks for the output folder created by \"rush deploy\".');\n  console.log('The link information is read from \"extractor-metadata.json\" in the same folder.');\n}\n\nfunction main(): boolean {\n  // Example: [ \"node.exe\", \"create-links.js\", \"\"create\" ]\n  const args: string[] = process.argv.slice(2);\n\n  if (args.length !== 1 || (args[0] !== 'create' && args[0] !== 'remove')) {\n    showUsage();\n    return false;\n  }\n\n  const extractorMetadataPath: string = `${__dirname}/extractor-metadata.json`;\n  if (!fs.existsSync(extractorMetadataPath)) {\n    throw new Error('Input file not found: ' + extractorMetadataPath);\n  }\n\n  const extractorMetadataJson: string = fs.readFileSync(extractorMetadataPath).toString();\n  const extractorMetadataObject: IExtractorMetadataJson = JSON.parse(extractorMetadataJson);\n\n  if (args[0] === 'create') {\n    console.log(`\\nCreating links for extraction at path \"${TARGET_ROOT_FOLDER}\"`);\n    removeLinks(TARGET_ROOT_FOLDER, extractorMetadataObject);\n    createLinks(TARGET_ROOT_FOLDER, extractorMetadataObject);\n  } else {\n    console.log(`\\nRemoving links for extraction at path \"${TARGET_ROOT_FOLDER}\"`);\n    removeLinks(TARGET_ROOT_FOLDER, extractorMetadataObject);\n  }\n\n  console.log('The operation completed successfully.');\n  return true;\n}\n\ntry {\n  process.exitCode = 1;\n  if (main()) {\n    process.exitCode = 0;\n  }\n} catch (error) {\n  console.log('ERROR: ' + error);\n}\n"]}
+{"version":3,"file":"create-links.js","sourceRoot":"","sources":["../../src/scripts/create-links.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;AAE3D,yDAAyD;AAEzD,sDAAyB;AACzB,sDAAyB;AACzB,0DAA6B;AAC7B,oEAAuE;AACvE,kDAAwE;AAMxE,MAAM,eAAe,GAAW,iBAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;AACrD,MAAM,kBAAkB,GAAa,QAAQ,CAAC;AAC9C,MAAM,kBAAkB,GAAa,QAAQ,CAAC;AAC9C,MAAM,yBAAyB,GAAsB,iBAAiB,CAAC;AAEvE,MAAM,gCAAgC,GACpC,oCAAoC,CAAC;AACvC,MAAM,kBAAkB,GAAW,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;AAE7F,KAAK,UAAU,gBAAgB,CAC7B,QAAkB,EAClB,gBAAwB,EACxB,uBAA+C;IAE/C,MAAM,yBAAK,CAAC,YAAY,CACtB,uBAAuB,CAAC,KAAK,EAC7B,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;QACrB,MAAM,WAAW,GAAW,GAAG,gBAAgB,IAAI,QAAQ,EAAE,CAAC;QAC9D,QAAQ,CAAC,gBAAgB,CAAC,0BAA0B,WAAW,GAAG,CAAC,CAAC;QACpE,MAAM,8BAAU,CAAC,eAAe,CAAC,WAAW,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7E,CAAC,EACD,EAAE,WAAW,EAAE,eAAe,EAAE,CACjC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,QAAkB,EAClB,gBAAwB,EACxB,uBAA+C;IAE/C,MAAM,yBAAK,CAAC,YAAY,CACtB,uBAAuB,CAAC,KAAK,EAC7B,KAAK,EAAE,QAAQ,EAAE,EAAE;QACjB,yCAAyC;QACzC,MAAM,WAAW,GAAW,GAAG,gBAAgB,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACvE,MAAM,cAAc,GAAW,GAAG,gBAAgB,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;QAE5E,yCAAyC;QACzC,MAAM,8BAAU,CAAC,iBAAiB,CAAC,mBAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;QAE9D,+DAA+D;QAC/D,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACnC,QAAQ,CAAC,gBAAgB,CAAC,mCAAmC,WAAW,GAAG,CAAC,CAAC;YAC7E,MAAM,8BAAU,CAAC,+BAA+B,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;QACpF,CAAC;aAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACxC,4FAA4F;YAC5F,kGAAkG;YAClG,kFAAkF;YAClF,QAAQ,CAAC,gBAAgB,CAAC,iCAAiC,WAAW,GAAG,CAAC,CAAC;YAC3E,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;gBACjC,MAAM,8BAAU,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;YACxE,CAAC;iBAAM,CAAC;gBACN,MAAM,8BAAU,CAAC,2BAA2B,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;YAChF,CAAC;QACH,CAAC;IACH,CAAC,EACD,EAAE,WAAW,EAAE,eAAe,EAAE,CACjC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,QAAkB,EAClB,gBAAwB,EACxB,uBAA+C;IAE/C,MAAM,yBAAK,CAAC,YAAY,CACtB,uBAAuB,CAAC,KAAK,EAC7B,KAAK,EAAE,gBAAgB,EAAE,EAAE;QACzB,MAAM,QAAQ,GAAW,GAAG,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;QACnE,MAAM,YAAY,GAAW,MAAM,8BAAU,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,wBAAI,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;YAC1C,MAAM,8BAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;YAE3C,6EAA6E;YAC7E,yBAAyB;YACzB,QAAQ,CAAC,gBAAgB,CAAC,2BAA2B,QAAQ,GAAG,CAAC,CAAC;YAClE,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;gBACjC,MAAM,8BAAU,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC,CAAC;YAChG,CAAC;iBAAM,CAAC;gBACN,MAAM,8BAAU,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC1F,CAAC;QACH,CAAC;IACH,CAAC,EACD,EAAE,WAAW,EAAE,eAAe,EAAE,CACjC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,QAAkB;IACnC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC7B,QAAQ,CAAC,SAAS,CAAC,0BAA0B,kBAAkB,KAAK,yBAAyB,GAAG,CAAC,CAAC;IAClG,QAAQ,CAAC,SAAS,CAAC,0BAA0B,kBAAkB,EAAE,CAAC,CAAC;IACnE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACvB,QAAQ,CAAC,SAAS,CAAC,iFAAiF,CAAC,CAAC;IACtG,QAAQ,CAAC,SAAS,CAAC,iFAAiF,CAAC,CAAC;AACxG,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,QAAkB;IACxC,wDAAwD;IACxD,MAAM,IAAI,GAAa,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7C,IACE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,kBAAkB,CAAC;QAClE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,yBAAyB,CAAC;QACpF,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,EAC3C,CAAC;QACD,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,qBAAqB,GAAW,GAAG,SAAS,0BAA0B,CAAC;IAC7E,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,qBAAqB,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,qBAAqB,GAAW,iBAAE,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE,CAAC;IACxF,MAAM,uBAAuB,GAA2B,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAE1F,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QACzB,MAAM,YAAY,GAAY,IAAI,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAC;QAC5D,QAAQ,CAAC,SAAS,CAAC,0CAA0C,kBAAkB,GAAG,CAAC,CAAC;QACpF,MAAM,gBAAgB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,uBAAuB,CAAC,CAAC;QAC9E,MAAM,gBAAgB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,uBAAuB,CAAC,CAAC;QAC9E,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,uBAAuB,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;SAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,SAAS,CAAC,0CAA0C,kBAAkB,GAAG,CAAC,CAAC;QACpF,MAAM,gBAAgB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,uBAAuB,CAAC,CAAC;IAChF,CAAC;IAED,QAAQ,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC;IAC5D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACrB,MAAM,QAAQ,GAAa,IAAI,mBAAQ,CAAC,IAAI,kCAAuB,EAAE,CAAC,CAAC;AACvE,QAAQ,CAAC,QAAQ,CAAC;KACf,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;IACf,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC,CAAC;KACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACf,QAAQ,CAAC,cAAc,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n// THIS SCRIPT IS GENERATED BY THE \"rush deploy\" COMMAND.\n\nimport os from 'node:os';\nimport fs from 'node:fs';\nimport path from 'node:path';\nimport { Async, FileSystem, Path } from '@rushstack/node-core-library';\nimport { Terminal, ConsoleTerminalProvider } from '@rushstack/terminal';\nimport type {\n  TARGET_ROOT_SCRIPT_RELATIVE_PATH_TEMPLATE_STRING as TargetRootScriptRelativePathTemplateString,\n  IExtractorMetadataJson\n} from '../PackageExtractor';\n\nconst MAX_CONCURRENCY: number = os.cpus().length * 2;\nconst CREATE_ACTION_NAME: 'create' = 'create';\nconst REMOVE_ACTION_NAME: 'remove' = 'remove';\nconst REALIZE_FILES_OPTION_NAME: '--realize-files' = '--realize-files';\n\nconst TARGET_ROOT_SCRIPT_RELATIVE_PATH: typeof TargetRootScriptRelativePathTemplateString =\n  '{TARGET_ROOT_SCRIPT_RELATIVE_PATH}';\nconst TARGET_ROOT_FOLDER: string = path.resolve(__dirname, TARGET_ROOT_SCRIPT_RELATIVE_PATH);\n\nasync function removeLinksAsync(\n  terminal: Terminal,\n  targetRootFolder: string,\n  extractorMetadataObject: IExtractorMetadataJson\n): Promise<void> {\n  await Async.forEachAsync(\n    extractorMetadataObject.links,\n    async ({ linkPath }) => {\n      const newLinkPath: string = `${targetRootFolder}/${linkPath}`;\n      terminal.writeVerboseLine(`Removing link at path \"${newLinkPath}\"`);\n      await FileSystem.deleteFileAsync(newLinkPath, { throwIfNotExists: false });\n    },\n    { concurrency: MAX_CONCURRENCY }\n  );\n}\n\nasync function createLinksAsync(\n  terminal: Terminal,\n  targetRootFolder: string,\n  extractorMetadataObject: IExtractorMetadataJson\n): Promise<void> {\n  await Async.forEachAsync(\n    extractorMetadataObject.links,\n    async (linkInfo) => {\n      // Link to the relative path for symlinks\n      const newLinkPath: string = `${targetRootFolder}/${linkInfo.linkPath}`;\n      const linkTargetPath: string = `${targetRootFolder}/${linkInfo.targetPath}`;\n\n      // Make sure the containing folder exists\n      await FileSystem.ensureFolderAsync(path.dirname(newLinkPath));\n\n      // NOTE: This logic is based on NpmLinkManager._createSymlink()\n      if (linkInfo.kind === 'folderLink') {\n        terminal.writeVerboseLine(`Creating linked folder at path \"${newLinkPath}\"`);\n        await FileSystem.createSymbolicLinkJunctionAsync({ newLinkPath, linkTargetPath });\n      } else if (linkInfo.kind === 'fileLink') {\n        // Use hardlinks for Windows and symlinks for other platforms since creating a symbolic link\n        // requires administrator permission on Windows. This may cause unexpected behaviour for consumers\n        // of the hardlinked files. If this becomes an issue, we may need to revisit this.\n        terminal.writeVerboseLine(`Creating linked file at path \"${newLinkPath}\"`);\n        if (process.platform === 'win32') {\n          await FileSystem.createHardLinkAsync({ newLinkPath, linkTargetPath });\n        } else {\n          await FileSystem.createSymbolicLinkFileAsync({ newLinkPath, linkTargetPath });\n        }\n      }\n    },\n    { concurrency: MAX_CONCURRENCY }\n  );\n}\n\nasync function realizeFilesAsync(\n  terminal: Terminal,\n  targetRootFolder: string,\n  extractorMetadataObject: IExtractorMetadataJson\n): Promise<void> {\n  await Async.forEachAsync(\n    extractorMetadataObject.files,\n    async (relativeFilePath) => {\n      const filePath: string = `${targetRootFolder}/${relativeFilePath}`;\n      const realFilePath: string = await FileSystem.getRealPathAsync(filePath);\n      if (!Path.isEqual(realFilePath, filePath)) {\n        await FileSystem.deleteFileAsync(filePath);\n\n        // Hard links seem to cause build failures on Mac, so for all other operating\n        // systems we copy files.\n        terminal.writeVerboseLine(`Realizing file at path \"${filePath}\"`);\n        if (process.platform === 'win32') {\n          await FileSystem.createHardLinkAsync({ newLinkPath: filePath, linkTargetPath: realFilePath });\n        } else {\n          await FileSystem.copyFileAsync({ sourcePath: realFilePath, destinationPath: filePath });\n        }\n      }\n    },\n    { concurrency: MAX_CONCURRENCY }\n  );\n}\n\nfunction showUsage(terminal: Terminal): void {\n  terminal.writeLine('Usage:');\n  terminal.writeLine(`  node create-links.js ${CREATE_ACTION_NAME} [${REALIZE_FILES_OPTION_NAME}]`);\n  terminal.writeLine(`  node create-links.js ${REMOVE_ACTION_NAME}`);\n  terminal.writeLine('');\n  terminal.writeLine('Creates or removes the symlinks for the output folder created by \"rush deploy\".');\n  terminal.writeLine('The link information is read from \"extractor-metadata.json\" in the same folder.');\n}\n\nasync function runAsync(terminal: Terminal): Promise<boolean> {\n  // Example: [ \"node.exe\", \"create-links.js\", \"\"create\" ]\n  const args: string[] = process.argv.slice(2);\n  if (\n    (args[0] !== CREATE_ACTION_NAME && args[0] !== REMOVE_ACTION_NAME) ||\n    (args[0] === CREATE_ACTION_NAME && args[1] && args[1] !== REALIZE_FILES_OPTION_NAME) ||\n    (args[0] === REMOVE_ACTION_NAME && args[1])\n  ) {\n    showUsage(terminal);\n    return false;\n  }\n\n  const extractorMetadataPath: string = `${__dirname}/extractor-metadata.json`;\n  if (!fs.existsSync(extractorMetadataPath)) {\n    throw new Error('Input file not found: ' + extractorMetadataPath);\n  }\n\n  const extractorMetadataJson: string = fs.readFileSync(extractorMetadataPath).toString();\n  const extractorMetadataObject: IExtractorMetadataJson = JSON.parse(extractorMetadataJson);\n\n  if (args[0] === 'create') {\n    const realizeFiles: boolean = args[1] === '--realize-files';\n    terminal.writeLine(`Creating links for extraction at path \"${TARGET_ROOT_FOLDER}\"`);\n    await removeLinksAsync(terminal, TARGET_ROOT_FOLDER, extractorMetadataObject);\n    await createLinksAsync(terminal, TARGET_ROOT_FOLDER, extractorMetadataObject);\n    if (realizeFiles) {\n      await realizeFilesAsync(terminal, TARGET_ROOT_FOLDER, extractorMetadataObject);\n    }\n  } else if (args[0] === 'remove') {\n    terminal.writeLine(`Removing links for extraction at path \"${TARGET_ROOT_FOLDER}\"`);\n    await removeLinksAsync(terminal, TARGET_ROOT_FOLDER, extractorMetadataObject);\n  }\n\n  terminal.writeLine('The operation completed successfully.');\n  return true;\n}\n\nprocess.exitCode = 1;\nconst terminal: Terminal = new Terminal(new ConsoleTerminalProvider());\nrunAsync(terminal)\n  .then((result) => {\n    process.exitCode = result ? 0 : 1;\n  })\n  .catch((error) => {\n    terminal.writeErrorLine('ERROR: ' + error);\n  });\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/package-extractor",
-  "version": "0.8.1",
+  "version": "0.9.1",
   "description": "A library for bundling selected files and dependencies into a deployable package.",
   "main": "lib/index.js",
   "typings": "dist/package-extractor.d.ts",
@@ -17,8 +17,8 @@
     "minimatch": "~3.0.3",
     "npm-packlist": "~2.1.2",
     "semver": "~7.5.4",
-    "@rushstack/node-core-library": "5.9.0",
-    "@rushstack/terminal": "0.14.2"
+    "@rushstack/terminal": "0.14.2",
+    "@rushstack/node-core-library": "5.9.0"
   },
   "devDependencies": {
     "@types/glob": "7.1.1",
@@ -27,10 +27,10 @@
     "eslint": "~8.57.0",
     "webpack": "~5.82.1",
     "@types/semver": "7.5.0",
-    "@rushstack/heft": "0.67.2",
     "local-node-rig": "1.0.0",
+    "@rushstack/heft": "0.67.2",
     "@rushstack/webpack-preserve-dynamic-require-plugin": "0.11.66",
-    "@rushstack/heft-webpack5-plugin": "0.10.11"
+    "@rushstack/heft-webpack5-plugin": "0.10.12"
   },
   "scripts": {
     "build": "heft build --clean",