react-native-bundle-discovery-ui 2.1.0 → 2.2.0

package/README.md

@@ -3,13 +3,11 @@
 [![react-native-bundle-discovery on npm](https://badgen.net/npm/v/react-native-bundle-discovery)](https://www.npmjs.com/package/react-native-bundle-discovery)
 [![react-native-bundle-discovery downloads](https://badgen.net/npm/dm/react-native-bundle-discovery)](https://www.npmtrends.com/react-native-bundle-discovery)
 
-
 A simple package that helps developers visualize and analyze the bundle size of React Native apps.
 With this tool, you can easily explore your app's codebase, identify large or heavy packages, and inspect the structure of modules and code within your project.
 
 <img width="800" alt="" src="./assets/img.png" />
 
-
 ### Packages:
 
 - `react-native-bundle-discovery` - simple JS library to generate a JSON report of the bundle.
@@ -21,7 +19,7 @@ With this tool, you can easily explore your app's codebase, identify large or he
 
 There are two ways to install the package:
 
-1. As in independent tool (UI + CLI) 
+1. As in independent tool (UI + CLI)
 2. Or as a [Rozenite](_rozenite/README.md) plugin (see: [_rozenite/README.md](_rozenite/README.md))
 
 #### 1. Install (independent tool)
@@ -112,30 +110,34 @@ npx react-native-bundle-discovery-ui build metro-stats.json
 | outputJsonPath: string | `<root>/metro-stats.json` | The path where the JSON report will be saved. Defaults to `metro-stats.json` in project root.                                            |
 | includeCode: boolean   | `true`                    | Whether to include the source and output code in the JSON report.                                                                        |
 
-### `createProcessModuleFilter(options: ProcessModuleFilterOptions)`
+**⚠️ Be cautious sharing reports with `includeCode` enabled**
+
+Enabling this option significantly increases report size and **embeds the source code** of your assets.
 
+If your code is proprietary 🔒, share these reports responsibly 🤝!
+
+---
 
-| Prop                   | Default value             | Description                   |
-| ---------------------- | ------------------------- | ----------------------------- |
-| removePromisePolyfill: boolean | `false` | Remove the Promise polyfill as Hermes provide own impl. (issue: [#57702](https://github.com/react/react-native/issues/57702)) |
-| removeOldRenderer: boolean     | `false` | Whether to remove the old renderer. Set to `true` when New Arch is enabled    |
-| removeNewRenderer: boolean     | `false` | Whether to remove the new renderer. Set to `true` when New Arch is disabled    |
-| removeUTFSequence: boolean     | `false` | Remove useless undocumented RN module.     |
+### `createResolveRequest(options: ResolveRequestOptions)`
 
+| Prop                           | Default value | Description                                                                                                                   |
+| ------------------------------ | ------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| removePromisePolyfill: boolean | `false`       | Remove the Promise polyfill as Hermes provide own impl. (issue: [#57702](https://github.com/react/react-native/issues/57702)) |
+| removeUTFSequence: boolean     | `false`       | Remove useless undocumented RN module.                                                                                        |
 
-Simple helper that devs can use to filter out unnecessary modules from the bundle report.
+Helper that creates a custom resolve request function to filter out unnecessary modules from the bundle.
 You can get recommendations during the analysis of the bundle report using the CLI tool.
 
 ```js
 // metro.config.js
-const {createProcessModuleFilter} = require('react-native-bundle-discovery');
+const { createResolveRequest } = require("react-native-bundle-discovery");
+const resolveRequest = createResolveRequest({
+  removePromisePolyfill: true,
+  removeUTFSequence: true,
+});
 const config = {
-  serializer: {
-    processModuleFilter: createProcessModuleFilter({
-      removePromisePolyfill: true,
-      removeOldRenderer: true,
-      removeUTFSequence: true,
-    }),
+  resolver: {
+    resolveRequest,
   },
 };
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-bundle-discovery-ui",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "main": "lib/bin.js",
   "bin": "lib/bin.js",
   "repository": "git@github.com:retyui/react-native-bundle-discovery.git",