react-native-boost 1.0.0 → 1.1.0

package/README.md

@@ -20,10 +20,19 @@ The documentation is available at [react-native-boost.oss.kuatsu.de](https://rea
 The app in the `apps/example` directory serves as a benchmark for the performance of the plugin.
 
 <div align="center">
-  <img src="./apps/docs/docs/introduction/img/benchmark-ios.png" width="500" />
+  <img src="./apps/docs/content/docs/information/img/benchmark-ios.png" width="500" />
 </div>
 
-More benchmarks are available in the [docs](https://react-native-boost.oss.kuatsu.de/docs/introduction/benchmarks).
+More benchmarks are available in the [docs](https://react-native-boost.oss.kuatsu.de/docs/information/benchmarks).
+
+## Compatibility
+
+| `react-native-boost` | React Native     |
+| -------------------- | ---------------- |
+| `0.x`                | All versions[^1] |
+| `1.x`                | `>=0.83`         |
+
+[^1]: Starting from React Native `0.80`, `react-native-boost@0` prints import deprecation warnings.
 
 ## Installation
 
@@ -59,11 +68,11 @@ yarn start --clear
 
 That's it! No imports in your code, rebuilding, or anything else is required.
 
-Optionally, you can configure the Babel plugin with a few options described in the [documentation](https://react-native-boost.oss.kuatsu.de/docs/babel-plugin/configure).
+Optionally, you can configure the Babel plugin with a few options described in the [documentation](https://react-native-boost.oss.kuatsu.de/docs/configuration/configure).
 
 ## How it works
 
-A technical rundown of how the plugin works can be found in the [docs](https://react-native-boost.oss.kuatsu.de/docs/introduction/how-it-works).
+A technical rundown of how the plugin works can be found in the [docs](https://react-native-boost.oss.kuatsu.de/docs/information/how-it-works).
 
 ## Contributing
 

package/dist/plugin/esm/index.mjs

@@ -40,17 +40,23 @@ const isIgnoredFile = (path, ignores) => {
   }
   return false;
 };
+const isForcedLine = (path) => {
+  return hasDecoratorComment(path, "@boost-force");
+};
 const isIgnoredLine = (path) => {
+  return hasDecoratorComment(path, "@boost-ignore");
+};
+function hasDecoratorComment(path, decorator) {
   var _a, _b, _c;
-  if ((_a = path.node.leadingComments) == null ? void 0 : _a.some((comment) => comment.value.includes("@boost-ignore"))) {
+  if ((_a = path.node.leadingComments) == null ? void 0 : _a.some((comment) => comment.value.includes(decorator))) {
     return true;
   }
   const jsxElementPath = path.parentPath;
-  if ((_b = jsxElementPath.node.leadingComments) == null ? void 0 : _b.some((comment) => comment.value.includes("@boost-ignore"))) {
+  if ((_b = jsxElementPath.node.leadingComments) == null ? void 0 : _b.some((comment) => comment.value.includes(decorator))) {
     return true;
   }
   const propertyPath = jsxElementPath.parentPath;
-  if (propertyPath && propertyPath.isObjectProperty() && ((_c = propertyPath.node.leadingComments) == null ? void 0 : _c.some((comment) => comment.value.includes("@boost-ignore")))) {
+  if (propertyPath && propertyPath.isObjectProperty() && ((_c = propertyPath.node.leadingComments) == null ? void 0 : _c.some((comment) => comment.value.includes(decorator)))) {
     return true;
   }
   if (!jsxElementPath.parentPath) return false;
@@ -71,18 +77,18 @@ const isIgnoredLine = (path) => {
           ...expression.node.trailingComments || [],
           ...expression.node.innerComments || []
         ].map((comment) => comment.value.trim());
-        if (comments.some((comment) => comment.includes("@boost-ignore"))) {
+        if (comments.some((comment) => comment.includes(decorator))) {
           return true;
         }
       }
     }
-    if (sibling.node.leadingComments && sibling.node.leadingComments.some((comment) => comment.value.includes("@boost-ignore"))) {
+    if (sibling.node.leadingComments && sibling.node.leadingComments.some((comment) => comment.value.includes(decorator))) {
       return true;
     }
     break;
   }
   return false;
-};
+}
 const isValidJSXComponent = (path, componentName) => {
   if (!types.isJSXIdentifier(path.node.name)) return false;
   const parent = path.parent;
@@ -736,16 +742,10 @@ const textBlacklistedProperties = /* @__PURE__ */ new Set([
 ]);
 const textOptimizer = (path, logger) => {
   if (!isValidJSXComponent(path, "Text")) return;
+  if (!isReactNativeImport(path, "Text")) return;
   const parent = path.parent;
-  const skipReason = getFirstBailoutReason([
-    {
-      reason: "line is marked with @boost-ignore",
-      shouldBail: () => isIgnoredLine(path)
-    },
-    {
-      reason: "Text is not imported from react-native",
-      shouldBail: () => !isReactNativeImport(path, "Text")
-    },
+  const forced = isForcedLine(path);
+  const overridableChecks = [
     {
       reason: "contains blacklisted props",
       shouldBail: () => hasBlacklistedProperty(path, textBlacklistedProperties)
@@ -758,14 +758,24 @@ const textOptimizer = (path, logger) => {
       reason: "contains non-string children",
       shouldBail: () => hasInvalidChildren(path, parent)
     }
-  ]);
-  if (skipReason) {
-    logger.skipped({
-      component: "Text",
-      path,
-      reason: skipReason
-    });
-    return;
+  ];
+  if (forced) {
+    const overriddenReason = getFirstBailoutReason(overridableChecks);
+    if (overriddenReason) {
+      logger.forced({ component: "Text", path, reason: overriddenReason });
+    }
+  } else {
+    const skipReason = getFirstBailoutReason([
+      {
+        reason: "line is marked with @boost-ignore",
+        shouldBail: () => isIgnoredLine(path)
+      },
+      ...overridableChecks
+    ]);
+    if (skipReason) {
+      logger.skipped({ component: "Text", path, reason: skipReason });
+      return;
+    }
   }
   const hub = path.hub;
   const file = typeof hub === "object" && hub !== null && "file" in hub ? hub.file : void 0;
@@ -870,11 +880,14 @@ const ANSI_RESET = "\x1B[0m";
 const ANSI_GREEN = "\x1B[32m";
 const ANSI_YELLOW = "\x1B[33m";
 const ANSI_MAGENTA = "\x1B[35m";
+const ANSI_RED = "\x1B[31m";
 const noopLogger = {
   optimized() {
   },
   skipped() {
   },
+  forced() {
+  },
   warning() {
   }
 };
@@ -888,6 +901,12 @@ const createLogger = ({ verbose, silent }) => {
       if (!verbose) return;
       writeLog("skipped", `Skipped ${payload.component} in ${formatPathLocation(payload.path)} (${payload.reason})`);
     },
+    forced(payload) {
+      writeLog(
+        "forced",
+        `Force-optimized ${payload.component} in ${formatPathLocation(payload.path)} (skipped bailout: ${payload.reason})`
+      );
+    },
     warning(payload) {
       const context = formatWarningContext(payload);
       const message = context.length > 0 ? `${context}: ${payload.message}` : payload.message;
@@ -916,6 +935,9 @@ function formatLevel(level) {
   if (level === "skipped") {
     return colorize("[skipped]", ANSI_YELLOW);
   }
+  if (level === "forced") {
+    return colorize("[forced]", ANSI_RED);
+  }
   return colorize("[warning]", ANSI_MAGENTA);
 }
 function colorize(value, colorCode) {
@@ -967,6 +989,7 @@ const viewBlacklistedProperties = /* @__PURE__ */ new Set([
 ]);
 const viewOptimizer = (path, logger, options) => {
   if (!isValidJSXComponent(path, "View")) return;
+  if (!isReactNativeImport(path, "View")) return;
   let ancestorClassification;
   const getAncestorClassification = () => {
     if (!ancestorClassification) {
@@ -974,15 +997,8 @@ const viewOptimizer = (path, logger, options) => {
     }
     return ancestorClassification;
   };
-  const skipReason = getFirstBailoutReason([
-    {
-      reason: "line is marked with @boost-ignore",
-      shouldBail: () => isIgnoredLine(path)
-    },
-    {
-      reason: "View is not imported from react-native",
-      shouldBail: () => !isReactNativeImport(path, "View")
-    },
+  const forced = isForcedLine(path);
+  const overridableChecks = [
     {
       reason: "contains blacklisted props",
       shouldBail: () => hasBlacklistedProperty(path, viewBlacklistedProperties)
@@ -995,14 +1011,24 @@ const viewOptimizer = (path, logger, options) => {
       reason: "has unresolved ancestor and dangerous optimization is disabled",
       shouldBail: () => getAncestorClassification() === "unknown" && (options == null ? void 0 : options.dangerouslyOptimizeViewWithUnknownAncestors) !== true
     }
-  ]);
-  if (skipReason) {
-    logger.skipped({
-      component: "View",
-      path,
-      reason: skipReason
-    });
-    return;
+  ];
+  if (forced) {
+    const overriddenReason = getFirstBailoutReason(overridableChecks);
+    if (overriddenReason) {
+      logger.forced({ component: "View", path, reason: overriddenReason });
+    }
+  } else {
+    const skipReason = getFirstBailoutReason([
+      {
+        reason: "line is marked with @boost-ignore",
+        shouldBail: () => isIgnoredLine(path)
+      },
+      ...overridableChecks
+    ]);
+    if (skipReason) {
+      logger.skipped({ component: "View", path, reason: skipReason });
+      return;
+    }
   }
   const hub = path.hub;
   const file = typeof hub === "object" && hub !== null && "file" in hub ? hub.file : void 0;