expo-build-properties 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -10,7 +10,13 @@
 
 ### 💡 Others
 
-## 0.6.0 — 2023-04-14
+## 0.7.0 — 2023-05-08
+
+### 🐛 Bug fixes
+
+- Fixed false alarm error throwing when `ios.flipper=false` and `useFrameworks`. ([#22296](https://github.com/expo/expo/pull/22296) by [@kudo](https://github.com/kudo))
+
+## 0.6.0 - 2023-04-14
 
 ### 🎉 New features
 

package/README.md

@@ -1,6 +1,6 @@
 # expo-build-properties
 
-**`expo-build-properties`** is a config plugin for managed apps to override the default native build properties.
+**`expo-build-properties`** is a [config plugin](https://docs.expo.dev/config-plugins/introduction/) to customize native build properties when using [`npx expo prebuild`](https://docs.expo.dev/workflow/prebuild/).
 
 ## API documentation
 
@@ -9,10 +9,8 @@
 
 ### Installation
 
-**Note:** To use this config plugin, your apps must be a managed app and build by either [EAS Build](/build/introduction.md) or `expo run:[android|ios]`.
-
 ```
-expo install expo-build-properties
+npx expo install expo-build-properties
 ```
 
 Add plugin to `app.json`. For example:
@@ -48,4 +46,4 @@ Contributions are very welcome! Please refer to guidelines described in the [con
 [docs-main]: https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/build-properties.mdx
 [docs-stable]: https://docs.expo.dev/versions/latest/sdk/build-properties/
 [contributing]: https://github.com/expo/expo#contributing
-[config-plugins]: https://docs.expo.dev/guides/config-plugins/
+[config-plugins]: https://docs.expo.dev/home/config-plugins/introduction

package/build/pluginConfig.d.ts

@@ -60,10 +60,11 @@ export interface PluginConfigTypeAndroid {
      */
     packagingOptions?: PluginConfigTypeAndroidPackagingOptions;
     /**
-     * Change the [Flipper](https://fbflipper.com/) version when running your app on Android.
-     * Flipper is by default enabled with the version that comes bundled with react-native.
-     * However, you can set the `flipper` property to a semver string and specify an
-     * alternate Flipper version.
+     * By default, Flipper is enabled with the version that comes bundled with `react-native`.
+     *
+     * Use this to change the [Flipper](https://fbflipper.com/) version when
+     * running your app on Android. You can set the `flipper` property to a
+     * semver string and specify an alternate Flipper version.
      */
     flipper?: string;
     /**
@@ -91,16 +92,17 @@ export interface PluginConfigTypeIos {
      * Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang)
      * in `Podfile` to use frameworks instead of static libraries for Pods.
      *
-     * Note: You cannot use `useFrameworks` and `flipper` at the same time
+     * > You cannot use `useFrameworks` and `flipper` at the same time , and
+     * doing so will generate an error.
      */
     useFrameworks?: 'static' | 'dynamic';
     /**
      * Enable [Flipper](https://fbflipper.com/) when running your app on iOS in
      * Debug mode. Setting `true` enables the default version of Flipper, while
      * setting a semver string will enable a specific version of Flipper you've
-     * declared in your package.json. The default for this configuration is `false`.
+     * declared in your **package.json**. The default for this configuration is `false`.
      *
-     * Note: You cannot use `flipper` at the same time as `useFrameworks`, and
+     * > You cannot use `flipper` at the same time as `useFrameworks`, and
      * doing so will generate an error.
      */
     flipper?: boolean | string;

package/build/pluginConfig.js

@@ -130,7 +130,7 @@ function validateConfig(config) {
     maybeThrowInvalidVersions(config);
     // explicitly block using use_frameworks and Flipper in iOS
     // https://github.com/facebook/flipper/issues/2414
-    if (config?.ios?.flipper !== undefined && config?.ios?.useFrameworks !== undefined) {
+    if (Boolean(config.ios?.flipper) && config.ios?.useFrameworks !== undefined) {
         throw new Error('`ios.flipper` cannot be enabled when `ios.useFrameworks` is set.');
     }
     if (config.android?.enableShrinkResourcesInReleaseBuilds === true &&

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-build-properties",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Config plugin to customize native build properties on prebuild",
   "main": "build/withBuildProperties.js",
   "types": "build/withBuildProperties.d.ts",
@@ -40,5 +40,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "6b73082d014ebe93f091aa75cd06f4d4d90eff19"
+  "gitHead": "4ba50c428c8369bb6b3a51a860d4898ad4ccbe78"
 }

package/src/pluginConfig.ts

@@ -81,10 +81,11 @@ export interface PluginConfigTypeAndroid {
   packagingOptions?: PluginConfigTypeAndroidPackagingOptions;
 
   /**
-   * Change the [Flipper](https://fbflipper.com/) version when running your app on Android.
-   * Flipper is by default enabled with the version that comes bundled with react-native.
-   * However, you can set the `flipper` property to a semver string and specify an
-   * alternate Flipper version.
+   * By default, Flipper is enabled with the version that comes bundled with `react-native`.
+   *
+   * Use this to change the [Flipper](https://fbflipper.com/) version when
+   * running your app on Android. You can set the `flipper` property to a
+   * semver string and specify an alternate Flipper version.
    */
   flipper?: string;
 
@@ -115,7 +116,8 @@ export interface PluginConfigTypeIos {
    * Enable [`use_frameworks!`](https://guides.cocoapods.org/syntax/podfile.html#use_frameworks_bang)
    * in `Podfile` to use frameworks instead of static libraries for Pods.
    *
-   * Note: You cannot use `useFrameworks` and `flipper` at the same time
+   * > You cannot use `useFrameworks` and `flipper` at the same time , and
+   * doing so will generate an error.
    */
   useFrameworks?: 'static' | 'dynamic';
 
@@ -123,9 +125,9 @@ export interface PluginConfigTypeIos {
    * Enable [Flipper](https://fbflipper.com/) when running your app on iOS in
    * Debug mode. Setting `true` enables the default version of Flipper, while
    * setting a semver string will enable a specific version of Flipper you've
-   * declared in your package.json. The default for this configuration is `false`.
+   * declared in your **package.json**. The default for this configuration is `false`.
    *
-   * Note: You cannot use `flipper` at the same time as `useFrameworks`, and
+   * > You cannot use `flipper` at the same time as `useFrameworks`, and
    * doing so will generate an error.
    */
   flipper?: boolean | string;
@@ -284,7 +286,7 @@ export function validateConfig(config: any): PluginConfigType {
 
   // explicitly block using use_frameworks and Flipper in iOS
   // https://github.com/facebook/flipper/issues/2414
-  if (config?.ios?.flipper !== undefined && config?.ios?.useFrameworks !== undefined) {
+  if (Boolean(config.ios?.flipper) && config.ios?.useFrameworks !== undefined) {
     throw new Error('`ios.flipper` cannot be enabled when `ios.useFrameworks` is set.');
   }