@rnx-kit/tools-react-native - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

CHANGELOG.md

 # Change Log - @rnx-kit/tools-react-native
 
+## 1.2.0
+
+### Minor Changes
+
+- adf6feb: Added a function to get available React Native platforms
+
 ## 1.1.0
@@ -4,0 +10,0 @@

lib/index.d.ts

@@ -1,3 +0,3 @@
-export { AVAILABLE_PLATFORMS, expandPlatformExtensions, parsePlatform, platformExtensions, } from "./platform";
+export { expandPlatformExtensions, getAvailablePlatforms, getAvailablePlatformsUncached, parsePlatform, platformExtensions, } from "./platform";
 export type { AllPlatforms } from "./platform";
 //# sourceMappingURL=index.d.ts.map

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.platformExtensions = exports.parsePlatform = exports.expandPlatformExtensions = exports.AVAILABLE_PLATFORMS = void 0;
+exports.platformExtensions = exports.parsePlatform = exports.getAvailablePlatformsUncached = exports.getAvailablePlatforms = exports.expandPlatformExtensions = void 0;
 var platform_1 = require("./platform");
-Object.defineProperty(exports, "AVAILABLE_PLATFORMS", { enumerable: true, get: function () { return platform_1.AVAILABLE_PLATFORMS; } });
 Object.defineProperty(exports, "expandPlatformExtensions", { enumerable: true, get: function () { return platform_1.expandPlatformExtensions; } });
+Object.defineProperty(exports, "getAvailablePlatforms", { enumerable: true, get: function () { return platform_1.getAvailablePlatforms; } });
+Object.defineProperty(exports, "getAvailablePlatformsUncached", { enumerable: true, get: function () { return platform_1.getAvailablePlatformsUncached; } });
 Object.defineProperty(exports, "parsePlatform", { enumerable: true, get: function () { return platform_1.parsePlatform; } });
 Object.defineProperty(exports, "platformExtensions", { enumerable: true, get: function () { return platform_1.platformExtensions; } });
 //# sourceMappingURL=index.js.map

lib/platform.d.ts

