@react-native-tvos/config-tv 0.0.3 → 0.0.5

package/README.md

@@ -4,16 +4,15 @@ Expo Config Plugin to auto-configure the native directories for TV development u
 
 _Notes_:
 
-- This is an experimental plugin, tested only against Expo 50 alpha packages.
 - This package cannot be used in the "Expo Go" app because Expo Go does not support TV.
-- Apple TV development will work with many of the commonly used SDK 50 packages, including `expo-updates`, but many Expo packages do not work on Apple TV and are not supported. In particular, `expo-dev-client`, `expo-dev-menu`, and `expo-dev-launcher` are not supported.
+- Apple TV development will work with many of the commonly used SDK 50 packages, including `expo-updates`, but many Expo packages do not work on Apple TV and are not supported. In particular, `expo-dev-client` and `expo-router` are not supported.
 
 ## Expo installation
 
 - First install the package with yarn, npm, or [`npx expo install`](https://docs.expo.io/workflow/expo-cli/#expo-install).
 
 ```sh
-npx expo install tv @react-native-tvos/config-tv
+npx expo install @react-native-tvos/config-tv
 ```
 
 After installing this npm package, add the [config plugin](https://docs.expo.io/guides/config-plugins/) to the [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) array of your `app.json` or `app.config.js`:
@@ -37,7 +36,9 @@ or
         {
           "isTV": true,
           "showVerboseWarnings": false,
-          "tvosDeploymentTarget": "13.4"
+          "tvosDeploymentTarget": "13.4",
+          "removeFlipperOnAndroid": true,
+          "androidTVBanner": "assets/images/tv_banner.png"
         }
       ]
     ]
@@ -49,9 +50,14 @@ or
 
 _Plugin parameters_:
 
-- `isTV`: (optional boolean, default false) If true, prebuild should generate or modify Android and iOS files to build for TV (Android TV and Apple TV). If false, the default phone-appropriate files should be generated, and if existing files contain TV changes, they will be reverted. Setting the environment variable EXPO_TV to "true" or "1" will override this value and force a TV build.
-- `showVerboseWarnings`: (optional boolean, default false) If true, verbose warnings will be shown during plugin execution.
+- `isTV`: (optional boolean, default false) If true, prebuild should generate or modify Android and iOS files to build for TV (Android TV and Apple TV). If false, the plugin will have no effect. Setting the environment variable EXPO_TV to "true" or "1" will override this value and force a TV build.
+- `showVerboseWarnings`: Deprecated. Verbose logging is now shown as in other config plugins, by setting an environment variable:
+  - EXPO_DEBUG=1 (shows debug messages from all plugins)
+  - DEBUG=expo:\* (shows debug messages from all plugins)
+  - DEBUG=expo:react-native-tvos:config-tv (shows debug messages from this plugin only)
 - `tvosDeploymentTarget`: (optional string, default '13.4') Used to set the tvOS deployment target version in the Xcode project.
+- `removeFlipperOnAndroid`: (optional boolean, default true) Used to remove the Flipper dependency from `MainApplication.kt` (or `MainApplication.java`) and `android/app/build.gradle`. This is necessary for React Native TV 0.73 and higher, since Flipper integration is removed from these versions. If this causes issues, set the value to false, run `npx expo prebuild --clean` again, and then remove Flipper from your Android source manually.
+- `androidTVBanner`: (optional string) If set, this should be a path to an existing PNG file appropriate for an Android TV banner image. See https://developer.android.com/design/ui/tv/guides/system/tv-app-icon-guidelines#banner . The Android manifest will be modified to reference this image, and the image will be copied into Android resource drawable directories.
 
 _Warning_:
 
@@ -60,7 +66,7 @@ When this plugin is used to generate files in the iOS directory that build an Ap
 ```json
 {
   "dependencies": {
-    "react-native": "npm:react-native-tvos@^0.72.5-0"
+    "react-native": "npm:react-native-tvos@^0.73.2-0"
   }
 }
 ```
@@ -69,6 +75,6 @@ If this is not the case, the plugin will run successfully, but Cocoapods install
 
 _Warning_:
 
-If you have already generated native directories for a phone build, and set `EXPO_TV` to "true" or "1" (or set the `isTV` plugin parameter to true), then running `npx expo prebuild` will lead to errors when Cocoapods installation is run again. You will need to remove `ios/Pods` and `ios/Podfile.lock` before running Cocoapods installation.
+If you have already generated native directories for a phone build, and set `EXPO_TV` to "true" or "1" (or set the `isTV` plugin parameter to true), then running `npx expo prebuild` again will lead to errors when Cocoapods installation is run again. Similar problems will occur if `EXPO_TV` is set to "0" (or `isTV` set to false) after generating native directories for a TV build.
 
