@react-native-windows/cli 0.66.2 → 0.68.0-preview.1

package/lib-commonjs/runWindows/utils/autolink.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  * @format
  */
-import { Command, Dependency, ProjectConfig } from '@react-native-community/cli-types';
+import { Command, CommandOption, Config, Dependency, ProjectConfig } from '@react-native-community/cli-types';
 import { WindowsProjectConfig } from '../../config/projectConfig';
 import { Ora } from 'ora';
 export declare class AutolinkWindows {
@@ -73,11 +73,22 @@ export declare class AutolinkWindows {
     /** @return The CLI command to invoke autolink-windows independently */
     getAutolinkWindowsCommand(): string;
 }
-interface AutoLinkOptions {
-    logging: boolean;
-    check: boolean;
+/**
+ * Performs auto-linking for RNW native modules and apps.
+ * @param args Unprocessed args passed from react-native CLI.
+ * @param config Config passed from react-native CLI.
+ * @param options Options passed from react-native CLI.
+ */
+export declare function autolinkWindowsInternal(args: string[], config: Config, options: AutoLinkOptions): Promise<void>;
+export interface AutoLinkOptions {
+    logging?: boolean;
+    check?: boolean;
     sln?: string;
     proj?: string;
+    telemetry?: boolean;
 }
+export declare const autolinkOptions: CommandOption[];
+/**
+ * Performs auto-linking for RNW native modules and apps.
+ */
 export declare const autoLinkCommand: Command;
-export {};

package/lib-commonjs/runWindows/utils/autolink.js

@@ -19,7 +19,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 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.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    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;
 };
@@ -27,12 +27,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.autoLinkCommand = exports.AutolinkWindows = void 0;
+exports.autoLinkCommand = exports.autolinkOptions = exports.autolinkWindowsInternal = exports.AutolinkWindows = void 0;
 // Types in this file are inaccurate compared to usage in terms of falsiness.
 // We should try to rewrite some of this to do automated schema validation to
 // guarantee correct types
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
-const fs_1 = __importDefault(require("fs"));
+const fs_1 = __importDefault(require("@react-native-windows/fs"));
 const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 const perf_hooks_1 = require("perf_hooks");
@@ -41,6 +41,7 @@ const vstools = __importStar(require("./vstools"));
 const generatorCommon = __importStar(require("../../generator-common"));
 const configUtils = __importStar(require("../../config/configUtils"));
 const telemetry_1 = require("@react-native-windows/telemetry");
+const telemetryHelpers_1 = require("./telemetryHelpers");
 const xmldom_1 = require("@xmldom/xmldom");
 const formatter = require('xml-formatter');
 class AutolinkWindows {
@@ -149,7 +150,7 @@ class AutolinkWindows {
             'solutionFile',
             'project',
         ];
-        alwaysRequired.forEach(item => {
+        alwaysRequired.forEach((item) => {
             if (!(item in this.windowsAppConfig) ||
                 this.windowsAppConfig[item] === null) {
                 throw new telemetry_1.CodedError('IncompleteConfig', `${item} is required but not specified by react-native config`, { item: item });
@@ -174,7 +175,7 @@ class AutolinkWindows {
             'projectLang',
             'projectGuid',
         ];
-        projectRequired.forEach(item => {
+        projectRequired.forEach((item) => {
             if (!(item in windowsAppProjectConfig) ||
                 windowsAppProjectConfig[item] === null) {
                 throw new telemetry_1.CodedError('IncompleteConfig', `project.${item} is required but not specified by react-native config`, { item: item });
@@ -203,14 +204,14 @@ class AutolinkWindows {
         let cppPackageProviders = '';
         const windowsDependencies = this.getWindowsDependencies();
         for (const dependencyName of Object.keys(windowsDependencies)) {
-            windowsDependencies[dependencyName].projects.forEach(project => {
+            windowsDependencies[dependencyName].projects.forEach((project) => {
                 if (project.directDependency) {
                     cppIncludes += `\n\n// Includes from ${dependencyName}`;
-                    project.cppHeaders.forEach(header => {
+                    project.cppHeaders.forEach((header) => {
                         cppIncludes += `\n#include <${header}>`;
                     });
                     cppPackageProviders += `\n    // IReactPackageProviders from ${dependencyName}`;
-                    project.cppPackageProviders.forEach(packageProvider => {
+                    project.cppPackageProviders.forEach((packageProvider) => {
                         cppPackageProviders += `\n    packageProviders.Append(winrt::${packageProvider}());`;
                     });
                 }
@@ -224,7 +225,7 @@ class AutolinkWindows {
         return { cppPackageProviders, cppIncludes };
     }
     generateCSAutolinking(templateRoot, projectLang, projectDir) {
-        const { csUsingNamespaces, csReactPackageProviders, } = this.getCsReplacements();
+        const { csUsingNamespaces, csReactPackageProviders } = this.getCsReplacements();
         const csFileName = 'AutolinkedNativeModules.g.cs';
         const srcCsFile = path_1.default.join(templateRoot, `${projectLang}-app`, 'src', csFileName);
         const destCsFile = path_1.default.join(projectDir, csFileName);
@@ -241,14 +242,14 @@ class AutolinkWindows {
         let csReactPackageProviders = '';
         const windowsDependencies = this.getWindowsDependencies();
         for (const dependencyName of Object.keys(windowsDependencies)) {
-            windowsDependencies[dependencyName].projects.forEach(project => {
+            windowsDependencies[dependencyName].projects.forEach((project) => {
                 if (project.directDependency) {
                     csUsingNamespaces += `\n\n// Namespaces from ${dependencyName}`;
-                    project.csNamespaces.forEach(namespace => {
+                    project.csNamespaces.forEach((namespace) => {
                         csUsingNamespaces += `\nusing ${namespace};`;
                     });
                     csReactPackageProviders += `\n            // IReactPackageProviders from ${dependencyName}`;
-                    project.csPackageProviders.forEach(packageProvider => {
+                    project.csPackageProviders.forEach((packageProvider) => {
                         csReactPackageProviders += `\n            packageProviders.Add(new ${packageProvider}());`;
                     });
                 }
@@ -259,8 +260,7 @@ class AutolinkWindows {
     getWindowsDependencies() {
         if (Object.keys(this.windowsDependencies).length === 0) {
             for (const dependencyName of Object.keys(this.dependenciesConfig)) {
-                const windowsDependency = this
-                    .dependenciesConfig[dependencyName].platforms.windows;
+                const windowsDependency = this.dependenciesConfig[dependencyName].platforms.windows;
                 if (windowsDependency) {
                     verboseMessage(`${chalk_1.default.bold(dependencyName)} has Windows implementation, config:`, this.options.logging);
                     verboseMessage(windowsDependency, this.options.logging);
@@ -276,12 +276,12 @@ class AutolinkWindows {
                             // the dependency is probably a react native module, but we didn't find a module project
                             throw new telemetry_1.CodedError('Autolinking', `Found a Windows solution for ${dependencyName} but no React Native for Windows native module projects`);
                         }
-                        windowsDependency.projects.forEach(project => {
+                        windowsDependency.projects.forEach((project) => {
                             const itemsToCheck = [
                                 'projectFile',
                                 'directDependency',
                             ];
-                            itemsToCheck.forEach(item => {
+                            itemsToCheck.forEach((item) => {
                                 dependencyIsValid = !!(dependencyIsValid &&
                                     item in project &&
                                     project[item] !== '' &&
@@ -311,14 +311,14 @@ class AutolinkWindows {
         const fileName = chalk_1.default.bold(path_1.default.basename(filePath));
         verboseMessage(`Reading ${fileName}...`, this.options.logging);
         const actualContents = fs_1.default.existsSync(filePath)
-            ? (await fs_1.default.promises.readFile(filePath)).toString()
+            ? (await fs_1.default.readFile(filePath)).toString()
             : '';
         const contentsChanged = expectedContents !== actualContents;
         if (contentsChanged) {
             verboseMessage(chalk_1.default.yellow(`${fileName} needs to be updated.`), this.options.logging);
             if (!this.options.check) {
                 verboseMessage(`Writing ${fileName}...`, this.options.logging);
-                await fs_1.default.promises.writeFile(filePath, expectedContents, {
+                await fs_1.default.writeFile(filePath, expectedContents, {
                     encoding: 'utf8',
                     flag: 'w',
                 });
@@ -333,7 +333,7 @@ class AutolinkWindows {
         let projectReferencesForTargets = '';
         const windowsDependencies = this.getWindowsDependencies();
         for (const dependencyName of Object.keys(windowsDependencies)) {
-            windowsDependencies[dependencyName].projects.forEach(project => {
+            windowsDependencies[dependencyName].projects.forEach((project) => {
                 if (project.directDependency) {
                     const dependencyProjectFile = path_1.default.join(windowsDependencies[dependencyName].folder, windowsDependencies[dependencyName].sourceDir, project.projectFile);
                     const relDependencyProjectFile = path_1.default.relative(projectDir, dependencyProjectFile);
@@ -370,7 +370,7 @@ class AutolinkWindows {
         const csModuleNames = [];
         const windowsDependencies = this.getWindowsDependencies();
         for (const dependencyName of Object.keys(windowsDependencies)) {
-            windowsDependencies[dependencyName].projects.forEach(project => {
+            windowsDependencies[dependencyName].projects.forEach((project) => {
                 if (project.directDependency && project.projectLang === 'cs') {
                     csModuleNames.push(project.projectName);
                 }
@@ -383,7 +383,7 @@ class AutolinkWindows {
         const windowsDependencies = this.getWindowsDependencies();
         for (const dependencyName of Object.keys(windowsDependencies)) {
             // Process dependency projects
-            windowsDependencies[dependencyName].projects.forEach(project => {
+            windowsDependencies[dependencyName].projects.forEach((project) => {
                 const dependencyProjectFile = path_1.default.join(windowsDependencies[dependencyName].folder, windowsDependencies[dependencyName].sourceDir, project.projectFile);
                 projectsForSolution.push({
                     projectFile: dependencyProjectFile,
@@ -412,7 +412,7 @@ class AutolinkWindows {
         }
         verboseMessage(`Calculating ${chalk_1.default.bold(path_1.default.basename(solutionFile))} changes...`, this.options.logging);
         let changesNecessary = false;
-        projectsForSolution.forEach(project => {
+        projectsForSolution.forEach((project) => {
             const contentsChanged = vstools.addProjectToSolution(solutionFile, project, this.options.logging, this.options.check);
             changesNecessary = changesNecessary || contentsChanged;
         });
@@ -437,10 +437,14 @@ class AutolinkWindows {
         if (experimentalFeatures) {
             const useWinUI3FromExperimentalFeatures = ((_a = configUtils
                 .tryFindPropertyValue(experimentalFeatures.content, 'UseWinUI3')) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'true';
-            // use the UseWinUI3 value in react-native.config.js, or if not present, the value from ExperimentalFeatures.props
+            // Check if WinUI2xVersion is specified in experimental features
+            const targetWinUI2xVersion = configUtils.tryFindPropertyValue(experimentalFeatures.content, 'WinUI2xVersion');
+            // Check if WinUI3Version is specified in experimental features
+            const targetWinUI3xVersion = configUtils.tryFindPropertyValue(experimentalFeatures.content, 'WinUI3Version');
+            // Use the UseWinUI3 value in react-native.config.js, or if not present, the value from ExperimentalFeatures.props
             changesNeeded = await this.updatePackagesConfigXAMLDialect(useWinUI3FromConfig !== undefined
                 ? useWinUI3FromConfig
-                : useWinUI3FromExperimentalFeatures);
+                : useWinUI3FromExperimentalFeatures, targetWinUI2xVersion, targetWinUI3xVersion);
             if (useWinUI3FromConfig !== undefined) {
                 // Make sure ExperimentalFeatures.props matches the value that comes from react-native.config.js
                 const node = experimentalFeatures.content.getElementsByTagName('UseWinUI3');
@@ -466,7 +470,7 @@ class AutolinkWindows {
         }
         return undefined;
     }
-    async updatePackagesConfigXAMLDialect(useWinUI3) {
+    async updatePackagesConfigXAMLDialect(useWinUI3, targetWinUI2xVersion, targetWinUI3xVersion) {
         let changed = false;
         const packagesConfig = this.getPackagesConfigXml();
         if (packagesConfig) {
@@ -474,8 +478,10 @@ class AutolinkWindows {
             const project = this.getWindowsConfig();
             const winUIPropsPath = path_1.default.join(resolveRnwRoot(project), 'PropertySheets/WinUI.props');
             const winuiPropsContents = configUtils.readProjectFile(winUIPropsPath);
-            const winui2xVersion = configUtils.tryFindPropertyValue(winuiPropsContents, 'WinUI2xVersion');
-            const winui3Version = configUtils.tryFindPropertyValue(winuiPropsContents, 'WinUI3Version');
+            // Use the given WinUI2xVersion, otherwise fallback to WinUI.props
+            const winui2xVersion = targetWinUI2xVersion !== null && targetWinUI2xVersion !== void 0 ? targetWinUI2xVersion : configUtils.tryFindPropertyValue(winuiPropsContents, 'WinUI2xVersion');
+            // Use the given WinUI3Version, otherwise fallback to WinUI.props
+            const winui3Version = targetWinUI3xVersion !== null && targetWinUI3xVersion !== void 0 ? targetWinUI3xVersion : configUtils.tryFindPropertyValue(winuiPropsContents, 'WinUI3Version');
             const dialects = [
                 { id: 'Microsoft.WinUI', version: winui3Version },
                 { id: 'Microsoft.UI.Xaml', version: winui2xVersion },
@@ -500,8 +506,8 @@ class AutolinkWindows {
             const packageElement = packageElements.item(i);
             const idAttr = packageElement.getAttributeNode('id');
             const id = idAttr.value;
-            const keepPkg = keepPkgs.find(pkg => pkg.id === id);
-            if (removePkgs.find(pkg => pkg.id === id)) {
+            const keepPkg = keepPkgs.find((pkg) => pkg.id === id);
+            if (removePkgs.find((pkg) => pkg.id === id)) {
                 nodesToRemove.push(packageElement);
                 changed = true;
             }
@@ -509,11 +515,11 @@ class AutolinkWindows {
                 changed =
                     changed || keepPkg.version !== packageElement.getAttribute('version');
                 packageElement.setAttribute('version', keepPkg.version);
-                keepPkgs = keepPkgs.filter(pkg => pkg.id !== keepPkg.id);
+                keepPkgs = keepPkgs.filter((pkg) => pkg.id !== keepPkg.id);
             }
         }
-        nodesToRemove.forEach(pkg => packagesConfig.content.documentElement.removeChild(pkg));
-        keepPkgs.forEach(keepPkg => {
+        nodesToRemove.forEach((pkg) => packagesConfig.content.documentElement.removeChild(pkg));
+        keepPkgs.forEach((keepPkg) => {
             const newPkg = packagesConfig.content.createElement('package');
             Object.entries(keepPkg).forEach(([attr, value]) => {
                 newPkg.setAttribute(attr, value);
@@ -561,15 +567,63 @@ function verboseMessage(message, verbose) {
         console.log(message);
     }
 }
+/**
+ * Sanitizes the given option for telemetery.
+ * @param key The key of the option.
+ * @param value The unsanitized value of the option.
+ * @returns The sanitized value of the option.
+ */
+function optionSanitizer(key, value) {
+    // Do not add a default case here.
+    // Strings risking PII should just return true if present, false otherwise.
+    // All others should return the value (or false if undefined).
+    switch (key) {
+        case 'sln':
+        case 'proj':
+            return value === undefined ? false : true; // Strip PII
+        case 'logging':
+        case 'check':
+        case 'telemetry':
+            return value === undefined ? false : value; // Return value
+    }
+}
+/**
+ * Get the extra props to add to the `autolink-windows` telemetry event.
+ * @returns The extra props.
+ */
+async function getExtraProps() {
+    const extraProps = {};
+    return extraProps;
+}
+/**
+ * The function run when calling `react-native autolink-windows`.
+ * @param args Unprocessed args passed from react-native CLI.
+ * @param config Config passed from react-native CLI.
+ * @param options Options passed from react-native CLI.
+ */
+async function autolinkWindows(args, config, options) {
+    await (0, telemetryHelpers_1.startTelemetrySession)('autolink-windows', config, options, (0, telemetryHelpers_1.getDefaultOptions)(config, exports.autolinkOptions), optionSanitizer);
+    let autolinkWindowsError;
+    try {
+        await autolinkWindowsInternal(args, config, options);
+    }
+    catch (ex) {
+        autolinkWindowsError =
+            ex instanceof Error ? ex : new Error(String(ex));
+        telemetry_1.Telemetry.trackException(autolinkWindowsError);
+    }
+    await (0, telemetryHelpers_1.endTelemetrySession)(autolinkWindowsError, getExtraProps);
+    (0, commandWithProgress_1.setExitProcessWithError)(options.logging, autolinkWindowsError);
+}
 /**
  * Performs auto-linking for RNW native modules and apps.
  * @param args Unprocessed args passed from react-native CLI.
  * @param config Config passed from react-native CLI.
  * @param options Options passed from react-native CLI.
  */
-async function updateAutoLink(args, config, options) {
+async function autolinkWindowsInternal(args, config, options) {
     const startTime = perf_hooks_1.performance.now();
-    const spinner = commandWithProgress_1.newSpinner(options.check ? 'Checking auto-linked files...' : 'Auto-linking...');
+    const spinner = (0, commandWithProgress_1.newSpinner)(options.check ? 'Checking auto-linked files...' : 'Auto-linking...');
     try {
         const autolink = new AutolinkWindows(config.project, config.dependencies, options);
         await autolink.run(spinner);
@@ -593,31 +647,38 @@ async function updateAutoLink(args, config, options) {
         throw e;
     }
 }
+exports.autolinkWindowsInternal = autolinkWindowsInternal;
+exports.autolinkOptions = [
+    {
+        name: '--logging',
+        description: 'Verbose output logging',
+    },
+    {
+        name: '--check',
+        description: 'Only check whether any autolinked files need to change',
+    },
+    {
+        name: '--sln [string]',
+        description: "Override the app solution file determined by 'react-native config', e.g. windows\\myApp.sln",
+        default: undefined,
+    },
+    {
+        name: '--proj [string]',
+        description: "Override the app project file determined by 'react-native config', e.g. windows\\myApp\\myApp.vcxproj",
+        default: undefined,
+    },
+    {
+        name: '--no-telemetry',
+        description: 'Disables sending telemetry that allows analysis of usage and failures of the react-native-windows CLI',
+    },
+];
+/**
+ * Performs auto-linking for RNW native modules and apps.
+ */
 exports.autoLinkCommand = {
     name: 'autolink-windows',
     description: 'performs autolinking',
-    func: updateAutoLink,
-    options: [
-        {
-            name: '--logging',
-            description: 'Verbose output logging',
-            default: false,
-        },
-        {
-            name: '--check',
-            description: 'Only check whether any autolinked files need to change',
-            default: false,
-        },
-        {
-            name: '--sln [string]',
-            description: "Override the app solution file determined by 'react-native config', e.g. windows\\myApp.sln",
-            default: undefined,
-        },
-        {
-            name: '--proj [string]',
-            description: "Override the app project file determined by 'react-native config', e.g. windows\\myApp\\myApp.vcxproj",
-            default: undefined,
-        },
-    ],
+    func: autolinkWindows,
+    options: exports.autolinkOptions,
 };
 //# sourceMappingURL=autolink.js.map