@@ -5,3 +5,2 @@ /**
 export declare type AllPlatforms = "ios" | "android" | "windows" | "win32" | "macos";
-export declare const AVAILABLE_PLATFORMS: Record<string, string>;
 /**
@@ -16,2 +15,16 @@ * Returns a list of extensions that should be tried for the target platform in
 /**
+ * Returns a map of available React Native platforms. The result is cached.
+ * @privateRemarks is-arrow-function
+ * @param startDir The directory to look for react-native platforms from
+ * @returns A platform-to-npm-package map, excluding "core" platforms.
+ */
+export declare const getAvailablePlatforms: (startDir?: string) => Record<string, string>;
+/**
+ * Returns a map of available React Native platforms. The result is NOT cached.
+ * @param startDir The directory to look for react-native platforms from
+ * @param platformMap A platform-to-npm-package map of known packages
+ * @returns A platform-to-npm-package map, excluding "core" platforms.
+ */
+export declare function getAvailablePlatformsUncached(startDir?: string, platformMap?: Record<string, string>): Record<string, string>;
+/**
  * Returns file extensions that can be mapped to the target platform.
@@ -18,0 +31,0 @@ * @param platform The platform to retrieve extensions for

lib/platform.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsePlatform = exports.platformExtensions = exports.expandPlatformExtensions = exports.AVAILABLE_PLATFORMS = void 0;
-// TODO: `react-native config` is too slow. Hard-coding this list until we can
-// figure out a better solution.
-// See https://github.com/microsoft/rnx-kit/issues/925
-exports.AVAILABLE_PLATFORMS = {
-    macos: "react-native-macos",
-    win32: "@office-iss/react-native-win32",
-    windows: "react-native-windows",
-};
+exports.parsePlatform = exports.platformExtensions = exports.getAvailablePlatformsUncached = exports.getAvailablePlatforms = exports.expandPlatformExtensions = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
 /**
@@ -30,2 +43,56 @@ * Returns a list of extensions that should be tried for the target platform in
 /**
+ * Returns a map of available React Native platforms. The result is cached.
+ * @privateRemarks is-arrow-function
+ * @param startDir The directory to look for react-native platforms from
+ * @returns A platform-to-npm-package map, excluding "core" platforms.
+ */
+exports.getAvailablePlatforms = (() => {
+    let platformMap = undefined;
+    return (startDir = process.cwd()) => {
+        if (!platformMap) {
+            platformMap = getAvailablePlatformsUncached(startDir);
+        }
+        return platformMap;
+    };
+})();
+/**
+ * Returns a map of available React Native platforms. The result is NOT cached.
+ * @param startDir The directory to look for react-native platforms from
+ * @param platformMap A platform-to-npm-package map of known packages
+ * @returns A platform-to-npm-package map, excluding "core" platforms.
+ */
+function getAvailablePlatformsUncached(startDir = process.cwd(), platformMap = { android: "", ios: "" }) {
+    const packageJson = path.join(startDir, "package.json");
+    if (!fs.existsSync(packageJson)) {
+        const parent = path.dirname(startDir);
+        return parent === startDir
+            ? platformMap
+            : getAvailablePlatformsUncached(path.dirname(startDir), platformMap);
+    }
+    const resolveOptions = { paths: [startDir] };
+    const { dependencies, devDependencies } = require(packageJson);
+    [
+        ...(dependencies ? Object.keys(dependencies) : []),
+        ...(devDependencies ? Object.keys(devDependencies) : []),
+    ].forEach((pkgName) => {
+        const pkgPath = path.dirname(require.resolve(`${pkgName}/package.json`, resolveOptions));
+        const configPath = path.join(pkgPath, "react-native.config.js");
+        if (fs.existsSync(configPath)) {
+            const { platforms } = require(configPath);
+            if (platforms) {
+                Object.keys(platforms).forEach((platform) => {
+                    if (typeof platformMap[platform] === "undefined") {
+                        const { npmPackageName } = platforms[platform];
+                        if (npmPackageName) {
+                            platformMap[platform] = npmPackageName;
+                        }
+                    }
+                });
+            }
+        }
+    });
+    return platformMap;
+}
+exports.getAvailablePlatformsUncached = getAvailablePlatformsUncached;
+/**
  * Returns file extensions that can be mapped to the target platform.
@@ -32,0 +99,0 @@ * @param platform The platform to retrieve extensions for

package.json

 {
   "name": "@rnx-kit/tools-react-native",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A collection of supplemental react-native functions and types",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/microsoft/rnx-kit/tree/main/packages/tools-react-native#readme",

README.md

@@ -25,8 +25,10 @@ # @rnx-kit/tools-react-native
 
-| Category | Function                                         | Description                                                                                     |
-| -------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
-| platform | `expandPlatformExtensions(platform, extensions)` | Returns a list of extensions that should be tried for the target platform in prioritized order. |
-| platform | `parsePlatform(val)`                             | Parse a string to ensure it maps to a valid react-native platform.                              |
-| platform | `platformExtensions(platform)`                   | Returns file extensions that can be mapped to the target platform.                              |
+| Category | Function                                               | Description                                                                                     |
+| -------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
+| platform | `expandPlatformExtensions(platform, extensions)`       | Returns a list of extensions that should be tried for the target platform in prioritized order. |
+| platform | `getAvailablePlatforms(startDir)`                      | Returns a map of available React Native platforms. The result is cached.                        |
+| platform | `getAvailablePlatformsUncached(startDir, platformMap)` | Returns a map of available React Native platforms. The result is NOT cached.                    |
+| platform | `parsePlatform(val)`                                   | Parse a string to ensure it maps to a valid react-native platform.                              |
+| platform | `platformExtensions(platform)`                         | Returns file extensions that can be mapped to the target platform.                              |
 
 <!-- @rnx-kit/api end -->

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15925

increased by63.69%

Lines of code

181

increased by81%

Number of lines in readme file

34

increased by6.25%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Number of low supply chain risk alerts

4

increased byInfinity%

No dependency changes