expo-build-properties 0.5.1 → 0.5.2

package/CHANGELOG.md

@@ -10,6 +10,12 @@
 
 ### 💡 Others
 
+## 0.5.2 — 2023-04-03
+
+### 🎉 New features
+
+- Added `enableShrinkResourcesInReleaseBuilds` property to enable Android `shrinkResources` build feature. ([#21911](https://github.com/expo/expo/pull/21911) by [@kudo](https://github.com/kudo))
+
 ## 0.5.1 — 2023-02-09
 
 ### 🎉 New features

package/build/android.js

@@ -54,6 +54,10 @@ exports.withAndroidBuildProperties = createBuildGradlePropsConfigPlugin([
         propName: 'android.enableProguardInReleaseBuilds',
         propValueGetter: (config) => config.android?.enableProguardInReleaseBuilds?.toString(),
     },
+    {
+        propName: 'android.enableShrinkResourcesInReleaseBuilds',
+        propValueGetter: (config) => config.android?.enableShrinkResourcesInReleaseBuilds?.toString(),
+    },
 ], 'withAndroidBuildProperties');
 const withAndroidFlipper = (config, props) => {
     const ANDROID_FLIPPER_KEY = 'FLIPPER_VERSION';

package/build/pluginConfig.d.ts

@@ -46,6 +46,11 @@ export interface PluginConfigTypeAndroid {
      * Enable [Proguard or R8](https://developer.android.com/studio/build/shrink-code) in release builds to obfuscate Java code and reduce app size.
      */
     enableProguardInReleaseBuilds?: boolean;
+    /**
+     * Enable [`shrinkResources`](https://developer.android.com/studio/build/shrink-code#shrink-resources) in release builds to remove unused resources from the app.
+     * This property should be used in combination with `enableProguardInReleaseBuilds`.
+     */
+    enableShrinkResourcesInReleaseBuilds?: boolean;
     /**
      * Append custom [Proguard rules](https://www.guardsquare.com/manual/configuration/usage) to **android/app/proguard-rules.pro**.
      */
@@ -55,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;
 }
@@ -81,16 +87,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

@@ -34,6 +34,7 @@ const schema = {
                 buildToolsVersion: { type: 'string', nullable: true },
                 kotlinVersion: { type: 'string', nullable: true },
                 enableProguardInReleaseBuilds: { type: 'boolean', nullable: true },
+                enableShrinkResourcesInReleaseBuilds: { type: 'boolean', nullable: true },
                 extraProguardRules: { type: 'string', nullable: true },
                 flipper: {
                     type: 'string',
@@ -130,6 +131,10 @@ function validateConfig(config) {
     if (config?.ios?.flipper !== undefined && config?.ios?.useFrameworks !== undefined) {
         throw new Error('`ios.flipper` cannot be enabled when `ios.useFrameworks` is set.');
     }
+    if (config.android?.enableShrinkResourcesInReleaseBuilds === true &&
+        config.android?.enableProguardInReleaseBuilds !== true) {
+        throw new Error('`android.enableShrinkResourcesInReleaseBuilds` requires `android.enableProguardInReleaseBuilds` to be enabled.');
+    }
     return config;
 }
 exports.validateConfig = validateConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-build-properties",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "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": "1f8a6a09570fd451378565ca34933018ce48454e"
+  "gitHead": "014aa056080fd88a11b09b5be7c3ba078fbec7d0"
 }

package/src/android.ts

@@ -59,6 +59,10 @@ export const withAndroidBuildProperties = createBuildGradlePropsConfigPlugin<Plu
       propName: 'android.enableProguardInReleaseBuilds',
       propValueGetter: (config) => config.android?.enableProguardInReleaseBuilds?.toString(),
     },
+    {
+      propName: 'android.enableShrinkResourcesInReleaseBuilds',
+      propValueGetter: (config) => config.android?.enableShrinkResourcesInReleaseBuilds?.toString(),
+    },
   ],
   'withAndroidBuildProperties'
 );

package/src/pluginConfig.ts

@@ -66,6 +66,11 @@ export interface PluginConfigTypeAndroid {
    * Enable [Proguard or R8](https://developer.android.com/studio/build/shrink-code) in release builds to obfuscate Java code and reduce app size.
    */
   enableProguardInReleaseBuilds?: boolean;
+  /**
+   * Enable [`shrinkResources`](https://developer.android.com/studio/build/shrink-code#shrink-resources) in release builds to remove unused resources from the app.
+   * This property should be used in combination with `enableProguardInReleaseBuilds`.
+   */
+  enableShrinkResourcesInReleaseBuilds?: boolean;
   /**
    * Append custom [Proguard rules](https://www.guardsquare.com/manual/configuration/usage) to **android/app/proguard-rules.pro**.
    */
@@ -76,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;
 }
@@ -104,7 +110,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';
 
@@ -112,9 +119,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;
@@ -157,6 +164,7 @@ const schema: JSONSchemaType<PluginConfigType> = {
         kotlinVersion: { type: 'string', nullable: true },
 
         enableProguardInReleaseBuilds: { type: 'boolean', nullable: true },
+        enableShrinkResourcesInReleaseBuilds: { type: 'boolean', nullable: true },
         extraProguardRules: { type: 'string', nullable: true },
 
         flipper: {
@@ -266,5 +274,14 @@ export function validateConfig(config: any): PluginConfigType {
     throw new Error('`ios.flipper` cannot be enabled when `ios.useFrameworks` is set.');
   }
 
+  if (
+    config.android?.enableShrinkResourcesInReleaseBuilds === true &&
+    config.android?.enableProguardInReleaseBuilds !== true
+  ) {
+    throw new Error(
+      '`android.enableShrinkResourcesInReleaseBuilds` requires `android.enableProguardInReleaseBuilds` to be enabled.'
+    );
+  }
+
   return config;
 }