-To avoid this issue, it is strongly recommended to run `npx expo prebuild --clean` if changing the `EXPO_TV` environment variable or the `isTV` plugin parameter.
+To avoid this issue, it is strongly recommended to run `npx expo prebuild --clean` if changing the `EXPO_TV` environment variable or the `isTV` plugin parameter. See [this doc](https://docs.expo.dev/workflow/prebuild/#clean) for more details.

package/build/types.d.ts

@@ -3,15 +3,31 @@ export type ConfigData = {
      * If true, prebuild should generate Android and iOS files for TV (Android TV and Apple TV).
      * If false, the default phone-appropriate files should be generated.
      * Setting the environment variable EXPO_TV to "true" or "1" will override
-     * this value.
+     * this value. (Defaults to false.)
      */
     isTV?: boolean;
     /**
-     * If true, verbose warnings will be shown during plugin execution.
+     * Deprecated. Verbose logging is now shown as in other config plugins, by setting an environment variable:
+     * EXPO_DEBUG=1
+     * or
+     * DEBUG=expo:* (shows debug messages from all plugins)
+     * or
+     * DEBUG=expo:react-native-tvos:config-tv (shows debug messages from this plugin only)
      */
     showVerboseWarnings?: boolean;
     /**
      * If set, this will be used as the tvOS deployment target version instead of the default (13.4).
      */
     tvosDeploymentTarget?: string;
+    /**
+     * If set, Android code that references Flipper will be removed. (Defaults to true.)
+     */
+    removeFlipperOnAndroid?: boolean;
+    /**
+     * If set, this should be a path to an existing PNG file appropriate for an Android TV banner image.
+     * See https://developer.android.com/design/ui/tv/guides/system/tv-app-icon-guidelines#banner
+     * The Android manifest will be modified to reference this image, and the image will be copied into
+     * Android resource drawable directories.
+     */
+    androidTVBanner?: string;
 };

package/build/utils.d.ts

@@ -1,4 +1,12 @@
 import { ConfigData } from './types';
+export declare const packageNameAndVersion: string;
 export declare function isTVEnabled(params: ConfigData): boolean;
 export declare function showVerboseWarnings(params: ConfigData): boolean;
 export declare function tvosDeploymentTarget(params: ConfigData): string;
+export declare function shouldRemoveFlipperOnAndroid(params: ConfigData): boolean;
+export declare function androidTVBanner(params: ConfigData): string | undefined;
+export declare function verboseLog(message: string, options?: {
+    params?: ConfigData;
+    platform?: 'android' | 'ios';
+    property?: string;
+}): void;

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tvosDeploymentTarget = exports.showVerboseWarnings = exports.isTVEnabled = void 0;
+exports.verboseLog = exports.androidTVBanner = exports.shouldRemoveFlipperOnAndroid = exports.tvosDeploymentTarget = exports.showVerboseWarnings = exports.isTVEnabled = exports.packageNameAndVersion = void 0;
 const getenv_1 = require("getenv");
 class Env {
     /** Enable prebuild for TV */
@@ -8,8 +8,11 @@ class Env {
         return (0, getenv_1.boolish)('EXPO_TV', false);
     }
 }
+const debug = require('debug')('expo:react-native-tvos:config-tv');
 const env = new Env();
+const pkg = require('../package.json');
 const defaultTvosDeploymentVersion = '13.4';
+exports.packageNameAndVersion = `${pkg.name}@${pkg.version}`;
 function isTVEnabled(params) {
     return env.EXPO_TV || (params?.isTV ?? false);
 }
@@ -22,3 +25,18 @@ function tvosDeploymentTarget(params) {
     return params?.tvosDeploymentTarget ?? defaultTvosDeploymentVersion;
 }
 exports.tvosDeploymentTarget = tvosDeploymentTarget;
+function shouldRemoveFlipperOnAndroid(params) {
+    return params?.removeFlipperOnAndroid ?? true;
+}
+exports.shouldRemoveFlipperOnAndroid = shouldRemoveFlipperOnAndroid;
+function androidTVBanner(params) {
+    return params?.androidTVBanner;
+}
+exports.androidTVBanner = androidTVBanner;
+function verboseLog(message, options) {
+    const tokens = [message];
+    options?.property && tokens.unshift(options?.property);
+    options?.platform && tokens.unshift(options?.platform);
+    debug(tokens.join(': '));
+}
+exports.verboseLog = verboseLog;

package/build/withTV.d.ts

@@ -1,4 +1,4 @@
-import { ConfigPlugin } from "expo/config-plugins";
-import { ConfigData } from "./types";
+import { ConfigPlugin } from 'expo/config-plugins';
+import { ConfigData } from './types';
 declare const _default: ConfigPlugin<ConfigData>;
 export default _default;

package/build/withTV.js

@@ -5,12 +5,26 @@ const withTVAndroidManifest_1 = require("./withTVAndroidManifest");
 const withTVPodfile_1 = require("./withTVPodfile");
 const withTVSplashScreen_1 = require("./withTVSplashScreen");
 const withTVXcodeProject_1 = require("./withTVXcodeProject");
+const withTVAndroidRemoveFlipper_1 = require("./withTVAndroidRemoveFlipper");
+const withTVAndroidBannerImage_1 = require("./withTVAndroidBannerImage");
+const utils_1 = require("./utils");
+const withTVNoEffect = (config, params = {}) => {
+    (0, utils_1.verboseLog)(`${utils_1.packageNameAndVersion}: isTV == false, plugin will have no effect`, {});
+    return config;
+};
 const withTVPlugin = (config, params = {}) => {
+    const isTV = (0, utils_1.isTVEnabled)(params);
+    if (!isTV) {
+        config = withTVNoEffect(config, params);
+        return config;
+    }
     config = (0, withTVXcodeProject_1.withTVXcodeProject)(config, params);
     config = (0, withTVPodfile_1.withTVPodfile)(config, params);
     config = (0, withTVSplashScreen_1.withTVSplashScreen)(config, params);
+    config = (0, withTVAndroidBannerImage_1.withTVAndroidBannerImage)(config, params); // This should be done before Android manifest config
     config = (0, withTVAndroidManifest_1.withTVAndroidManifest)(config, params);
+    config = (0, withTVAndroidRemoveFlipper_1.withTVAndroidRemoveFlipper)(config, params);
     return config;
 };
-const pkg = require("../package.json");
+const pkg = require('../package.json');
 exports.default = (0, config_plugins_1.createRunOncePlugin)(withTVPlugin, pkg.name, pkg.version);

package/build/withTVAndroidBannerImage.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+import { ConfigData } from './types';
+/** Copies TV banner image to the Android resources drawable folders. If image does not exist, throw an exception. */
+export declare const withTVAndroidBannerImage: ConfigPlugin<ConfigData>;

package/build/withTVAndroidBannerImage.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withTVAndroidBannerImage = void 0;
+const config_plugins_1 = require("expo/config-plugins");
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("./utils");
+const drawableDirectoryNames = [
+    'drawable',
+    'drawable-hdpi',
+    'drawable-mdpi',
+    'drawable-xhdpi',
+    'drawable-xxhdpi',
+    'drawable-xxxhdpi',
+];
+/** Copies TV banner image to the Android resources drawable folders. If image does not exist, throw an exception. */
+const withTVAndroidBannerImage = (c, params = {}) => {
+    const androidTVBannerPath = (0, utils_1.androidTVBanner)(params);
+    return (0, config_plugins_1.withDangerousMod)(c, [
+        'android',
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+        async (config) => {
+            if (!androidTVBannerPath) {
+                return config;
+            }
+            (0, utils_1.verboseLog)(`adding TV banner image ${androidTVBannerPath} to Android resources`, {
+                params,
+                platform: 'android',
+                property: 'manifest',
+            });
+            for (const drawableDirectoryName of drawableDirectoryNames) {
+                const drawableDirectoryPath = path_1.default.join(config.modRequest.platformProjectRoot, 'app', 'src', 'main', 'res', drawableDirectoryName);
+                if (!(0, fs_1.existsSync)(drawableDirectoryPath)) {
+                    await fs_1.promises.mkdir(drawableDirectoryPath);
+                }
+                await fs_1.promises.copyFile(androidTVBannerPath, path_1.default.join(drawableDirectoryPath, 'tv_banner.png'));
+            }
+            return config;
+        },
+    ]);
+};
+exports.withTVAndroidBannerImage = withTVAndroidBannerImage;

package/build/withTVAndroidManifest.d.ts

@@ -1,6 +1,7 @@
-import { ExpoConfig } from "expo/config";
-import { AndroidConfig, ConfigPlugin } from "expo/config-plugins";
-import { ConfigData } from "./types";
+import { ExpoConfig } from 'expo/config';
+import { AndroidConfig, ConfigPlugin } from 'expo/config-plugins';
+import { ConfigData } from './types';
 export declare const withTVAndroidManifest: ConfigPlugin<ConfigData>;
-export declare function setLeanBackLauncherIntent(_config: Pick<ExpoConfig, "android">, androidManifest: AndroidConfig.Manifest.AndroidManifest, verbose: boolean): AndroidConfig.Manifest.AndroidManifest;
-export declare function removePortraitOrientation(_config: Pick<ExpoConfig, "android">, androidManifest: AndroidConfig.Manifest.AndroidManifest, verbose: boolean): Promise<AndroidConfig.Manifest.AndroidManifest>;
+export declare function setLeanBackLauncherIntent(_config: Pick<ExpoConfig, 'android'>, androidManifest: AndroidConfig.Manifest.AndroidManifest, params: ConfigData): AndroidConfig.Manifest.AndroidManifest;
+export declare function removePortraitOrientation(_config: Pick<ExpoConfig, 'android'>, androidManifest: AndroidConfig.Manifest.AndroidManifest, params: ConfigData): AndroidConfig.Manifest.AndroidManifest;
+export declare function setTVBanner(_config: Pick<ExpoConfig, 'android'>, androidManifest: AndroidConfig.Manifest.AndroidManifest, params: ConfigData, androidTVBannerPath: string | undefined): AndroidConfig.Manifest.AndroidManifest;

package/build/withTVAndroidManifest.js

@@ -1,56 +1,55 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removePortraitOrientation = exports.setLeanBackLauncherIntent = exports.withTVAndroidManifest = void 0;
+exports.setTVBanner = exports.removePortraitOrientation = exports.setLeanBackLauncherIntent = exports.withTVAndroidManifest = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const utils_1 = require("./utils");
-const pkg = require("../package.json");
-const { getMainActivity } = config_plugins_1.AndroidConfig.Manifest;
+const { getMainActivity, getMainApplication } = config_plugins_1.AndroidConfig.Manifest;
 const withTVAndroidManifest = (config, params = {}) => {
-    const isTV = (0, utils_1.isTVEnabled)(params);
-    const verbose = (0, utils_1.showVerboseWarnings)(params);
-    return (0, config_plugins_1.withAndroidManifest)(config, async (config) => {
-        if (!isTV) {
-            // nothing to do
-            return config;
+    const androidTVBannerPath = (0, utils_1.androidTVBanner)(params);
+    return (0, config_plugins_1.withAndroidManifest)(config, (config) => {
+        config.modResults = setLeanBackLauncherIntent(config, config.modResults, params);
+        config.modResults = removePortraitOrientation(config, config.modResults, params);
+        if (androidTVBannerPath) {
+            config.modResults = setTVBanner(config, config.modResults, params, androidTVBannerPath);
         }
-        config.modResults = await setLeanBackLauncherIntent(config, config.modResults, verbose);
-        config.modResults = await removePortraitOrientation(config, config.modResults, verbose);
         return config;
     });
 };
 exports.withTVAndroidManifest = withTVAndroidManifest;
-const LEANBACK_LAUNCHER_CATEGORY = "android.intent.category.LEANBACK_LAUNCHER";
+const LEANBACK_LAUNCHER_CATEGORY = 'android.intent.category.LEANBACK_LAUNCHER';
 function getMainLaunchIntent(androidManifest) {
     const mainActivity = getMainActivity(androidManifest);
-    const intentFilters = mainActivity?.["intent-filter"];
+    const intentFilters = mainActivity?.['intent-filter'];
     const mainLaunchIntents = (intentFilters ?? []).filter((i) => {
         const action = i.action ?? [];
         if (action.length === 0) {
             return false;
         }
-        return action[0]?.$["android:name"] === "android.intent.action.MAIN";
+        return action[0]?.$['android:name'] === 'android.intent.action.MAIN';
     });
     return mainLaunchIntents.length ? mainLaunchIntents[0] : undefined;
 }
 function leanbackLauncherCategoryExistsInMainLaunchIntent(mainLaunchIntent) {
     const mainLaunchCategories = mainLaunchIntent.category ?? [];
-    const mainLaunchIntentCategoriesWithLeanbackLauncher = mainLaunchCategories.filter((c) => c.$["android:name"] === LEANBACK_LAUNCHER_CATEGORY);
+    const mainLaunchIntentCategoriesWithLeanbackLauncher = mainLaunchCategories.filter((c) => c.$['android:name'] === LEANBACK_LAUNCHER_CATEGORY);
     return mainLaunchIntentCategoriesWithLeanbackLauncher.length > 0;
 }
-function setLeanBackLauncherIntent(_config, androidManifest, verbose) {
+function setLeanBackLauncherIntent(_config, androidManifest, params) {
     const mainLaunchIntent = getMainLaunchIntent(androidManifest);
     if (!mainLaunchIntent) {
-        throw new Error(`${pkg.name}@${pkg.version}: no main intent in main activity of Android manifest`);
+        throw new Error(`${utils_1.packageNameAndVersion}: no main intent in main activity of Android manifest`);
     }
     if (!leanbackLauncherCategoryExistsInMainLaunchIntent(mainLaunchIntent)) {
         // Leanback needs to be added
-        if (verbose) {
-            config_plugins_1.WarningAggregator.addWarningAndroid("manifest", `${pkg.name}@${pkg.version}: adding TV leanback launcher category to main intent in AndroidManifest.xml`);
-        }
+        (0, utils_1.verboseLog)('adding TV leanback launcher category to main intent in AndroidManifest.xml', {
+            params,
+            platform: 'android',
+            property: 'manifest',
+        });
         const mainLaunchCategories = mainLaunchIntent.category ?? [];
         mainLaunchCategories.push({
             $: {
-                "android:name": LEANBACK_LAUNCHER_CATEGORY,
+                'android:name': LEANBACK_LAUNCHER_CATEGORY,
             },
         });
         mainLaunchIntent.category = mainLaunchCategories;
@@ -58,17 +57,36 @@ function setLeanBackLauncherIntent(_config, androidManifest, verbose) {
     return androidManifest;
 }
 exports.setLeanBackLauncherIntent = setLeanBackLauncherIntent;
-async function removePortraitOrientation(_config, androidManifest, verbose) {
+function removePortraitOrientation(_config, androidManifest, params) {
     const mainActivity = getMainActivity(androidManifest);
     if (mainActivity?.$) {
         const metadata = mainActivity?.$ ?? {};
-        if (metadata["android:screenOrientation"]) {
-            if (verbose) {
-                config_plugins_1.WarningAggregator.addWarningAndroid("manifest", `${pkg.name}@${pkg.version}: removing screen orientation from AndroidManifest.xml`);
-            }
-            delete metadata["android:screenOrientation"];
+        if (metadata['android:screenOrientation']) {
+            (0, utils_1.verboseLog)('removing screen orientation from AndroidManifest.xml', {
+                params,
+                platform: 'android',
+                property: 'manifest',
+            });
+            delete metadata['android:screenOrientation'];
         }
     }
     return androidManifest;
 }
 exports.removePortraitOrientation = removePortraitOrientation;
+function setTVBanner(_config, androidManifest, params, androidTVBannerPath) {
+    if (!androidTVBannerPath) {
+        return androidManifest;
+    }
+    const mainApplication = getMainApplication(androidManifest);
+    if (mainApplication?.$) {
+        const metadata = mainApplication?.$ ?? {};
+        (0, utils_1.verboseLog)('adding TV banner to AndroidManifest.xml', {
+            params,
+            platform: 'android',
+            property: 'manifest',
+        });
+        metadata['android:banner'] = '@drawable/tv_banner';
+    }
+    return androidManifest;
+}
+exports.setTVBanner = setTVBanner;

package/build/withTVAndroidRemoveFlipper.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPlugin } from 'expo/config-plugins';
+import { ConfigData } from './types';
+/** Dangerously makes or reverts TV changes in the project Podfile. */
+export declare const withTVAndroidRemoveFlipper: ConfigPlugin<ConfigData>;

package/build/withTVAndroidRemoveFlipper.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withTVAndroidRemoveFlipper = void 0;
+const config_plugins_1 = require("expo/config-plugins");
+const fs_1 = require("fs");
+const glob_1 = __importDefault(require("glob"));
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("./utils");
+/** Dangerously makes or reverts TV changes in the project Podfile. */
+const withTVAndroidRemoveFlipper = (c, params = {}) => {
+    const androidRemoveFlipper = (0, utils_1.shouldRemoveFlipperOnAndroid)(params);
+    return (0, config_plugins_1.withDangerousMod)(c, [
+        'android',
+        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+        async (config) => {
+            if (androidRemoveFlipper) {
+                // Modify main application
+                const mainApplicationFile = mainApplicationFilePath(config.modRequest.platformProjectRoot);
+                (0, utils_1.verboseLog)('removing Flipper from MainApplication file', {
+                    params,
+                    platform: 'android',
+                    property: 'manifest',
+                });
+                const mainApplicationContents = await fs_1.promises.readFile(mainApplicationFile, 'utf8');
+                const mainApplicationModifiedContents = commentOutLinesWithString(mainApplicationContents, 'Flipper');
+                await fs_1.promises.writeFile(mainApplicationFile, mainApplicationModifiedContents, 'utf-8');
+                // Modify app/build.gradle
+                const buildGradleFile = appBuildGradleFilePath(config.modRequest.platformProjectRoot);
+                (0, utils_1.verboseLog)('removing Flipper from android/app/build.gradle', {
+                    params,
+                    platform: 'android',
+                    property: 'manifest',
+                });
+                const buildGradleContents = await fs_1.promises.readFile(buildGradleFile, 'utf-8');
+                const buildGradleModifiedContents = commentOutLinesWithString(buildGradleContents, 'flipper');
+                await fs_1.promises.writeFile(buildGradleFile, buildGradleModifiedContents, 'utf-8');
+            }
+            return config;
+        },
+    ]);
+};
+exports.withTVAndroidRemoveFlipper = withTVAndroidRemoveFlipper;
+const mainApplicationFilePath = (androidRoot) => {
+    const paths = glob_1.default.sync(`${androidRoot}/**/MainApplication.*`);
+    if (paths.length > 0) {
+        return paths[0];
+    }
+    else {
+        throw new Error('AndroidApplication path not found');
+    }
+};
+const appBuildGradleFilePath = (androidRoot) => path_1.default.resolve(androidRoot, 'app', 'build.gradle');
+const commentOutLinesWithString = (contents, searchString) => {
+    return contents
+        .split('\n')
+        .map((line) => {
+        if (line.indexOf(searchString) !== -1) {
+            return line.replace(/^/, '// ');
+        }
+        return line;
+    })
+        .join('\n');
+};

package/build/withTVPodfile.d.ts

@@ -1,6 +1,5 @@
-import { ConfigPlugin } from "expo/config-plugins";
-import { ConfigData } from "./types";
+import { ConfigPlugin } from 'expo/config-plugins';
+import { ConfigData } from './types';
 /** Dangerously makes or reverts TV changes in the project Podfile. */
 export declare const withTVPodfile: ConfigPlugin<ConfigData>;
-export declare function removeTVPodfileModifications(src: string): string;
 export declare function addTVPodfileModifications(src: string): string;

package/build/withTVPodfile.js

@@ -3,55 +3,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addTVPodfileModifications = exports.removeTVPodfileModifications = exports.withTVPodfile = void 0;
+exports.addTVPodfileModifications = exports.withTVPodfile = void 0;
 const generateCode_1 = require("@expo/config-plugins/build/utils/generateCode");
 const config_plugins_1 = require("expo/config-plugins");
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils");
-const pkg = require("../package.json");
 /** Dangerously makes or reverts TV changes in the project Podfile. */
 const withTVPodfile = (c, params = {}) => {
-    const isTV = (0, utils_1.isTVEnabled)(params);
-    const verbose = (0, utils_1.showVerboseWarnings)(params);
     return (0, config_plugins_1.withDangerousMod)(c, [
-        "ios",
+        'ios',
         // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
         async (config) => {
-            const file = path_1.default.join(config.modRequest.platformProjectRoot, "Podfile");
-            const contents = await fs_1.promises.readFile(file, "utf8");
-            const modifiedContents = isTV
-                ? addTVPodfileModifications(contents)
-                : removeTVPodfileModifications(contents);
-            if (modifiedContents !== contents) {
-                if (verbose) {
-                    config_plugins_1.WarningAggregator.addWarningIOS("podfile", `${pkg.name}@${pkg.version}: modifying Podfile for ${isTV ? "tvOS" : "iOS"}`);
-                }
-                await fs_1.promises.writeFile(file, modifiedContents, "utf-8");
-            }
+            const file = path_1.default.join(config.modRequest.platformProjectRoot, 'Podfile');
+            const contents = await fs_1.promises.readFile(file, 'utf8');
+            const modifiedContents = addTVPodfileModifications(contents);
+            (0, utils_1.verboseLog)('modifying Podfile for tvOS', {
+                params,
+                platform: 'ios',
+                property: 'podfile',
+            });
+            await fs_1.promises.writeFile(file, modifiedContents, 'utf-8');
             return config;
         },
     ]);
 };
 exports.withTVPodfile = withTVPodfile;
-const MOD_TAG = "react-native-tvos-import";
-function removeTVPodfileModifications(src) {
-    if (src.indexOf("platform :tvos") === -1) {
-        return src;
-    }
-    const intermediateSrc = src.replace("platform :tvos", "platform :ios");
-    const newSrc = (0, generateCode_1.removeContents)({
-        src: intermediateSrc,
-        tag: MOD_TAG,
-    }).contents;
-    if (!newSrc) {
-        throw new Error(`${pkg.name}@${pkg.version}: Error in removing TV modifications from Podfile. Recommend running "npx expo prebuild --clean"`);
-    }
-    return newSrc;
-}
-exports.removeTVPodfileModifications = removeTVPodfileModifications;
+const MOD_TAG = 'react-native-tvos-import';
 function addTVPodfileModifications(src) {
-    if (src.indexOf("platform :tvos") !== -1) {
+    if (src.indexOf('platform :tvos') !== -1) {
         return src;
     }
     const newSrc = (0, generateCode_1.mergeContents)({
@@ -60,8 +40,8 @@ function addTVPodfileModifications(src) {
         newSrc: "source 'https://github.com/react-native-tvos/react-native-tvos-podspecs.git'\nsource 'https://cdn.cocoapods.org/'\n",
         anchor: /^/,
         offset: 0,
-        comment: "#",
+        comment: '#',
     }).contents;
-    return newSrc.replace("platform :ios", "platform :tvos");
+    return newSrc.replace('platform :ios', 'platform :tvos');
 }
 exports.addTVPodfileModifications = addTVPodfileModifications;

package/build/withTVSplashScreen.d.ts

@@ -1,6 +1,5 @@
-import { ConfigPlugin } from "expo/config-plugins";
-import { ConfigData } from "./types";
-/** Dangerously modifies or reverts changes needed for TV in SplashScreen.storyboard. */
+import { ConfigPlugin } from 'expo/config-plugins';
+import { ConfigData } from './types';
+/** Dangerously makes changes needed for TV in SplashScreen.storyboard. */
 export declare const withTVSplashScreen: ConfigPlugin<ConfigData>;
 export declare function addTVSplashScreenModifications(src: string): string;
-export declare function removeTVSplashScreenModifications(src: string): string;

package/build/withTVSplashScreen.js

@@ -3,47 +3,42 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeTVSplashScreenModifications = exports.addTVSplashScreenModifications = exports.withTVSplashScreen = void 0;
+exports.addTVSplashScreenModifications = exports.withTVSplashScreen = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils");
-const pkg = require("../package.json");
-/** Dangerously modifies or reverts changes needed for TV in SplashScreen.storyboard. */
+/** Dangerously makes changes needed for TV in SplashScreen.storyboard. */
 const withTVSplashScreen = (config, params = {}) => {
-    const isTV = (0, utils_1.isTVEnabled)(params);
-    const verbose = (0, utils_1.showVerboseWarnings)(params);
     return (0, config_plugins_1.withDangerousMod)(config, [
-        "ios",
+        'ios',
         // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
         async (config) => {
             if (!config.modRequest.projectName) {
-                throw new Error(`The ${pkg.name}@${pkg.version} plugin requires a configured project name.`);
-            }
-            const file = path_1.default.join(config.modRequest.platformProjectRoot, config.modRequest.projectName, "SplashScreen.storyboard");
-            const contents = await fs_1.promises.readFile(file, "utf8");
-            const modifiedContents = isTV
-                ? addTVSplashScreenModifications(contents)
-                : removeTVSplashScreenModifications(contents);
-            if (modifiedContents !== contents) {
-                if (verbose) {
-                    config_plugins_1.WarningAggregator.addWarningIOS("splashscreen", `${pkg.name}@${pkg.version}:: modifying SplashScreen.storyboard for ${isTV ? "tvOS" : "iOS"}`);
-                }
-                await fs_1.promises.writeFile(file, modifiedContents, "utf-8");
+                throw new Error(`The ${utils_1.packageNameAndVersion} plugin requires a configured project name.`);
             }
+            const file = path_1.default.join(config.modRequest.platformProjectRoot, config.modRequest.projectName, 'SplashScreen.storyboard');
+            const contents = await fs_1.promises.readFile(file, 'utf8');
+            const modifiedContents = addTVSplashScreenModifications(contents);
+            (0, utils_1.verboseLog)('modifying SplashScreen.storyboard for tvOS', {
+                params,
+                platform: 'ios',
+                property: 'splashscreen',
+            });
+            await fs_1.promises.writeFile(file, modifiedContents, 'utf-8');
             return config;
         },
     ]);
 };
 exports.withTVSplashScreen = withTVSplashScreen;
 const splashScreenStringsForPhone = [
-    "com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB",
+    'com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB',
     'targetRuntime="iOS.CocoaTouch"',
     'id="retina5_5"',
     '<deployment identifier="iOS"/>',
 ];
 const splashScreenStringsForTV = [
-    "com.apple.InterfaceBuilder.AppleTV.Storyboard",
+    'com.apple.InterfaceBuilder.AppleTV.Storyboard',
     'targetRuntime="AppleTV"',
     'id="appleTV"',
     '<deployment identifier="tvOS"/>',
@@ -51,7 +46,7 @@ const splashScreenStringsForTV = [
 function modifySource(src, originalStrings, replacementStrings) {
     let modifiedSource = src;
     originalStrings.forEach((s, i) => {
-        const original = new RegExp(`${s}`, "g");
+        const original = new RegExp(`${s}`, 'g');
         const replacement = replacementStrings[i];
         modifiedSource = modifiedSource.replace(original, replacement);
     });
@@ -61,7 +56,3 @@ function addTVSplashScreenModifications(src) {
     return modifySource(src, splashScreenStringsForPhone, splashScreenStringsForTV);
 }
 exports.addTVSplashScreenModifications = addTVSplashScreenModifications;
-function removeTVSplashScreenModifications(src) {
-    return modifySource(src, splashScreenStringsForTV, splashScreenStringsForPhone);
-}
-exports.removeTVSplashScreenModifications = removeTVSplashScreenModifications;

package/build/withTVXcodeProject.d.ts

@@ -2,18 +2,8 @@ import { ExpoConfig } from '@expo/config-types';
 import { ConfigPlugin, XcodeProject } from 'expo/config-plugins';
 import { ConfigData } from './types';
 export declare const withTVXcodeProject: ConfigPlugin<ConfigData>;
-export declare function setXcodeProjectBuildSettings(config: Pick<ExpoConfig, 'ios'>, { project, isTV, verbose, deploymentTarget, }: {
+export declare function setXcodeProjectBuildSettings(config: Pick<ExpoConfig, 'ios'>, { project, params, deploymentTarget, }: {
     project: XcodeProject;
-    isTV: boolean;
-    verbose: boolean;
+    params: ConfigData;
     deploymentTarget: string;
 }): XcodeProject;
-/**
- * Wrapping the families in double quotes is the only way to set a value with a comma in it.
- *
- * @param deviceFamilies
- */
-export declare function formatDeviceFamilies(deviceFamilies: number[]): string;
-export declare function getSupportsTablet(config: Pick<ExpoConfig, 'ios'>): boolean;
-export declare function getIsTabletOnly(config: Pick<ExpoConfig, 'ios'>): boolean;
-export declare function getDeviceFamilies(config: Pick<ExpoConfig, 'ios'>): number[];

package/build/withTVXcodeProject.js

@@ -1,36 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDeviceFamilies = exports.getIsTabletOnly = exports.getSupportsTablet = exports.formatDeviceFamilies = exports.setXcodeProjectBuildSettings = exports.withTVXcodeProject = void 0;
+exports.setXcodeProjectBuildSettings = exports.withTVXcodeProject = void 0;
 const config_plugins_1 = require("expo/config-plugins");
 const utils_1 = require("./utils");
-const pkg = require('../package.json');
 const withTVXcodeProject = (config, params) => {
-    const isTV = (0, utils_1.isTVEnabled)(params);
-    const verbose = (0, utils_1.showVerboseWarnings)(params);
     const deploymentTarget = (0, utils_1.tvosDeploymentTarget)(params);
     return (0, config_plugins_1.withXcodeProject)(config, async (config) => {
         config.modResults = await setXcodeProjectBuildSettings(config, {
             project: config.modResults,
-            isTV,
-            verbose,
+            params,
             deploymentTarget,
         });
         return config;
     });
 };
 exports.withTVXcodeProject = withTVXcodeProject;
-function setXcodeProjectBuildSettings(config, { project, isTV, verbose, deploymentTarget, }) {
-    const deviceFamilies = formatDeviceFamilies(getDeviceFamilies(config));
+function setXcodeProjectBuildSettings(config, { project, params, deploymentTarget, }) {
     const configurations = project.pbxXCBuildConfigurationSection();
     // @ts-ignore
     for (const { buildSettings } of Object.values(configurations || {})) {
         // Guessing that this is the best way to emulate Xcode.
         // Using `project.addToBuildSettings` modifies too many targets.
         if (typeof buildSettings?.PRODUCT_NAME !== 'undefined') {
-            if (isTV && buildSettings.TARGETED_DEVICE_FAMILY !== '3') {
-                if (verbose) {
-                    config_plugins_1.WarningAggregator.addWarningIOS('xcodeproject', `${pkg.name}@${pkg.version}: modifying target ${buildSettings?.PRODUCT_NAME} for ${isTV ? 'tvOS' : 'iOS'}`);
-                }
+            if (buildSettings.TARGETED_DEVICE_FAMILY !== '3') {
+                (0, utils_1.verboseLog)(`modifying target ${buildSettings?.PRODUCT_NAME} for tvOS`, {
+                    params,
+                    platform: 'ios',
+                    property: 'xcodeproject',
+                });
                 buildSettings.TARGETED_DEVICE_FAMILY = '3';
                 buildSettings.TVOS_DEPLOYMENT_TARGET = deploymentTarget;
                 buildSettings.SDKROOT = 'appletvos';
@@ -38,53 +35,8 @@ function setXcodeProjectBuildSettings(config, { project, isTV, verbose, deployme
                     delete buildSettings?.IOS_DEPLOYMENT_TARGET;
                 }
             }
-            else if (!isTV && buildSettings.TARGETED_DEVICE_FAMILY === '3') {
-                config_plugins_1.WarningAggregator.addWarningIOS('xcodeproject', `${pkg.name}@${pkg.version}: modifying target ${buildSettings?.PRODUCT_NAME} for ${isTV ? 'tvOS' : 'iOS'}`);
-                buildSettings.TARGETED_DEVICE_FAMILY = deviceFamilies;
-                buildSettings.IOS_DEPLOYMENT_TARGET = deploymentTarget;
-                buildSettings.SDKROOT = 'iphoneos';
-                if (typeof buildSettings?.TVOS_DEPLOYMENT_TARGET !== 'undefined') {
-                    delete buildSettings?.TVOS_DEPLOYMENT_TARGET;
-                }
-            }
         }
     }
     return project;
 }
 exports.setXcodeProjectBuildSettings = setXcodeProjectBuildSettings;
-/**
- * Wrapping the families in double quotes is the only way to set a value with a comma in it.
- *
- * @param deviceFamilies
- */
-function formatDeviceFamilies(deviceFamilies) {
-    return `"${deviceFamilies.join(',')}"`;
-}
-exports.formatDeviceFamilies = formatDeviceFamilies;
-function getSupportsTablet(config) {
-    return !!config.ios?.supportsTablet;
-}
-exports.getSupportsTablet = getSupportsTablet;
-function getIsTabletOnly(config) {
-    return !!config?.ios?.isTabletOnly;
-}
-exports.getIsTabletOnly = getIsTabletOnly;
-function getDeviceFamilies(config) {
-    const supportsTablet = getSupportsTablet(config);
-    const isTabletOnly = getIsTabletOnly(config);
-    if (isTabletOnly && config.ios?.supportsTablet === false) {
-        // add warning
-    }
-    // 1 is iPhone, 2 is iPad
-    if (isTabletOnly) {
-        return [2];
-    }
-    else if (supportsTablet) {
-        return [1, 2];
-    }
-    else {
-        // is iPhone only
-        return [1];
-    }
-}
-exports.getDeviceFamilies = getDeviceFamilies;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-tvos/config-tv",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Config plugin to reconfigure native directories for Apple TV and Android TV development if needed",
   "main": "build/withTV.js",
   "types": "build/withTV.d.ts",
@@ -34,7 +34,7 @@
     "react-native-tvos"
   ],
   "peerDependencies": {
-    "expo": "^50.0.0.alpha.5"
+    "expo": "^50.0.6"
   },
   "devDependencies": {
     "@types/getenv": "^1.0.1",